ContextQMD
Back to Redis

Create a Redis Software database

content/operate/rs/databases/create.md

latest4.2 KB
Original Source

Redis Software lets you create databases and distribute them across a cluster of nodes using the Cluster Manager UI or the REST API.

Cluster Manager UI method

To create a new database using the Cluster Manager UI:

  1. Sign in to the Cluster Manager UI at https://<hostname>:8443

  2. Use one of the following methods to create a new database:

  3. If you did not specify a port number for the database, you can find the port number in the Endpoint field in the Databases > Configuration > General section.

  4. [Test client connectivity]({{< relref "/operate/rs/databases/connect/test-client-connectivity" >}}).

{{< note >}} For databases with Active-Active replication for geo-distributed locations, see [Create an Active-Active database]({{< relref "/operate/rs/databases/active-active/create.md" >}}). To create and manage Active-Active databases, use the legacy UI. {{< /note >}}

Quick database

To quickly create a database and skip additional configuration options during initial creation:

  1. On the Databases screen, select Quick database.

  2. Select a Redis version from the Database version list.

  3. Configure settings that are required for database creation but can be changed later:

    • Database name

    • Memory limit (GB)

  4. Configure optional settings that can't be changed after database creation:

    • Endpoint port (set by the cluster if not set manually)

    • Capabilities (previously modules) to enable

      Databases created with Redis version 8 or later automatically enable the capabilities (modules) bundled with Redis Software as follows:

      {{<embed-md "rs-8-enabled-modules.md">}}

  5. Optionally select Full options to configure [additional settings]({{< relref "/operate/rs/databases/configure#config-settings" >}}).

  6. Select Create.

Create database with additional configuration {#create-db-ui}

To create a new database and configure additional settings:

  1. Open the Create database menu with one of the following methods:

    • Click the + button next to Databases in the navigation menu:

      {{<image filename="images/rs/screenshots/databases/create-db-plus-drop-down.png" width="350px" alt="Create database menu has two options: Single Region and Active-Active database.">}}

    • Go to the Databases screen and select Create database:

      {{<image filename="images/rs/screenshots/databases/create-db-button-drop-down.png" width="350px" alt="Create database menu has two options: Single Region and Active-Active database.">}}

  2. Select the database type:

    • Single Region

    • Active-Active database - Multiple participating Redis Software clusters can host instances of the same [Active-Active database]({{< relref "/operate/rs/databases/active-active" >}}) in different geographic locations. Every instance can receive write operations, which are synchronized across all instances without conflict.

    {{<note>}} For Active-Active databases, see [Create an Active-Active geo-replicated database]({{< relref "/operate/rs/databases/active-active/create" >}}). {{</note>}}

  3. Select a Redis version from the Database version list.

  4. Enter a Database name.

    • Maximum of 63 characters

    • Only letters, numbers, or hyphens (-) are valid characters

    • Must start and end with a letter or digit

    • Case-sensitive

  5. To configure additional database settings, expand each relevant section to make changes.

    See [Configuration settings]({{< relref "/operate/rs/databases/configure#config-settings" >}}) for more information about each setting.

  6. Select Create.

REST API method

To [create a database]({{<relref "/operate/rs/references/rest-api/requests/bdbs#post-bdbs-v1">}}) using a REST API request:

sh
POST https://<host>:<port>/v1/bdbs
{
    "name": "test-database",
    "type": "redis",
    "memory_size": 1073741824,
    // Additional fields
}

For additional database configuration fields, see the [BDB object]({{<relref "/operate/rs/references/rest-api/objects/bdb">}}) reference.

Continue learning with Redis University

{{< university-links >}}