{
  "id": "bdb",
  "title": "BDB object",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/objects/bdb/",
  "summary": "An object that represents a database",
  "content": "\nAn API object that represents a managed database in the cluster.\n\n| Name | Type/Value \u0026 Description |\n|------|-------------------------|\n| uid | integer; Cluster unique ID of database. Can be set during creation but cannot be updated. |\n| account_id | integer; SM account ID |\n| action_uid | string; Currently running action's UID (read-only) |\n| aof_policy | Policy for Append-Only File data persistence\u003cbr /\u003eValues:\u003cbr /\u003e**'appendfsync-every-sec'** \u003cbr /\u003e'appendfsync-always' |\n| authentication_admin_pass | string; Password for administrative access to the BDB (used for SYNC from the BDB) |\n| authentication_redis_pass | string; Redis AUTH password authentication.  \u003cbr/\u003eUse for Redis databases only.  Ignored for memcached databases. (deprecated as of Redis Enterprise v7.2, replaced with multiple passwords feature in version 6.0.X) |\n| authentication_sasl_pass | string; Binary memcache SASL password |\n| authentication_sasl_uname | string; Binary memcache SASL username (pattern does not allow special characters \u0026,\\\u003c,\u003e,\") |\n| authentication_ssl_client_certs | [{\u003cbr /\u003e  \"client_cert\": string\u003cbr /\u003e}, ...] List of authorized client certificates\u003cbr /\u003e**client_cert**: X.509 PEM (base64) encoded certificate |\n| authentication_ssl_crdt_certs | [{\u003cbr /\u003e  \"client_cert\": string\u003cbr /\u003e}, ...] List of authorized CRDT certificates\u003cbr /\u003e**client_cert**: X.509 PEM (base64) encoded certificate |\n| authorized_names | array of strings; Additional certified names (deprecated as of Redis Enterprise v6.4.2; use authorized_subjects instead) |\n| authorized_subjects | [{\u003cbr /\u003e  \"CN\": string,\u003cbr /\u003e  \"O\": string,\u003cbr /\u003e  \"OU\": [array of strings],\u003cbr /\u003e  \"L\": string,\u003cbr /\u003e  \"ST\": string,\u003cbr /\u003e  \"C\": string\u003cbr /\u003e}, ...] A list of valid subjects used for additional certificate validations during TLS client authentication. All subject attributes are case-sensitive.\u003cbr /\u003e**Required subject fields**:\u003cbr /\u003e\"CN\" for Common Name\u003cbr /\u003e**Optional subject fields:**\u003cbr /\u003e\"O\" for Organization\u003cbr /\u003e\"OU\" for Organizational Unit (array of strings)\u003cbr /\u003e\"L\" for Locality (city)\u003cbr /\u003e\"ST\" for State/Province\u003cbr /\u003e\"C\" for 2-letter country code |\n| auto_upgrade | boolean (default:\u0026nbsp;false); Upgrade the database automatically after a cluster upgrade |\n| avoid_nodes | array of strings; Cluster node UIDs to avoid when placing the database's shards and binding its endpoints |\n| background_op | Deprecated as of Redis Enterprise Software v7.8.2. Use [`GET /v1/actions/bdb/\u003cbdb_uid\u003e`]() instead.\u003cbr /\u003e[{\u003cbr /\u003e  \"status\": string,\u003cbr /\u003e  \"name\": string,\u003cbr /\u003e  \"error\": object,\u003cbr /\u003e  \"progress\": number\u003cbr /\u003e}, ...] (read-only); **progress**: Percent of completed steps in current operation |\n| backup | boolean (default:\u0026nbsp;false); Policy for periodic database backup |\n| backup_failure_reason | Reason of last failed backup process (read-only)\u003cbr /\u003eValues:\u003cbr /\u003e'no-permission'\u003cbr /\u003e'wrong-file-path'\u003cbr /\u003e'general-error' |\n| backup_history | integer (default:\u0026nbsp;0); Backup history retention policy (number of days, 0 is forever) |\n| backup_interval | integer; Interval in seconds in which automatic backup will be initiated |\n| backup_interval_offset | integer; Offset (in seconds) from round backup interval when automatic backup will be initiated (should be less than backup_interval) |\n| backup_location | [complex object]();  Target for automatic database backups. \u003cbr /\u003eCall `GET`\u0026nbsp;`/jsonschema` to retrieve the object's structure. |\n| backup_progress | number, \u003cnobr\u003e(range: 0-100)\u003c/nobr\u003e;  Database scheduled periodic backup progress (percentage) (read-only) |\n| backup_status | Status of scheduled periodic backup process (read-only)\u003cbr /\u003eValues:\u003cbr /\u003e'exporting'\u003cbr /\u003e'succeeded'\u003cbr /\u003e'failed' |\n| bigstore | boolean (default:\u0026nbsp;false);  Database bigstore option |\n| bigstore_ram_size | integer (default:\u0026nbsp;0);  Memory size of bigstore RAM part. |\n| bigstore_ram_weights | [{\u003cbr /\u003e  \"shard_uid\": integer,\u003cbr /\u003e  \"weight\": number\u003cbr /\u003e}, ...] List of shard UIDs and their bigstore RAM weights;\u003cbr /\u003e **shard_uid**: Shard UID;\u003cbr /\u003e **weight**: Relative weight of RAM distribution |\n| client_cert_subject_validation_type | Enables additional certificate validations that further limit connections to clients with valid certificates during TLS client authentication.\u003cbr /\u003eValues:\u003cbr /\u003e**disabled**: Authenticates clients with valid certificates. No additional validations are enforced.\u003cbr /\u003e**san_cn**: A client certificate is valid only if its Common Name (CN) matches an entry in the list of valid subjects. Ignores other Subject attributes.\u003cbr /\u003e**full_subject**: A client certificate is valid only if its Subject attributes match an entry in the list of valid subjects. |\n| conns | integer (default\u0026nbsp;5);  Number of internal proxy connections |\n| conns_type | Connections limit type\u003cbr /\u003eValues:\u003cbr /\u003e**‘per-thread’**\u003cbr /\u003e‘per-shard’ |\n| crdt | boolean (default:\u0026nbsp;false);  Use CRDT-based data types for multi-master replication |\n| crdt_causal_consistency | boolean (default:\u0026nbsp;false);  Causal consistent CRDB. |\n| crdt_config_version | integer;  Replica-set configuration version, for internal use only. |\n| crdt_featureset_version | integer;  CRDB active FeatureSet version |\n| crdt_ghost_replica_ids | string;  Removed replicas IDs, for internal use only. |\n| crdt_guid | string;  GUID of CRDB this database belongs to, for internal use only. |\n| crdt_modules | string;  CRDB modules information. The string representation of a JSON list, containing hashmaps. |\n| crdt_protocol_version | integer;  CRDB active Protocol version |\n| crdt_repl_backlog_size | string;  Active-Active replication backlog size ('auto' or size in bytes) |\n| crdt_replica_id | integer;  Local replica ID, for internal use only. |\n| crdt_replicas | string;  Replica set configuration, for internal use only. |\n| crdt_sources | array of [syncer_sources]() objects; Remote endpoints/peers of CRDB database to sync from. See the 'bdb -\\\u003e replica_sources' section |\n| crdt_sync | Enable, disable, or pause syncing from specified crdt_sources. Applicable only for Active-Active databases. See [replica_sync]() for more details.\u003cbr /\u003eValues:\u003cbr /\u003e'enabled'\u003cbr /\u003e **'disabled'** \u003cbr /\u003e'paused'\u003cbr /\u003e'stopped' |\n| \u003cspan class=\"break-all\"\u003ecrdt_sync_connection_alarm_timeout_seconds\u003c/span\u003e | integer (default: 0); If the syncer takes longer than the specified number of seconds to connect to an Active-Active database, raise a connection alarm |\n| crdt_sync_dist | boolean;  Enable/disable distributed syncer in master-master |\n| crdt_syncer_auto_oom_unlatch | boolean (default:\u0026nbsp;true);  Syncer automatically attempts to recover synchronisation from peers after this database throws an Out-Of-Memory error. Otherwise, the syncer exits |\n| crdt_xadd_id_uniqueness_mode | XADD strict ID uniqueness mode. CRDT only.\u003cbr /\u003eValues:\u003cbr /\u003e‘liberal’\u003cbr /\u003e**‘strict’**\u003cbr /\u003e‘semi-strict’ |\n| created_time | string;  The date and time the database was created (read-only) |\n| data_internode_encryption | boolean;  Should the data plane internode communication for this database be encrypted |\n| data_persistence | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy]() must be provided\u003cbr /\u003eValues:\u003cbr /\u003e**'disabled'** \u003cbr /\u003e'snapshot'\u003cbr /\u003e'aof' |\n| dataset_import_sources | [complex object]();  Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set. \u003cbr /\u003eCall `GET /v1/jsonschema` to retrieve the object's structure. |\n| db_conns_auditing | boolean;  Enables/deactivates [database connection auditing]() |\n| default_user | boolean (default:\u0026nbsp;true); Allow/disallow a default user to connect |\n| disabled_commands | string (default: ); Redis commands which are disabled in db |\n| dns_address_master | string;  Database private address endpoint FQDN (read-only) (deprecated as of Redis Enterprise v4.3.3) |\n| email_alerts | boolean (default:\u0026nbsp;false);  Send email alerts for this DB |\n| endpoint | string;  Latest bound endpoint. Used when reconfiguring an endpoint via update |\n| endpoint_ip | complex object;  External IP addresses of node hosting the BDB's endpoint. `GET`\u0026nbsp;`/jsonschema` to retrieve the object's structure. (read-only) (deprecated as of Redis Enterprise v4.3.3) |\n| endpoint_node | integer;  Node UID hosting the BDB's endpoint (read-only) (deprecated as of Redis Enterprise v4.3.3) |\n| endpoints | array; List of database access endpoints (read-only)\u003cbr /\u003e**uid**: Unique identification of this source\u003cbr /\u003e**dns_name**: Endpoint’s DNS name\u003cbr /\u003e**port**: Endpoint’s TCP port number\u003cbr /\u003e**addr**: Endpoint’s accessible addresses\u003cbr /\u003e**proxy_policy**: The policy used for proxy binding to the endpoint\u003cbr /\u003e**exclude_proxies**: List of proxies to exclude\u003cbr /\u003e**include_proxies**: List of proxies to include\u003cbr /\u003e**addr_type**: Indicates if the endpoint is based on internal or external IPs\u003cbr /\u003e\u003cspan class=\"break-all\"\u003e**oss_cluster_api_preferred_ip_type**\u003c/span\u003e: Indicates preferred IP type in the OSS cluster API: internal/external\u003cbr /\u003e\u003cspan class=\"break-all\"\u003e**oss_cluster_api_preferred_endpoint_type**\u003c/span\u003e: Indicates preferred endpoint type in the OSS cluster API: ip/hostname |\n| enforce_client_authentication | Require authentication of client certificates for SSL connections to the database. If set to 'enabled', a certificate should be provided in either authentication_ssl_client_certs or authentication_ssl_crdt_certs\u003cbr /\u003eValues:\u003cbr /\u003e**'enabled'** \u003cbr /\u003e'disabled' |\n| eviction_policy | Database eviction policy (Redis style).\u003cbr /\u003eValues:\u003cbr /\u003e'volatile-lru'\u003cbr /\u003e'volatile-ttl'\u003cbr /\u003e'volatile-random'\u003cbr /\u003e'allkeys-lru'\u003cbr /\u003e'allkeys-random'\u003cbr /\u003e'noeviction'\u003cbr /\u003e'volatile-lfu'\u003cbr /\u003e'allkeys-lfu'\u003cbr /\u003e**Redis DB default**: 'volatile-lru'\u003cbr /\u003e**memcached DB default**: 'allkeys-lru' |\n| export_failure_reason | Reason of last failed export process (read-only)\u003cbr /\u003eValues:\u003cbr /\u003e'no-permission'\u003cbr /\u003e'wrong-file-path'\u003cbr /\u003e 'general-error' |\n| export_progress | number, \u003cnobr\u003e(range: 0-100)\u003c/nobr\u003e; Database manually triggered export progress (percentage) (read-only) |\n| export_status | Status of manually triggered export process (read-only)\u003cbr /\u003eValues:\u003cbr /\u003e'exporting'\u003cbr /\u003e'succeeded'\u003cbr /\u003e'failed' |\n| generate_text_monitor | boolean;  Enable/disable generation of syncer monitoring information |\n| gradual_src_max_sources | integer (default:\u0026nbsp;1); Sync a maximum N sources in parallel (gradual_src_mode should be enabled for this to take effect) |\n| gradual_src_mode | Indicates if gradual sync (of sync sources) should be activated\u003cbr /\u003eValues:\u003cbr /\u003e'enabled'\u003cbr /\u003e'disabled' |\n| gradual_sync_max_shards_per_source | integer (default:\u0026nbsp;1); Sync a maximum of N shards per source in parallel (gradual_sync_mode should be enabled for this to take effect) |\n| gradual_sync_mode | Indicates if gradual sync (of source shards) should be activated ('auto' for automatic decision)\u003cbr /\u003eValues:\u003cbr /\u003e'enabled'\u003cbr /\u003e'disabled'\u003cbr /\u003e'auto' |\n| hash_slots_policy | The policy used for hash slots handling\u003cbr /\u003eValues:\u003cbr/\u003e **'legacy'**: slots range is '1-4096'\u003cbr /\u003e **'16k'**: slots range is '0-16383' |\n| implicit_shard_key | boolean (default:\u0026nbsp;false); Controls the behavior of what happens in case a key does not match any of the regex rules. \u003cbr /\u003e **true**: if a key does not match any of the rules, the entire key will be used for the hashing function \u003cbr /\u003e **false**: if a key does not match any of the rules, an error will be returned. |\n| import_failure_reason | Import failure reason (read-only)\u003cbr /\u003eValues:\u003cbr /\u003e'download-error'\u003cbr /\u003e'file-corrupted'\u003cbr /\u003e'general-error'\u003cbr /\u003e'file-larger-than-mem-limit:\\\u003cn bytes of expected dataset\u003e:\\\u003cn bytes configured bdb limit\u003e'\u003cbr /\u003e'key-too-long'\u003cbr /\u003e'invalid-bulk-length'\u003cbr /\u003e'out-of-memory' |\n| import_progress | number, \u003cnobr\u003e(range: 0-100)\u003c/nobr\u003e; Database import progress (percentage) (read-only) |\n| import_status | Database import process status (read-only)\u003cbr /\u003eValues:\u003cbr /\u003e'idle'\u003cbr /\u003e'initializing'\u003cbr /\u003e'importing'\u003cbr /\u003e'succeeded'\u003cbr /\u003e'failed' |\n| internal | boolean (default:\u0026nbsp;false); Is this a database used by the cluster internally |\n| last_backup_time | string; Time of last successful backup (read-only) |\n| last_changed_time | string; Last administrative configuration change (read-only) |\n| last_export_time | string; Time of last successful export (read-only) |\n| max_aof_file_size | integer; Maximum size for shard's AOF file (bytes). Default 300GB, (on bigstore DB 150GB) |\n| max_aof_load_time | integer (default:\u0026nbsp;3600); Maximum time shard's AOF reload should take (seconds). |\n| max_client_pipeline | integer (default:\u0026nbsp;200); Maximum number of pipelined commands per connection. Maximum value is 2047. |\n| max_connections | integer (default:\u0026nbsp;0); Maximum number of client connections allowed (0 unlimited) |\n| max_pipelined | integer (default:\u0026nbsp;2000); Determines the maximum number of commands in the proxy’s pipeline per shard connection. |\n| master_persistence | boolean (default:\u0026nbsp;false); If true, persists the primary shard in addition to replica shards in a replicated and persistent database. |\n| memory_size | integer (default:\u0026nbsp;0); Database memory limit (0 is unlimited), expressed in bytes. |\n| metrics_export_all | boolean; Enable/disable exposing all shard metrics through the metrics exporter |\n| mkms | boolean (default:\u0026nbsp;true); Are MKMS (Multi Key Multi Slots) commands supported? |\n| module_list | [{\u003cbr /\u003e  \"module_id\": string,\u003cbr /\u003e  \"module_args\": [\u003cbr /\u003e    u'string',\u003cbr /\u003e    u'null'],\u003cbr /\u003e  \"module_name\": string,\u003cbr /\u003e  \"semantic_version\": string\u003cbr /\u003e}, ...] List of modules associated with the database\u003cbr /\u003e\u003cbr /\u003e**module_id**: Module UID (deprecated; use `module_name` instead)\u003cbr /\u003e**module_args**: Module command-line arguments (pattern does not allow special characters \u0026,\\\u003c,\u003e,\")\u003cbr /\u003e**module_name**: Module's name\u003cbr /\u003e**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)\u003cbr /\u003e\u003cbr /\u003e**module_id** and **semantic_version** are optional as of Redis Enterprise Software v7.4.2 and deprecated as of v7.8.2. |\n| mtls_allow_outdated_certs | boolean; An optional mTLS relaxation flag for certs verification |\n| mtls_allow_weak_hashing | boolean; An optional mTLS relaxation flag for certs verification |\n| name | string; Database name. Only letters, numbers, or hyphens are valid characters. The name must start and end with a letter or number. |\n| oss_cluster | boolean (default:\u0026nbsp;false); OSS Cluster mode option. Cannot be enabled with `'hash_slots_policy': 'legacy'` |\n| \u003cspan class=\"break-all\"\u003eoss_cluster_api_preferred_endpoint_type\u003c/span\u003e | Endpoint type in the OSS cluster API\u003cbr /\u003eValues:\u003cbr /\u003e**‘ip’**\u003cbr /\u003e‘hostname’ |\n| \u003cspan class=\"break-all\"\u003eoss_cluster_api_preferred_ip_type\u003c/span\u003e | Internal/external IP type in OSS cluster API. Default value for new endpoints\u003cbr /\u003eValues:\u003cbr /\u003e**'internal'** \u003cbr /\u003e'external' |\n| oss_sharding | boolean (default:\u0026nbsp;false); An alternative to `shard_key_regex` for using the common case of the OSS shard hashing policy |\n| port | integer; TCP port on which the database is available. Generated automatically if omitted and returned as 0 |\n| proxy_policy | The default policy used for proxy binding to endpoints\u003cbr /\u003eValues:\u003cbr /\u003e'single'\u003cbr /\u003e'all-master-shards'\u003cbr /\u003e'all-nodes' |\n| rack_aware | boolean (default:\u0026nbsp;false); Require the database to always replicate across multiple racks |\n| recovery_wait_time | integer (default:\u0026nbsp;-1); Defines how many seconds to wait for the persistence file to become available during auto recovery. After the wait time expires, auto recovery completes with potential data loss. The default `-1` means to wait forever. |\n| redis_version | string; Version of the redis-server processes: e.g. 6.0, 5.0-big |\n| repl_backlog_size | string; Redis replication backlog size ('auto' or size in bytes) |\n| replica_sources | array of [syncer_sources]() objects; Remote endpoints of database to sync from. See the 'bdb -\\\u003e replica_sources' section |\n| [replica_sync]() | Enable, disable, or pause syncing from specified replica_sources\u003cbr /\u003eValues:\u003cbr /\u003e'enabled'\u003cbr /\u003e **'disabled'** \u003cbr /\u003e'paused'\u003cbr /\u003e'stopped' |\n| \u003cspan class=\"break-all\"\u003ereplica_sync_connection_alarm_timeout_seconds\u003c/span\u003e | integer (default: 0); If the syncer takes longer than the specified number of seconds to connect to a replica, raise a connection alarm |\n| replica_sync_dist | boolean; Enable/disable distributed syncer in replica-of |\n| replication | boolean (default:\u0026nbsp;false); In-memory database replication mode |\n| resp3 | boolean (default:\u0026nbsp;true); Enables or deactivates RESP3 support |\n| roles_permissions | [{\u003cbr /\u003e  \"role_uid\": integer,\u003cbr /\u003e  \"redis_acl_uid\": integer\u003cbr /\u003e}, ...] |\n| sched_policy | Controls how server-side connections are used when forwarding traffic to shards.\u003cbr /\u003eValues:\u003cbr /\u003e**cmp**: Closest to max_pipelined policy. Pick the connection with the most pipelined commands that has not reached the max_pipelined limit.\u003cbr /\u003e**mru**: Try to use most recently used connections.\u003cbr /\u003e**spread**: Try to use all connections.\u003cbr /\u003e**mnp**: Minimal pipeline policy. Pick the connection with the least pipelined commands. |\n| shard_block_crossslot_keys | boolean (default:\u0026nbsp;false); In Lua scripts, prevent use of keys from different hash slots within the range owned by the current shard |\n| shard_block_foreign_keys | boolean (default:\u0026nbsp;true); In Lua scripts, `foreign_keys` prevent use of keys which could reside in a different shard (foreign keys) |\n| shard_key_regex | Custom keyname-based sharding rules.\u003cbr /\u003e`[{\"regex\": string}, ...]`\u003cbr /\u003eTo use the default rules you should set the value to: \u003cbr /\u003e`[{\"regex\": \".*\\\\{(?\u003ctag\u003e.*)\\\\}.*\"}, {\"regex\": \"(?\u003ctag\u003e.*)\"}]` |\n| shard_list | array of integers; Cluster unique IDs of all database shards. |\n| sharding | boolean (default:\u0026nbsp;false); Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either `oss_sharding` or `shard_key_regex` |\n| shards_count | integer, \u003cnobr\u003e(range: 1-512)\u003c/nobr\u003e (default:\u0026nbsp;1); Number of database server-side shards |\n| shards_placement | Control the density of shards \u003cbr /\u003eValues:\u003cbr /\u003e**'dense'**: Shards reside on as few nodes as possible \u003cbr /\u003e **'sparse'**: Shards reside on as many nodes as possible |\n| skip_import_analyze | Enable/disable skipping the analysis stage when importing an RDB file\u003cbr /\u003eValues:\u003cbr /\u003e'enabled'\u003cbr /\u003e'disabled' |\n| slave_buffer | Redis replica output buffer limits\u003cbr /\u003eValues:\u003cbr /\u003e'auto'\u003cbr /\u003evalue in MB\u003cbr /\u003ehard:soft:time |\n| slave_ha | boolean; Enable replica high availability mechanism for this database (default takes the cluster setting) |\n| slave_ha_priority | integer; Priority of the BDB in replica high availability mechanism |\n| 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 |\n| ssl | boolean (default:\u0026nbsp;false); Require SSL authenticated and encrypted connections to the database (deprecated as of Redis Enterprise v5.0.1) |\n| [status]() | Database lifecycle status (read-only)\u003cbr /\u003eValues:\u003cbr /\u003e'pending'\u003cbr /\u003e'active'\u003cbr /\u003e'active-change-pending'\u003cbr /\u003e'delete-pending'\u003cbr /\u003e'import-pending'\u003cbr /\u003e'creation-failed'\u003cbr /\u003e'recovery' |\n| support_syncer_reconf | boolean; Determines whether the syncer handles its own configuration changes. If false, the DMC restarts the syncer upon a configuration change. |\n| sync | (deprecated as of Redis Enterprise v5.0.1, use [replica_sync]() or crdt_sync instead) Enable, disable, or pause syncing from specified sync_sources\u003cbr /\u003eValues:\u003cbr /\u003e'enabled'\u003cbr /\u003e **'disabled'** \u003cbr /\u003e'paused'\u003cbr /\u003e'stopped' |\n| sync_dedicated_threads | integer (range:\u0026nbsp;0-10) (default:\u0026nbsp;5); Number of dedicated Replica Of threads |\n| sync_sources | [{\u003cbr /\u003e  \"uid\": integer,\u003cbr /\u003e  \"uri\": string,\u003cbr /\u003e  \"compression\": integer,\u003cbr /\u003e  \"status\": string,\u003cbr /\u003e  \"rdb_transferred\": integer,\u003cbr /\u003e  \"rdb_size\": integer,\u003cbr /\u003e  \"last_update\": string,\u003cbr /\u003e  \"lag\": integer,\u003cbr /\u003e  \"last_error\": string\u003cbr /\u003e}, ...] (deprecated as of Redis Enterprise v5.0.1, instead use replica_sources or crdt_sources) Remote endpoints of database to sync from. See the 'bdb -\\\u003e replica_sources' section\u003cbr /\u003e**uid**: Numeric unique identification of this source\u003cbr /\u003e**uri**: Source Redis URI\u003cbr /\u003e**compression**: Compression level for the replication link\u003cbr /\u003e**status**: Sync status of this source\u003cbr /\u003e**rdb_transferred**: Number of bytes transferred from the source's RDB during the syncing phase\u003cbr /\u003e**rdb_size**: The source's RDB size to be transferred during the syncing phase\u003cbr /\u003e**last_update**: Time last update was received from the source\u003cbr /\u003e**lag**: Lag in millisec between source and destination (while synced)\u003cbr /\u003e**last_error**: Last error encountered when syncing from the source |\n| syncer_log_level | Minimum syncer log level to log. Only logs with this level or higher will be logged.\u003cbr /\u003eValues:\u003cbr /\u003e‘crit’\u003cbr /\u003e‘error’\u003cbr /\u003e‘warn’\u003cbr /\u003e**‘info’**\u003cbr /\u003e‘trace’\u003cbr /\u003e‘debug’ |\n| syncer_mode | The syncer for replication between database instances is either on a single node (centralized) or on each node that has a proxy according to the proxy policy (distributed). (read-only)\u003cbr /\u003eValues:\u003cbr /\u003e'distributed'\u003cbr /\u003e'centralized' |\n| tags | [{\u003cbr /\u003e  \"key\": string,\u003cbr /\u003e  \"value\": string\u003cbr /\u003e}, ...] Optional list of tag objects attached to the database. Each tag requires a key-value pair.\u003cbr /\u003e**key**: Represents the tag's meaning and must be unique among tags (pattern does not allow special characters \u0026,\\\u003c,\u003e,\")\u003cbr /\u003e**value**: The tag's value.|\n| tls_mode | Require TLS-authenticated and encrypted connections to the database\u003cbr /\u003eValues:\u003cbr /\u003e'enabled'\u003cbr /\u003e **'disabled'** \u003cbr /\u003e'replica_ssl' |\n| tracking_table_max_keys | integer; The client-side caching invalidation table size. 0 makes the cache unlimited. |\n| type | Type of database\u003cbr /\u003eValues:\u003cbr /\u003e**'redis'** \u003cbr /\u003e'memcached' |\n| use_nodes | array of strings; Cluster node UIDs to use for database shards and bound endpoints |\n| version | string; Database compatibility version: full Redis/memcached version number, such as 6.0.6. This value can only change during database creation and database upgrades.|\n| wait_command | boolean (default:\u0026nbsp;true); Supports Redis wait command (read-only) |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "children": [{"id":"backup_location","summary":"Documents the bdb backup_location/export_location object used with Redis Enterprise Software REST API calls.","title":"BDB backup/export location object","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/objects/bdb/backup_location/"},{"id":"dataset_import_sources","summary":"Documents the bdb dataset_import_sources object used with Redis Enterprise Software REST API calls.","title":"BDB dataset import sources object","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/objects/bdb/dataset_import_sources/"},{"id":"replica_sources_status","summary":"Documents the bdb replica_sources status field used with Redis Enterprise Software REST API calls.","title":"BDB replica sources status field","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/objects/bdb/replica_sources_status/"},{"id":"replica_sync","summary":"Documents the bdb replica_sync field used with Redis Enterprise Software REST API calls.","title":"BDB replica sync field","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/objects/bdb/replica_sync/"},{"id":"snapshot_policy","summary":"Documents the snapshot_policy object used with Redis Enterprise Software REST API calls.","title":"Snapshot policy object","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/objects/bdb/snapshot_policy/"},{"id":"status","summary":"Documents the bdb status field used with Redis Enterprise Software REST API calls.","title":"BDB status field","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/objects/bdb/status/"},{"id":"syncer_sources","summary":"Documents the syncer_sources object used with Redis Enterprise Software REST API calls.","title":"Syncer sources object","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/objects/bdb/syncer_sources/"}]
}