Skip to content

Commit 751ee6f

Browse files
committed
DOC-4563 Added update default-db-config example to crdb-cli reference
1 parent 6e8813d commit 751ee6f

File tree

1 file changed

+14
-2
lines changed
  • content/operate/rs/references/cli-utilities/crdb-cli/crdb

1 file changed

+14
-2
lines changed

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

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,22 @@ Returns the task ID of the task that is updating the database.
5757
5858
If `--no-wait` is specified, the command exits. Otherwise, it will wait for the database to be updated and then return "finished."
5959
60-
### Example
60+
### Examples
61+
62+
The following example changes the maximum database memory:
63+
64+
```sh
65+
$ crdb-cli crdb update --crdb-guid <crdb-guid> --memory-size 2GB
66+
Task <task-id> created
67+
---> Status changed: queued -> started
68+
---> Status changed: started -> finished
69+
```
70+
71+
The following example shows how to change a default database configuration setting:
6172
6273
```sh
63-
$ crdb-cli crdb update --crdb-guid 968d586c-e12d-4b8f-8473-42eb88d0a3a2 --memory-size 2GBTask 7e98efc1-8233-4578-9e0c-cdc854b8af9e created
74+
$ crdb-cli crdb update --crdb-guid <crdb-guid> --default-db-config '{"shards_count": <primary_shards_count>}'
75+
Task <task-id> created
6476
---> Status changed: queued -> started
6577
---> Status changed: started -> finished
6678
```

0 commit comments

Comments
 (0)