Feedback

  Suggest improvement

  Edit page

  View page source

latest

clusters

The clusters command lets you manage cluster products.

Tip

The minimum accepted length of password is 24 characters.

Be careful when specifying passwords on the command line. Some non-alphanumeric characters may be interpreted in an unexpected way by your shell. Use string delimitation and escape characters as needed.

Warning

Some clusters commands are only available for CrateDB Cloud sysadmins (superusers). A warning will indicate at the bottom of the documentation for each command when this is the case. They are listed here solely to clarify their function. You can also get information on any command by appending --help.

Usage: croud clusters [-h]
                      {get,list,deploy,scale,upgrade,delete,restart-node,set-deletion-protection,set-ip-whitelist,expand-storage,set-suspended-state,set-product,set-backup-schedule,snapshots,import-jobs,export-jobs,scheduled-jobs}
                      ...

clusters list

Usage: croud clusters list [-h] [-p PROJECT_ID] [--org-id ORG_ID]
                           [--region REGION]
                           [--output-fmt {table,wide,json,yaml}] [--sudo]

Optional Arguments

-p, --project-id

The project ID to use.

--org-id

The organization ID to use.

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud clusters list
+--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+
| id                                   | name                   | numNodes | crateVersion | projectId                            | username    | fqdn                                             |
|--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster |        1 | 4.5.1        | 952cd102-91c1-4837-962a-12ecb71a6ba8 | default     | my-first-crate-cluster.eastus.azure.cratedb.net. |
+--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+

clusters deploy

Usage: croud clusters deploy [-h] --product-name PRODUCT_NAME --tier TIER
                             [--unit UNIT] [-p PROJECT_ID] [--org-id ORG_ID]
                             --cluster-name CLUSTER_NAME --version VERSION
                             --username USERNAME --password PASSWORD
                             --subscription-id SUBSCRIPTION_ID
                             [--channel {stable,testing,nightly}]
                             [--cpus CPUS] [--disks DISKS]
                             [--disk-size-gb DISK_SIZE_GB]
                             [--disk-type {standard,premium}]
                             [--memory-size-mb MEMORY_SIZE_MB]
                             [--region REGION]
                             [--output-fmt {table,wide,json,yaml}] [--sudo]

Required Arguments

--product-name

The product name to use.

--tier

The product tier to use.

--cluster-name

The CrateDB cluster name to use.

--version

The CrateDB version to use.

--username

The CrateDB username to use.

--password

The CrateDB password to use. Minimum 24 characters.

--subscription-id

The subscription to use for billing of this cluster.

Optional Arguments

--unit

The product scale unit to use.

-p, --project-id

The project ID to use.

--org-id

The organization ID to use.

--channel

Possible choices: stable, testing, nightly

The channel of the CrateDB version.

Default: “stable”

--cpus

Number of CPU cores to allocate. Can be fractional. CrateDB Edge regions only.

--disks

Number of disks to attach. CrateDB Edge regions only.

--disk-size-gb

Size of disks to attach (in GiB).

--disk-type

Possible choices: standard, premium

Type of disks to use. CrateDB Edge regions only.

--memory-size-mb

Amount of memory to allocate (in MiB). CrateDB Edge regions only.

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud clusters deploy \
    --product-name cr1 \
    --tier default \
    --cluster-name my-first-crate-cluster \
    --org-id 952cd102-91c1-4837-962a-12ecb71a6ba8 \
    --region aks1.westeurope.azure \
    --version 5.3.2 \
    --username admin \
    --password "8Hed#kd$8^9i4Q#65fT4GKQI" \
    --subscription-id 782dfc00-7b25-4f48-8381-b1b096dd1619
+--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+
| id                                   | name                   | numNodes | crateVersion | projectId                            | username    | fqdn                                             |
|--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster |        1 | 5.3.2        | 952cd102-91c1-4837-962a-12ecb71a6ba8 | admin       | my-first-crate-cluster.eastus.azure.cratedb.net. |
+--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+
==> Info: Cluster creation initiated. It may take a few minutes to complete.
==> Info: Status: REGISTERED (Your creation request was received and is pending processing.)
==> Info: Status: IN_PROGRESS (Cluster creation started. Waiting for the node(s) to be created and creating other required resources.)
==> Success: Operation completed.
+--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+
| id                                   | name                   | numNodes | crateVersion | projectId                            | username    | fqdn                                             |
|--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster |        1 | 4.8.0        | 952cd102-91c1-4837-962a-12ecb71a6ba8 | admin       | my-first-crate-cluster.eastus.azure.cratedb.net. |
+--------------------------------------+------------------------+----------+--------------+--------------------------------------+-------------+--------------------------------------------------+

