diff --git a/content/operate/rs/references/cli-utilities/crdb-cli/crdb/update.md b/content/operate/rs/references/cli-utilities/crdb-cli/crdb/update.md index cb090e2944..116da9fc1e 100644 --- a/content/operate/rs/references/cli-utilities/crdb-cli/crdb/update.md +++ b/content/operate/rs/references/cli-utilities/crdb-cli/crdb/update.md @@ -41,7 +41,7 @@ If you want to change the configuration of the local instance only, use [`rladmi | causal-consistency | true
false | [Causal consistency]({{< relref "/operate/rs/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received | | compression | 0-6 | The level of data compression:

0 = No compression

6 = High compression and resource load (Default: 3) | | credentials id=\,username=\,password=\ | strings | Updates the credentials for access to the instance | -| default-db-config \ | | Default database configuration from stdin | +| default-db-config \ | | Default database configuration from stdin. For a list of database settings, see the [CRDB database config object]({{}}) reference. | | default-db-config-file \ | filepath | Default database configuration from file | | encryption | true
false | Activates or deactivates encryption | | force | | Force an update even if there are no changes | @@ -57,10 +57,22 @@ Returns the task ID of the task that is updating the database. If `--no-wait` is specified, the command exits. Otherwise, it will wait for the database to be updated and then return "finished." -### Example +### Examples + +The following example changes the maximum database memory: + +```sh +$ crdb-cli crdb update --crdb-guid --memory-size 2GB +Task created + ---> Status changed: queued -> started + ---> Status changed: started -> finished +``` + +The following example shows how to change a default database configuration setting: ```sh -$ crdb-cli crdb update --crdb-guid 968d586c-e12d-4b8f-8473-42eb88d0a3a2 --memory-size 2GBTask 7e98efc1-8233-4578-9e0c-cdc854b8af9e created +$ crdb-cli crdb update --crdb-guid --default-db-config '{"shards_count": }' +Task created ---> Status changed: queued -> started ---> Status changed: started -> finished ``` diff --git a/content/operate/rs/references/rest-api/objects/crdb/database_config.md b/content/operate/rs/references/rest-api/objects/crdb/database_config.md index 77d91cc0bb..8cca159148 100644 --- a/content/operate/rs/references/rest-api/objects/crdb/database_config.md +++ b/content/operate/rs/references/rest-api/objects/crdb/database_config.md @@ -14,26 +14,26 @@ An object that represents the database configuration. | Name | Type/Value | Description | |------|------------|-------------| -| aof_policy | string | Policy for Append-Only File data persistence | +| 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 | Database driver is Auto Tiering | -| bigstore_ram_size | integer | Memory size of RAM size | -| data_persistence | string | Database on-disk persistence | +| 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]({{< relref "/operate/rs/references/rest-api/objects/bdb/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 | Hint for maximum AOF file size | -| max_aof_load_time | integer | Hint for maximum AOF reload time | -| memory_size | integer | Database memory size limit, in bytes | -| oss_cluster | boolean | Enables OSS Cluster mode | -| oss_cluster_api_preferred_ip_type | string | Indicates preferred IP type in OSS cluster API: internal/external | -| oss_sharding | boolean | An alternative to shard_key_regex for using the common case of the OSS shard hashing policy | +| 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. | +| 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 | string | The policy used for proxy binding to the endpoint | -| rack_aware | boolean | Require the database to be always replicated across multiple racks | -| replication | boolean | Database replication | +| 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": ".*\\{(?.*)\\}.*"}, {"regex": "(?.*)"}]` | -| shards_count | integer | Number of database shards | -| shards_placement | string | Control the density of shards: should they reside on as few or as many nodes as possible | -| snapshot_policy | array of [snapshot_policy]({{< relref "/operate/rs/references/rest-api/objects/bdb/snapshot_policy" >}}) objects | Policy for snapshot-based data persistence (required) | -| tls_mode | string | Encrypt communication | +| 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]({{< relref "/operate/rs/references/rest-api/objects/bdb/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 |