{
  "id": "update",
  "title": "crdb-cli crdb update",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/crdb-cli/crdb/update/",
  "summary": "Updates the configuration of an Active-Active database.",
  "content": "\nUpdates the configuration of an Active-Active database.\n\n```sh\ncrdb-cli crdb update --crdb-guid \u003cguid\u003e\n         [--no-wait]\n         [--force]\n         [--default-db-config \u003cconfiguration\u003e ]\n         [--default-db-config-file \u003cfilename\u003e]\n         [--compression \u003c0-6\u003e]\n         [--causal-consistency { true | false } ]\n         [--credentials id=\u003cid\u003e,username=\u003cusername\u003e,password=\u003cpassword\u003e ]\n         [--encryption { true | false } ]\n         [--oss-cluster { true | false } ]\n         [--featureset-version { true | false } ]\n         [--memory-size \u003cmaximum_memory\u003e]\n         [--bigstore-ram-size \u003cmaximum_memory\u003e]\n         [--eviction-policy { noeviction | allkeys-lru | allkeys-lfu | allkeys-random | volatile-lru | volatile-lfu | volatile-random | volatile-ttl }]\n         [--update-module name=\u003cname\u003e,featureset_version=\u003cversion\u003e]\n```\n\nIf you want to change the configuration of the local instance only, use [`rladmin`]() instead.\n\n### Parameters\n\n| Parameter                                                           | Value                                                                                                                         | Description                                                                                                                                                              |\n|---------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| crdb-guid \\\u003cguid\\\u003e                                                 | string                                                                                                                        | GUID of the Active-Active database (required)                                                                                                                            |\n| bigstore-ram-size \\\u003cmaximum_memory\\\u003e                                                  | size in bytes, kilobytes (KB), or gigabytes (GB)                                                                               | Maximum RAM limit for the  databases with Auto Tiering enabled, if activated                                                                                                          |\n| memory-size \\\u003cmaximum_memory\\\u003e                                                                | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum database memory (required)                                                                                                                                                                                           |\n| causal-consistency                                                  | true \u003cbr/\u003efalse                                                                                                           | [Causal consistency]() applies updates to all instances in the order they were received |\n| compression                                                         | 0-6                                                                                                                           | The level of data compression: \u003cbr /\u003e\u003cbr /\u003e 0 = No compression \u003cbr /\u003e\u003cbr /\u003e 6 = High compression and resource load (Default: 3)                                                        |\n| credentials id=\\\u003cid\\\u003e,username=\\\u003cusername\\\u003e,password=\\\u003cpassword\\\u003e | strings                                                                                                                       | Updates the credentials for access to the instance                                                                                                                       |\n| default-db-config \\\u003cconfiguration\\\u003e                                                  |                                                                                                                               | Default database configuration from stdin. For a list of database settings, see the [CRDB database config object]() reference. |\n| default-db-config-file \\\u003cfilename\\\u003e                                | filepath                                                                                                                      | Default database configuration from file                                                                                                                                 |\n| encryption                                                          | true \u003cbr/\u003efalse                                                                                                           | Activates or deactivates encryption                                                                                                                                      |\n| force                                                               |                                                                                                                               | Force an update even if there are no changes                                                                                                                             |\n| no-wait                                                             |                                                                                                                               | Do not wait for the command to finish                                                                                                                                    |\n| oss-cluster                                                         | true \u003cbr/\u003efalse                                                                                                           | Activates or deactivates OSS Cluster mode                                                                                                                                |\n| eviction-policy                                                     | noeviction\u003cbr/\u003eallkeys-lru\u003cbr/\u003eallkeys-lfu\u003cbr/\u003eallkeys-random\u003cbr/\u003evolatile-lru\u003cbr/\u003evolatile-lfu\u003cbr/\u003evolatile-random\u003cbr/\u003evolatile-ttl | Updates [eviction policy]()                                                                                                          |\n| featureset-version                                                  | true\u003cbr/\u003efalse                                                                                                             | Updates to latest FeatureSet version                                                                                                                                     |\n| update-module name=\\\u003cname\u003e,featureset_version=\\\u003cversion\\\u003e         | strings                                                                                                                       | Update a module to the specified version                                                                                                                                 |\n\n### Returns\n\nReturns the task ID of the task that is updating the database.\n\nIf `--no-wait` is specified, the command exits. Otherwise, it will wait for the database to be updated and then return \"finished.\"\n\n### Examples\n\nThe following example changes the maximum database memory:\n\n```sh\n$ crdb-cli crdb update --crdb-guid \u003ccrdb-guid\u003e --memory-size 2GB\nTask \u003ctask-id\u003e created\n  ---\u003e Status changed: queued -\u003e started\n  ---\u003e Status changed: started -\u003e finished\n```\n\nThe following example shows how to change a default database configuration setting:\n\n```sh\n$ crdb-cli crdb update --crdb-guid \u003ccrdb-guid\u003e --default-db-config '{\"shards_count\": \u003cprimary_shards_count\u003e}'\nTask \u003ctask-id\u003e created\n  ---\u003e Status changed: queued -\u003e started\n  ---\u003e Status changed: started -\u003e finished\n```\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}