View and edit databases
Use the Databases menu of the admin console to manage your subscription databases.
To view the details of a database:
Sign in to the Redis Cloud admin console. (Create an account if you don’t already have one.)
Locate the database in the list.
Select the database name to open the Database page.
The Database screen lets you review:
- Configuration details of a database
- Graphs showing performance metrics
- Recent activity via a “slowlog,” which lists queries that exceed a certain execution time.
For help changing database settings, see Edit database details.
Configuration details tab
The Configuration details screen is divided into sections, each dedicated to a specific category. Note that not every section or setting is available to every subscription plan.
The General section defines basic properties about your database.
The available settings vary according to your subscription plan, cloud provider, and design choices. For example, if you do not select a module when crating a database, the Module setting is not displayed when you view its configuration details.
|Database Name||The name given to your database|
|Public endpoint||Public URI used by any application or client to access the database.|
|Private endpoint||Private endpoint URI available to approved clients; use CIDR allow list and VPC peering to enabled access (Flexible or Annual subscriptions only)|
|Protocol||Either ‘redis’ or ‘memcached’ based on the value selected when the database was created|
|Redis version||Redis version used to create the database|
|Redis on Flash||Checked when the subscription supports Redis on Flash (Flexible or Annual subscriptions only)|
|Activated on||Date and time the database was created|
|Active-Active Redis||Checked when the database is part of an Active-Active relationship (coming soon; Flexible or Annual subscriptions only)|
|Last changed||Date and time of last update|
|Protocol||Describes the protocol of the database, typically Redis|
|Module||This setting appears when when a module is enabled for a database|
The Scalability section describes the memory size, throughput, and hashing policy for a database.
The Scalability section is available only for Flexible and Annual plans.
|Memory limit||Maximum size (in GB) for your database|
|Memory used||Memory currently used for your database|
|Throughput||Defines throughput in terms of maximum operations per second for the database|
|Shards||Defines the throughput in terms of shards dedicated to the database|
|Hashing policy||Defines the hashing policy|
|Cluster OSS||Enables the OSS Cluster API for a database
When this option is enabled, you cannot define a custom hashing policy
To learn more about these settings and when to use them, see Database clustering.
The Durability section helps protect your data when problems occur. These settings define replication, persistence, backup, and eviction policies.
|High availability||Replicates your data across multiple nodes, as allowed by your subscription plan|
|Data persistence||Defines whether (and how) data is saved to disk; available options depend on your plan type|
|Data eviction policy||Defines what happens when your database reaches its memory size limit|
|Remote backup||(paid Fixed, Flexible, or Annual subscriptions only) When enabled, identifies a location and interval for data backups.|
|Active-passive Redis||(Flexible or Annual subscriptions only) When enabled, identifies a path to the linked database.|
The Security section helps you control access to your database.
|Default user||When enabled, permits access using a simple password|
|Redis password||Password assigned to the database when created|
|CIDR allow list||(paid Fixed, Flexible, or Annual subscriptions only) Range of IP addresses/security groups allowed to access the database|
|Transport layer security (TLS)||(Flexible or Annual subscriptions only) Enables transport security layer(TLS) encryption for database access.|
The Alerts section defines notification emails sent to your account and the conditions that trigger them.
The available alerts vary according to the subscription type.
|Dataset size has reached||When enabled, sends an an email when the database reaches the defined memory size (Free, Flexible, or Annuals plans only)|
|Total size of datasets under this plan reached||When enabled, sends an an email when the database reaches the defined memory size (paid Fixed plans only)|
|Throughput is higher than||When enabled, sends an email when the operations per second exceed the defined threshold (paid Fixed, Flexible, or Annuals plans only)|
|Throughput is lower than||When enabled, sends an email when the operations per second falls below the defined threshold (paid Fixed, Flexible, or Annuals plans only)|
|Latency is higher than||When enabled, sends an an email when the latency exceeds the defined memory size (paid Fixed plans only)|
|Number of connections||When enabled, sends an email when the connections exceeds the defined limit. (Free and Fixed plans only)|
|Replica Of - database unable to sync with source||When enabled, sends email when the replica database cannot sync with the primary (source) database (Flexible or Annuals plans only)|
|Replica Of - sync lag is higher than||When enabled, sends email when the sync lag exceeds the defined threshold (Flexible or Annuals plans only)|
Actions in the Danger Zone are permanent and should not be taken lightly.
Here, you can:
Delete the database.
When you choose this action, you’re asked to confirm.
Databases must be active and empty before they can be deleted. To learn more, see Delete a database.
Import data into the database.
When you choose this action, you’re asked to specify the source and location of the data to import
To learn more, see Import data.
For best results, we recommend backing up data before starting any Danger Zone actions.
Manage the database list
The Databases list summarizes the status of all databases from the subscriptions associated with your account.
Sort the list in descending or ascending order using the the arrow displayed to right of the field name in the header. Supported fields include Subscription, Name, and Memory.
Select the arrow icon to change the sort order. One sort order can be active at any given time.
Use the Filter icon displayed to the right of the field name in the header to display string matches for that field.
You can filter the list on Subscription, Name, Endpoint, and Options. String matches are not case sensitive. You can specify more than one filter expression at a time.
The icon is circled when a filter is active.
Use the controls in the list footer to change the number of items displayed in the list or to navigate.
Sort orders and filter expressions are not saved between console sessions.
Other actions and info
The View Database screen also has tabs that let you view:
Metrics: a series of graphs showing database performance over time. See Monitor performance
Slowlog: a log showing recent slow queries run against your database. The log displays when the action started, the duration, the complexity of the operation, and any parameters passed to the operation.
Edit database details
Use the Edit database button to edit database details.
Because databases exist within the context of a deployment, certain fields cannot be updated, especially those that might lead to data loss.
Here’s what you can change:
|Scalability||Memory limit||Flexible and Annual subscriptions only)|
|Throughput||Flexible and Annual subscriptions only)|
|Hashing policy||Flexible and Annual subscriptions only)|
|Cluster OSS||Flexible and Annual subscriptions only)|
|Durability||High-availability||paid Fixed, Flexible, and Annual subscriptions only)|
|Data persistence||paid Fixed, Flexible, and Annual subscriptions only)|
|Data eviction policy|
|Remote backup||paid Fixed, Flexible, Annual subscriptions only)|
|Active-passive Redis||Flexible and Annual subscriptions only)|
|Default user password|
|CIDR allow list||paid Fixed, Flexible, and Annual subscriptions only)|
|Transport layer security (TLS)||Flexible and Annual subscriptions only)|
|Alerts||all available for subscription|
Choose Save database to save your changes.
If you need to change other details, create a new database and then migrate existing data.