CRDB database config object

An object that represents the database configuration

Redis Enterprise Software

An object that represents the database configuration.

Name Type/Value Description
aof_policy 'appendfsync-every-sec'
'appendfsync-always'		 Policy for Append-Only File data persistence
authentication_admin_pass string Administrative databases access token
authentication_redis_pass string Redis AUTH password (deprecated as of Redis Enterprise v7.2, replaced with multiple passwords feature in version 6.0.X)
bigstore boolean (default: false) Database driver is Auto Tiering
bigstore_ram_size integer (default: 0) Memory size of RAM size
data_persistence 'disabled'
'snapshot'
'aof'		 Database on-disk persistence policy. For snapshot persistence, a snapshot_policy must be provided
enforce_client_authentication 'enabled'
'disabled'		 Require authentication of client certificates for SSL connections to the database. If enabled, a certificate should be provided in either authentication_ssl_client_certs or authentication_ssl_crdt_certs
max_aof_file_size integer Maximum AOF file size in bytes
max_aof_load_time integer (default: 3600) Maximum AOF reload time in seconds
memory_size integer (default: 0) Database memory size limit in bytes. 0 is unlimited.
module_list array of module objects List of modules to be loaded to all participating clusters of the Active-Active database
[{
  "module_id": string,
  "module_args": string,
  "module_name": string,
  "semantic_version": string,
}, ...]

module_id: Module UID (deprecated; use module_name instead)
module_args: Module command-line arguments (pattern does not allow special characters &,<,>,")
module_name: Module's name
semantic_version: Module's semantic version (deprecated; use module_args instead)

module_id and semantic_version are optional as of Redis Enterprise Software v7.4.2 and deprecated as of v7.8.2.
oss_cluster boolean (default: false) Enables OSS Cluster mode
oss_cluster_api_preferred_ip_type 'internal'
'external'		 Indicates preferred IP type in OSS cluster API
oss_sharding boolean (default: false) An alternative to shard_key_regex for using the common case of the OSS shard hashing policy
port integer TCP port for database access
proxy_policy 'single'
'all-master-shards'
'all-nodes'		 The policy used for proxy binding to the endpoint
rack_aware boolean (default: false) Require the database to be always replicated across multiple racks
replication boolean (default: true) Database replication
sharding boolean (default: false) Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either oss_sharding or shard_key_regex
shard_key_regex [{ "regex": string }, ...] Custom keyname-based sharding rules (required if sharding is enabled)

To use the default rules you should set the value to:
[{"regex": ".*\\{(?<tag>.*)\\}.*"}, {"regex": "(?<tag>.*)"}]
shards_count integer (range: 1-512) (default: 1) Number of database shards
shards_placement 'dense'
'sparse'		 Control the density of shards
Values:
'dense': Shards reside on as few nodes as possible
'sparse': Shards reside on as many nodes as possible
snapshot_policy array of snapshot_policy objects Policy for snapshot-based data persistence. A dataset snapshot will be taken every N secs if there are at least M writes changes in the dataset.
tls_mode 'enabled'
'disabled'
'replica_ssl'		 Encrypt communication
RATE THIS PAGE
Back to top ↑