Module databases

redis_cloud::flexible

Module databases 

Source
Expand description

Database management operations for Pro subscriptions

This module provides comprehensive database management functionality for Redis Cloud Pro subscriptions, including creation, configuration, backup, import/export, and monitoring capabilities.

§Overview

Pro databases offer the full range of Redis Cloud features including high availability, auto-scaling, clustering, modules, and advanced data persistence options. They can be deployed across multiple cloud providers and regions.

§Key Features

  • Database Lifecycle: Create, update, delete, and manage databases
  • Backup & Restore: Automated and on-demand backup operations
  • Import/Export: Import data from RDB files or other Redis instances
  • Modules: Support for RedisJSON, RediSearch, RedisGraph, RedisTimeSeries, RedisBloom
  • High Availability: Replication, auto-failover, and clustering support
  • Monitoring: Metrics, alerts, and performance insights
  • Security: TLS, password protection, and ACL support

§Database Configuration Options

  • Memory limits from 250MB to 500GB+
  • Support for Redis OSS Cluster API
  • Data persistence: AOF, snapshot, or both
  • Data eviction policies
  • Replication and clustering
  • Custom Redis versions

§Example Usage

use redis_cloud::{CloudClient, DatabaseHandler};

let client = CloudClient::builder()
    .api_key("your-api-key")
    .api_secret("your-api-secret")
    .build()?;

let handler = DatabaseHandler::new(client);

// List all databases in a subscription (subscription ID 123)
let databases = handler.get_subscription_databases(123, None, None).await?;

// Get specific database details
let database = handler.get_subscription_database_by_id(123, 456).await?;

Structs§

AccountSubscriptionDatabases
RedisLabs Account Subscription Databases information
BdbVersionUpgradeStatus
BdbVersionUpgradeStatus
CloudTag
Database tag
CloudTags
Redis list of database tags
CrdbFlushRequest
Active-Active database flush request message
CrdbUpdatePropertiesRequest
Active-Active database update local properties request message
Database
Database
DatabaseAlertSpec
Optional. Changes Redis database alert details.
DatabaseBackupConfig
Optional. Changes Remote backup configuration details.
DatabaseBackupRequest
Database backup request message
DatabaseCertificate
Database certificate
DatabaseCertificateSpec
Optional. A list of client TLS/SSL certificates. If specified, mTLS authentication will be required to authenticate user connections. If set to an empty list, TLS client certificates will be removed and mTLS will not be required. TLS connection may still apply, depending on the value of ‘enableTls’.
DatabaseCreateRequest
Request structure for creating a new Pro database
DatabaseHandler
Handler for Pro database operations
DatabaseImportRequest
Database import request
DatabaseModuleSpec
Optional. Redis advanced capabilities (also known as modules) to be provisioned in the database. Use GET /database-modules to get a list of available advanced capabilities.
DatabaseSlowLogEntries
DatabaseSlowLogEntries
DatabaseSlowLogEntry
Database slowlog entry
DatabaseSyncSourceSpec
Optional. This database will be a replica of the specified Redis databases, provided as a list of objects with endpoint and certificate details.
DatabaseTagCreateRequest
Database tag
DatabaseTagUpdateRequest
Database tag update request message
DatabaseTagsUpdateRequest
Database tags update request message
DatabaseThroughputSpec
Optional. Throughput measurement method.
DatabaseUpdateRequest
Database update request
DatabaseUpgradeRedisVersionRequest
Upgrades the specified Pro database to a later Redis version.
LocalRegionProperties
Optional. A list of regions and local settings to update.
LocalThroughput
Optional. Expected read and write throughput for this region.
ProcessorResponse
ProcessorResponse
ReplicaOfSpec
Optional. Changes Replica Of (also known as Active-Passive) configuration details.
Tag
Database tag
TaskStateUpdate
TaskStateUpdate