Back to Redis

Update

content/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/update.md

latest7.7 KB
Original Source

Updates the configuration of an Active-Active database.

sh
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>]

If you want to change the configuration of the local instance only, use [rladmin]({{< relref "/operate/rs/7.4/references/cli-utilities/rladmin" >}}) instead.

Parameters

ParameterValueDescription
crdb-guid <guid>stringGUID 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-consistencytrue
false[Causal consistency]({{< relref "/operate/rs/7.4/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received
compression0-6The 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 | | 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]({{< relref "/operate/rs/7.4/databases/memory-performance/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 |

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."

Example

sh
$ crdb-cli crdb update --crdb-guid 968d586c-e12d-4b8f-8473-42eb88d0a3a2 --memory-size 2GBTask 7e98efc1-8233-4578-9e0c-cdc854b8af9e created
  ---> Status changed: queued -> started
  ---> Status changed: started -> finished