crdb-cli crdb update
Updates the configuration of an Active-Active database.
| Redis Enterprise Software |
|---|
Updates the configuration of an Active-Active database.
crdb-cli crdb update --crdb-guid <guid>
[--no-wait]
[--force]
[--default-db-config <configuration> ]
[--default-db-config-file <filename>]
[--compression <0-6>]
[--causal-consistency { true | false } ]
[--credentials id=<id>,username=<username>,password=<password> ]
[--encryption { true | false } ]
[--oss-cluster { true | false } ]
[--featureset-version { true | false } ]
[--memory-size <maximum_memory>]
[--bigstore-ram-size <maximum_memory>]
[--eviction-policy { noeviction | allkeys-lru | allkeys-lfu | allkeys-random | volatile-lru | volatile-lfu | volatile-random | volatile-ttl }]
[--update-module name=<name>,featureset_version=<version>]
[--update-db-config-modules { true | false } ]
If you want to change the configuration of the local instance only, use rladmin instead.
Parameters
| Parameter | Value | Description |
|---|---|---|
| crdb-guid <guid> | string | GUID of the Active-Active database (required) |
| bigstore-ram-size <maximum_memory> | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum RAM limit for the databases with Auto Tiering enabled, if activated |
| memory-size <maximum_memory> | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum database memory (required) |
| causal-consistency | true false |
Causal consistency 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=<id>,username=<username>,password=<password> | strings | Updates the credentials for access to the instance |
| default-db-config <configuration> | Default database configuration from stdin. For a list of database settings, see the CRDB database config object reference. | |
| default-db-config-file <filename> | filepath | Default database configuration from file |
| encryption | true false |
Activates or deactivates encryption |
| force | Force an update even if there are no changes | |
| no-wait | Do not wait for the command to finish | |
| oss-cluster | true false |
Activates or deactivates OSS Cluster mode |
| eviction-policy | noeviction allkeys-lru allkeys-lfu allkeys-random volatile-lru volatile-lfu volatile-random volatile-ttl |
Updates eviction policy |
| featureset-version | true false |
Updates to latest FeatureSet version |
| update-module name=<name>,featureset_version=<version> | strings | Update a module to the specified version |
| update-db-config-modules | true false |
Updates module information in the CRDB configuration (default-db-config) based on the latest module data for the database. Use this option only after all CRDB database instances have upgraded their modules. |
Returns
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."
Examples
The following example changes the maximum database memory:
$ crdb-cli crdb update --crdb-guid <crdb-guid> --memory-size 2GB
Task <task-id> created
---> Status changed: queued -> started
---> Status changed: started -> finished
The following example shows how to change a default database configuration setting:
$ crdb-cli crdb update --crdb-guid <crdb-guid> --default-db-config '{"shards_count": <primary_shards_count>}'
Task <task-id> created
---> Status changed: queued -> started
---> Status changed: started -> finished