Deployment of testing/nightly versions

For the users that want to get their hands on new features early, it is possible to deploy versions from our testing and nightly channels.

testing - These are versions that are being evaluated for promotion to a stable release.

nightly - These are built every night with the latest changes. They will possibly contain newer features, but they also have potential to be less stable than testing channel.

Both testing and nightly channel releases are available here.

We want to emphasize the following about testing and nightly channels:

• They are for advanced users only.

• They are not suitable for production deployments.

• It is not possible to switch channels, e.g from testing to nightly, or from testing to stable.

Example

sh$ croud clusters deploy
    --product-name cr1
    --tier default
    --cluster-name test-deployment
    --project-id bdf523d0-ebc8-4f67-8e15-67d4225a20f9
    --version nightly-5.4.0-20230531
    --username "admin"
    --password "vogRjkY3TR$$P@UvogRjkY3TR$$P@U7vogRjkY3TR$$P@U7"
    --subscription-id 7598dc2b-a12e-123b-b776-a5123d4a123d
    --channel nightly
    --unit 0

clusters scale

Usage: croud clusters scale [-h] --cluster-id CLUSTER_ID --unit UNIT
                            [--region REGION]
                            [--output-fmt {table,wide,json,yaml}] [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster ID to use.

--unit

The product scale unit to use.

Optional Arguments

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud clusters scale \
    --cluster-id 34813eb4-0a91-443e-af77-33fb91a0b04c \
    --unit 1
+--------------------------------------+------------------------+----------+
| id                                   | name                   | numNodes |
|--------------------------------------+------------------------+----------|
| 34813eb4-0a91-443e-af77-33fb91a0b04c | emerald-taun-we        |        1 |
+--------------------------------------+------------------------+----------+
==> Info: Cluster scaling initiated. It may take a few minutes to complete
the changes.
==> Info: Status: SENT (Your scaling request was sent to the region.)
==> Info: Status: IN_PROGRESS (Scaling up from 1 to 2 nodes. Waiting for new node(s) to be present.)
==> Success: Operation completed.
+--------------------------------------+------------------------+----------+
| id                                   | name                   | numNodes |
|--------------------------------------+------------------------+----------|
| 34813eb4-0a91-443e-af77-33fb91a0b04c | emerald-taun-we        |        2 |
+--------------------------------------+------------------------+----------+

Note

The unit argument designates the predefined number of nodes, it does not work in an additive manner. E.g., if you have a cluster with two nodes and use the croud clusters scale command with the --unit 1 argument, it does not mean that one additional node will be added to the cluster. Instead, your cluster will be scaled down to two nodes.

--unit 0 means one node,

--unit 1 means two nodes,

--unit 2 means three nodes, etc.

This command will wait for the cluster scaling to finish or fail.

clusters upgrade

Usage: croud clusters upgrade [-h] --cluster-id CLUSTER_ID --version VERSION
                              [--region REGION]
                              [--output-fmt {table,wide,json,yaml}] [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster ID to use.

--version

The CrateDB version to use.

Optional Arguments

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud clusters upgrade \
    --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \
    --version 4.6.7
+--------------------------------------+------------------------+---------------+
| id                                   | name                   | crate_version |
|--------------------------------------+------------------------+---------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster |         4.6.6 |
+--------------------------------------+------------------------+---------------+
==> Info: Cluster upgrade initiated. It may take a few minutes to complete the changes.
==> Info: Status: SENT (Your upgrade request was sent to the region.)
==> Info: Status: IN_PROGRESS (Waiting for node 1/1 to be terminated...)
==> Info: Status: IN_PROGRESS (Waiting for node 1/1 to be restarted...)
==> Success: Operation completed.
+--------------------------------------+------------------------+---------------+
| id                                   | name                   | crate_version |
|--------------------------------------+------------------------+---------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster |         4.6.7 |
+--------------------------------------+------------------------+---------------+

Note

This command will wait for the cluster upgrade to finish or fail.

clusters delete

Usage: croud clusters delete [-h] --cluster-id CLUSTER_ID [-y]
                             [--region REGION]
                             [--output-fmt {table,wide,json,yaml}] [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster ID to use.

Optional Arguments

-y, --yes

Default: False

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud clusters delete \
    --cluster-id dc40090f-e1df-4974-b751-9fc27c824368
Are you sure you want to delete the cluster? [yN] y
==> Success: Cluster deleted.

Note

After deleting a cluster, existing backups will remain for 30 days since the last time a backup was made. While you won’t be able to restore these backups yourself, you can reach out to our support to have them restore a backup for you.

If you want a more recent backup, there are several options:

• Create an AWS S3 repository with a base_path of /<project_id>/<cluster_id>/<name>. <project_id> and <cluster_id> refer to the “dashed” form of the corresponding ID (XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX). <name> can be any alphanumeric string. Afterwards, create a snapshot in your repository.

• Alternatively, you can create a backup as documented in the CrateDB documentation about snapshots on repositories and snapshots by e.g. providing your own AWS S3 bucket and credentials.

• Lastly, the COPY TO SQL statement can be used to export a table to an AWS S3 bucket as well.

Important

When you provide your own external storage, please ensure that the location is not world readable or writable to prevent unauthorized access to your data!

clusters restart-node

Usage: croud clusters restart-node [-h] --cluster-id CLUSTER_ID --ordinal
                                   ORDINAL [--region REGION]
                                   [--output-fmt {table,wide,json,yaml}]
                                   [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster ID to use.

--ordinal

The ordinal index of the node to restart.

Optional Arguments

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud clusters restart-node \
    --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \
    --ordinal 1
+--------+----------+
|   code | status   |
|--------+----------|
|    200 | Success  |
+--------+----------+
==> Success: Node restarted. It may take a few minutes to complete the changes.

clusters set-deletion-protection

Usage: croud clusters set-deletion-protection [-h] --cluster-id CLUSTER_ID
                                              --value VALUE [--region REGION]
                                              [--output-fmt {table,wide,json,yaml}]
                                              [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster ID to use.

--value

The deletion protection status

Optional Arguments

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud clusters set-deletion-protection \
    --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \
    --value true
+--------------------------------------+------------------------+----------------------+
| id                                   | name                   | deletion_protected   |
|--------------------------------------+------------------------+----------------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster | TRUE                 |
+--------------------------------------+------------------------+----------------------+
==> Success: Cluster deletion protection status successfully updated

Note

This command is only available for superusers and organization admins.

clusters set-ip-whitelist

Usage: croud clusters set-ip-whitelist [-h] --cluster-id CLUSTER_ID --net NET
                                       [-y] [--region REGION]
                                       [--output-fmt {table,wide,json,yaml}]
                                       [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster ID to use.

--net

IP Network list in CIDR format (comma-separated).

Optional Arguments

-y, --yes

Default: False

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud clusters set-ip-whitelist \
    --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \
    --net "10.1.2.0/24,192.168.1.0/24"
This will overwrite all existing CIDR restrictions. Continue? [yN] y
+--------------------------------------+------------------------+----------------+
| id                                   | name                   | ip_whitelist   |
|--------------------------------------+------------------------+----------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster | NULL           |
+--------------------------------------+------------------------+----------------+
==> Info: Updating the IP Network whitelist initiated. It may take a few minutes to complete the changes.
==> Info: Status: SENT (Your update request was sent to the region.)
==> Info: Status: IN_PROGRESS (Updating IP Network Whitelist.)
==> Success: Operation completed.
+--------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+
| id                                   | name                   | ip_whitelist                                                                                    |
|--------------------------------------+------------------------+-------------------------------------------------------------------------------------------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster | [{"cidr": "10.1.2.0/24", "description": null}, {"cidr": "192.168.1.0/24", "description": null}] |
+--------------------------------------+------------------------+-------------------------------------------------------------------------------------------------+

Note

This command will wait for the operation to finish or fail.

clusters expand-storage

Usage: croud clusters expand-storage [-h] --cluster-id CLUSTER_ID
                                     --disk-size-gb DISK_SIZE_GB
                                     [--region REGION]
                                     [--output-fmt {table,wide,json,yaml}]
                                     [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster ID to use.

--disk-size-gb

New size of attached disks (in GiB).

Optional Arguments

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud clusters expand-storage \
    --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \
    --disk-size-gb 512
+--------------------------------------+------------------------+------------------------------------+
| id                                   | name                   | hardware_specs                     |
|--------------------------------------+------------------------+------------------------------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster | Disk size: 256.0 GiB               |
+--------------------------------------+------------------------+------------------------------------+
==> Info: Cluster storage expansion initiated. It may take a few minutes to complete the changes.
==> Info: Status: REGISTERED (Your storage expansion request was received and is pending processing.)
==> Info: Status: SENT (Your storage expansion request was sent to the region.)
==> Info: Status: IN_PROGRESS (Suspending cluster and waiting for Persistent Volume Claim(s) to be resized.)
==> Info: Status: IN_PROGRESS (Starting cluster. Scaling back up to 3 nodes. Waiting for node(s) to be present.)
==> Success: Operation completed.
+--------------------------------------+------------------------+------------------------------------+
| id                                   | name                   | hardware_specs                     |
|--------------------------------------+------------------------+------------------------------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster | Disk size: 512.0 GiB               |
+--------------------------------------+------------------------+------------------------------------+

Note

This command will wait for the operation to finish or fail. It is only available for superusers and organization admins. Note that for Azure users, any storage increase exceeding a given increment (32, 64, etc.) will be priced at the level of the next increment.

clusters set-suspended-state

Usage: croud clusters set-suspended-state [-h] --cluster-id CLUSTER_ID --value
                                          VALUE [--region REGION]
                                          [--output-fmt {table,wide,json,yaml}]
                                          [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster ID to use.

--value

The suspended status.

Optional Arguments

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud clusters set-suspended-state \
    --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \
    --value true
+--------------------------------------+------------------------+----------------+
| id                                   | name                   | suspended      |
|--------------------------------------+------------------------+----------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster | FALSE          |
+--------------------------------------+------------------------+----------------+
==> Info: Updating the cluster status initiated. It may take a few minutes to complete the changes.
==> Info: Status: SENT (Your update request was sent to the region.)
==> Info: Status: IN_PROGRESS (Suspending cluster.)
==> Success: Operation completed.
+--------------------------------------+------------------------+----------------+
| id                                   | name                   | suspended      |
|--------------------------------------+------------------------+----------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster | TRUE           |
+--------------------------------------+------------------------+----------------+

Note

This command will wait for the operation to finish or fail.

clusters set-product

Usage: croud clusters set-product [-h] --cluster-id CLUSTER_ID --product-name
                                  PRODUCT_NAME [--region REGION]
                                  [--output-fmt {table,wide,json,yaml}]
                                  [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster ID to use.

--product-name

The new product name to use.

Optional Arguments

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ croud clusters set-product \
    --cluster-id 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 \
    --product-name cr2
+--------------------------------------+------------------------+----------------+
| id                                   | name                   | product_name   |
|--------------------------------------+------------------------+----------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster | cr1            |
+--------------------------------------+------------------------+----------------+
==> Info: Changing the cluster product initiated. It may take a few minutes to complete the changes.
==> Info: Status: REGISTERED (Your change compute cluster request was received and is pending processing.)
==> Info: Status: SENT (Your change compute request was sent to the region.)
==> Info: Status: IN_PROGRESS (Waiting for node 1/1 to be terminated...)
==> Info: Status: IN_PROGRESS (Waiting for node 1/1 to be restarted...)
==> Success: Operation completed.
+--------------------------------------+------------------------+----------------+
| id                                   | name                   | product_name   |
|--------------------------------------+------------------------+----------------|
| 8d6a7c3c-61d5-11e9-a639-34e12d2331a1 | my-first-crate-cluster | cr2            |
+--------------------------------------+------------------------+----------------+

Note

This command will wait for the operation to finish or fail. It is only available to organization and project admins.

clusters set-backup-schedule

Usage: croud clusters set-backup-schedule [-h] --cluster-id CLUSTER_ID
                                          --backup-hours BACKUP_HOURS
                                          [--region REGION]
                                          [--output-fmt {table,wide,json,yaml}]
                                          [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster ID to use.

--backup-hours

A list of hours in UTC time that represent when backups will take place along the day. The list must contain at least one value and can have up to 24, comma-separated.

Optional Arguments

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ ❯ croud clusters set-backup-schedule --cluster-id 705a7012-3f89-441d-a10e-b3749d05e993 --backup-hours 2,4,6
+--------------------------------------+------------------------+-------------------+
| id                                   | name                   | backup_schedule   |
|--------------------------------------+------------------------+-------------------|
| 705a7012-3f89-441d-a10e-b3749d05e993 | my-cratedb-cluster     | 55 6 * * *        |
+--------------------------------------+------------------------+-------------------+
==> Info: Changing the cluster backup schedule. It may take a few minutes to complete the changes.
==> Info: Status: REGISTERED (Your update backup schedule request was received and is pending processing.)
==> Success: Operation completed.
+--------------------------------------+------------------------+-------------------+
| id                                   | name                   | backup_schedule   |
|--------------------------------------+------------------------+-------------------|
| 705a7012-3f89-441d-a10e-b3749d05e993 | my-cratedb-cluster     | 55 2,4,6 * * *    |
+--------------------------------------+------------------------+-------------------+

Note

This command will wait for the operation to finish or fail. It is only available to organization and project admins.

clusters snapshots

Usage: croud clusters snapshots [-h] {list,restore} ...

clusters snapshots list

Usage: croud clusters snapshots list [-h] --cluster-id CLUSTER_ID
                                     [--days-ago DAYS_AGO] [--region REGION]
                                     [--output-fmt {table,wide,json,yaml}]
                                     [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster ID to use.

Optional Arguments

--days-ago

Number of days to look back.

Default: 2

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ ❯ croud clusters snapshots list --cluster-id 705a7012-3f89-441d-a10e-b3749d05e993
+------------------------+-------------------------------+-------------------+
| created                | repository                    | snapshot          |
|------------------------+-------------------------------+-------------------|
| 2022-12-10 12:34:56    | system_backup_20221002123456  | 20221210123456    |
| 2022-12-10 11:34:54    | system_backup_20221002123456  | 20221210113454    |
+------------------------+-------------------------------+-------------------+

clusters snapshots restore

Usage: croud clusters snapshots restore [-h] --cluster-id CLUSTER_ID
                                        --snapshot SNAPSHOT --repository
                                        REPOSITORY
                                        [--source-cluster-id SOURCE_CLUSTER_ID]
                                        [--type {all,metadata,tables,sections}]
                                        [--tables TABLES]
                                        [--sections SECTIONS]
                                        [--region REGION]
                                        [--output-fmt {table,wide,json,yaml}]
                                        [--sudo]

Required Arguments

--cluster-id

The CrateDB cluster to restore the snapshot into.

--snapshot

The snapshot to be restored.

--repository

The repository that contains the snapshot to be restored.

Optional Arguments

--source-cluster-id

The CrateDB cluster ID of the snapshot to be used belongs to. Must belong to the same organization as the target cluster. If not specified the --cluster-id CrateDB cluster will be used as the source.

--type

Possible choices: all, metadata, tables, sections

The type of data to be restored from the snapshot.

--tables

The list of tables to restore, comma separated. Only valid together with --type tables.

--sections

The list of data sections to restore, comma separated. Only valid together with --type sections. Valid sections are tables, views, users, privileges, analyzers or udfs.

--region, -r

Temporarily use the specified region that command will be run in.

--output-fmt, --format, -o

Possible choices: table, wide, json, yaml

Change the formatting of the output.

--sudo

Run the given command as superuser.

Default: False

Example

sh$ ❯ croud clusters snapshots restore --cluster-id 705a7012-3f89-441d-a10e-b3749d05e993 \
      --repository system_backup_20221002123456 --snapshot 20221210123456 --type all
==> Info: Restoring the snapshot. Depending on the amount of data you have, this might take a very long time.
==> Success: Operation completed.
+------------------------+-------------------------------+-------------------+
| created                | repository                    | snapshot          |
|------------------------+-------------------------------+-------------------|
| 2022-12-10 12:34:56    | system_backup_20221002123456  | 20221210123456    |
+------------------------+-------------------------------+-------------------+

Note

This command will wait for the operation to finish or fail. It is only available to organization and project admins.