Skip to content

Commit e31001b

Browse files
rrelledgerrelledge
committed
DOC-5354 Added missing parameters for crdb-cli crdb create and more details/descriptions for optional parameters
1 parent d1051ec commit e31001b

File tree

1 file changed

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

1 file changed

+14
-9
lines changed

‎content/operate/rs/references/cli-utilities/crdb-cli/crdb/create.md‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ Creates an Active-Active database.
1515
```sh
1616
crdb-cli crdb create --name <name>
1717
--memory-size <maximum_memory>
18-
--instance fqdn=<cluster_fqdn>,username=<username>,password=<password>[,url=<url>,replication_endpoint=<endpoint>]
19-
--instance fqdn=<cluster_fqdn>,username=<username>,password=<password>[,url=<url>,replication_endpoint=<endpoint>]
18+
--instance fqdn=<cluster_fqdn-1>,username=<username>,password=<password>[,url=<url-1>,replication_endpoint=<endpoint-1>,replication_tls_sni=<hostname-1>]
19+
--instance fqdn=<cluster_fqdn-2>,username=<username>,password=<password>[,url=<url-2>,replication_endpoint=<endpoint-2>,replication_tls_sni=<hostname-2>]
2020
[--port <port_number>]
21-
[--no-wait]
21+
[--wait | --no-wait]
2222
[--default-db-config <configuration>]
2323
[--default-db-config-file <filename>]
2424
[--compression <0-6>]
@@ -30,8 +30,11 @@ crdb-cli crdb create --name <name>
3030
[--shards-count <number_of_shards>]
3131
[--shard-key-regex <regex_rule>]
3232
[--oss-cluster { true | false } ]
33+
[--oss-sharding { true | false } ]
3334
[--bigstore { true | false }]
3435
[--bigstore-ram-size <maximum_memory>]
36+
[--eviction-policy { noeviction | allkeys-lru | allkeys-lfu |allkeys-random | volatile-lru | volatile-lfu | volatile-random | volatile-ttl }]
37+
[--proxy-policy { all-nodes | all-master-shards | single }]
3538
[--with-module name=<module_name>,version=<module_version>,args=<module_args>]
3639
```
3740
@@ -48,24 +51,26 @@ Before you create an Active-Active database, you must have:
4851
| Parameter&nbsp;&&nbsp;options(s)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Value | Description |
4952
|---------------------------------------------------------------------------------------|-------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5053
| name \<CRDB_name\> | string | Name of the Active-Active database (required) |
51-
| memory-size \<maximum_memory\> | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum database memory (required) |
52-
| instance<br/>&nbsp;&nbsp; fqdn=\<cluster_fqdn\>,<br/>&nbsp;&nbsp; username=\<username\>,<br/>&nbsp;&nbsp; password=\<password\> | strings | The connection information for the participating clusters (required for each participating cluster) |
54+
| memory-size \<maximum_memory\> | size in bytes, megabytes (MB), or gigabytes (GB) | Maximum database memory (required) |
55+
| instance fqdn=\<cluster_fqdn\>,username=\<username\>,password=\<password\>,url=\<url\>,replication_endpoint=\<endpoint\>,replication_tls_sni=\<sni\> | strings | The connection information for the participating clusters (required for each participating cluster)<br/><br/>**Required:**<br/>• `fqdn` - Cluster fully qualified domain name<br/>• `username` - Cluster username<br/>• `password` - Cluster password<br/><br/>**Optional:**<br/>• `url` - Cluster access URL<br/>• `replication_endpoint` - Address for peer replication<br/>• `replication_tls_sni` - Cluster SNI for TLS connections |
5356
| port \<port_number\> | integer | TCP port for the Active-Active database on all participating clusters |
5457
| default-db-config \<configuration\> | string | Default database configuration options |
5558
| default-db-config-file \<filename\> | filepath | Default database configuration options from a file |
56-
| no-wait | | Prevents `crdb-cli` from running another command before this command finishes |
59+
| wait | | Prevents `crdb-cli` from running another command before this command finishes |
60+
| no-wait | | `crdb-cli` can run another command before this command finishes |
5761
| compression | 0-6 | The level of data compression: <br /><br > 0 = No compression <br /><br > 6 = High compression and resource load (Default: 3) |
58-
| causal-consistency | true <br/> false (*default*) | [Causal consistency]({{< relref "/operate/rs/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received |
62+
| causal-consistency | true <br/> false (default: false) | [Causal consistency]({{< relref "/operate/rs/databases/active-active/causal-consistency.md" >}}) applies updates to all instances in the order they were received |
5963
| password \<password\> | string | Password for access to the database |
6064
| replication | true <br/> false (*default*) | Activates or deactivates [database replication]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}}) where every master shard replicates to a replica shard |
6165
| encryption | true <br/> false (*default*) | Activates or deactivates encryption |
6266
| sharding | true <br/> false (*default*) | Activates or deactivates sharding (also known as [database clustering]({{< relref "/operate/rs/databases/durability-ha/replication.md" >}})). Cannot be updated after the database is created |
6367
| shards-count \<number_of_shards\> | integer | If sharding is enabled, this specifies the number of Redis shards for each database instance |
6468
| oss-cluster | true<br/>false (*default*) | Activates [OSS cluster API]({{< relref "/operate/rs/clusters/optimize/oss-cluster-api" >}}) |
69+
| oss-sharding | true<br/>false | Use the OSS sharding policy instead of regex rules |
6570
| shard-key-regex \<regex_rule\> | string | If clustering is enabled, this defines a regex rule (also known as a [hashing policy]({{< relref "/operate/rs/databases/durability-ha/clustering#custom-hashing-policy" >}})) that determines which keys are located in each shard (defaults to `{u'regex': u'.*\\{(?<tag>.*)\\}.*'}, {u'regex': u'(?<tag>.*)'} `) |
6671
| bigstore | true <br/> <br/> false (*default*) | If true, the database uses Auto Tiering to add flash memory to the database |
67-
| bigstore-ram-size \<size\> | size in bytes, kilobytes (KB), or gigabytes (GB) | Maximum RAM limit for databases with Auto Tiering enabled |
68-
| with-module<br/>&nbsp;&nbsp;name=\<module_name\>,<br/>&nbsp;&nbsp;version=\<module_version\>,<br/>&nbsp;&nbsp;args=\<module_args\> | strings | Creates a database with a specific module |
72+
| bigstore-ram-size \<size\> | size in bytes, megabytes (MB), or gigabytes (GB) | Maximum RAM limit for databases with Auto Tiering enabled |
73+
| with-module name=\<module_name\>,version=\<module_version\>,args=\<module_args\> | strings | Creates a database with a specific module |
6974
| eviction-policy | noeviction (*default*)<br/>allkeys-lru<br/>allkeys-lfu<br/>allkeys-random<br/>volatile-lru<br/>volatile-lfu<br/>volatile-random<br/>volatile-ttl | Sets [eviction policy]({{< relref "/operate/rs/databases/memory-performance/eviction-policy" >}}) |
7075
| proxy-policy | all-nodes<br>all-master-shards<br>single | Sets proxy policy |
7176

0 commit comments

Comments
 (0)