Commands

Documentation for `scw datawarehouse`

The CLI documentation pages are currently under construction

The content is up to date. We're making improvements to the site over the next few weeks for a better experience.

Data Warehouse API.

Database management commands

Manage databases within a deployment.

Create a new database within a deployment

Create a new database within a deployment.

Usage:

Code
scw datawarehouse database create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment	Required
name	Name of the database
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

Delete a database from a deployment

Delete a database from a deployment.

Usage:

Code
scw datawarehouse database delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment	Required
name	Name of the database to delete	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

List databases within a deployment

List databases within a deployment.

Usage:

Code
scw datawarehouse database list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment	Required
name	Name of the database to filter by
order-by	Criteria to use when ordering database listings	One of: `name_asc`, `name_desc`, `size_asc`, `size_desc`
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `all`

Deployment management commands

A deployment is composed of one or multiple replicas.

Create a deployment

Create a new deployment.

Usage:

Code
scw datawarehouse deployment create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
project-id	Project ID to use. If none is passed the default project ID will be used
name	Name of the deployment
tags.{index}	Tags to apply to the deployment
version	ClickHouse® version to use for the deployment
replica-count	Number of replicas for the deployment
shard-count	Number of shard for the deployment
password	Password for the initial user
cpu-min	Minimum CPU count for the deployment
cpu-max	Maximum CPU count for the deployment
endpoints.{index}.public
endpoints.{index}.private-network.private-network-id	UUID of the Private Network
ram-per-cpu	RAM per CPU count for the deployment (in GB)
move-factor	For the `tiered` storage policy, controls when data is moved from the hot volume (Block Storage) to the cold volume (Object Storage). Data is moved once free space on the hot volume drops below this fraction of its capacity. Value between 0 and 1 (default 0.1, i.e. data is moved when the hot volume is 90% full).
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

Delete a deployment

Delete a given deployment, specified by the region and deployment_id parameters. Deleting a deployment is permanent, and cannot be undone. Upon deletion, all your data will be lost.

Usage:

Code
scw datawarehouse deployment delete <deployment-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment to delete	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

Get a deployment

Retrieve information about a given deployment, specified by the region and deployment_id parameters. Its full details, including name, status are returned in the response object.

Usage:

Code
scw datawarehouse deployment get <deployment-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

Get deployment TLS certificate

Retrieve the TLS certificate associated with a deployment.

Usage:

Code
scw datawarehouse deployment get-certificate <deployment-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

List deployments

List all deployments in the specified region, for a given Scaleway Project. By default, the deployments returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as tags and name. For the name parameter, the value you provide will be checked against the whole name string to see if it includes the string you put in the parameter.

Usage:

Code
scw datawarehouse deployment list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
tags.{index}	List deployments with a given tag
name	Lists deployments that match a name pattern
order-by	Criteria to use when ordering deployment listings	One of: `created_at_desc`, `created_at_asc`, `name_asc`, `name_desc`
project-id	Project ID the deployment belongs to
organization-id	Organization ID the deployment belongs to
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `all`

Update a deployment

Update the parameters of a deployment.

Usage:

Code
scw datawarehouse deployment update <deployment-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment to update	Required
name	Name of the deployment
tags.{index}	Tags of a deployment
cpu-min	Minimum CPU count for the deployment
cpu-max	Maximum CPU count for the deployment
replica-count	Number of replicas for the deployment
move-factor	For the `tiered` storage policy, controls when data is moved from the hot volume (Block Storage) to the cold volume (Object Storage). Data is moved once free space on the hot volume drops below this fraction of its capacity. Value between 0 and 1 (default 0.1, i.e. data is moved when the hot volume is 90% full).
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

Endpoint management commands

Manage endpoints associated with a deployment.

Create a new endpoint for a deployment

Create a new endpoint for a deployment.

Usage:

Code
scw datawarehouse endpoint create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment
endpoint.public
endpoint.private-network.private-network-id	UUID of the Private Network
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

Delete an endpoint from a deployment

Delete an endpoint from a deployment.

Usage:

Code
scw datawarehouse endpoint delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
endpoint-id	UUID of the Endpoint to delete	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

List available presets

Data Warehouse preset to help you choose the best configuration.

List available presets

List available presets.

Usage:

Code
scw datawarehouse preset list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `all`

User management commands

Manage users associated with a deployment.

Create a new user for a deployment

Create a new user for a deployment.

Usage:

Code
scw datawarehouse user create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment	Required
name	Name of the user
password	Password for the user
is-admin	Indicates if the user is an administrator
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

Delete a user from a deployment

Delete a user from a deployment.

Usage:

Code
scw datawarehouse user delete [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment	Required
name	Name of the user to delete	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

List users associated with a deployment

List users associated with a deployment.

Usage:

Code
scw datawarehouse user list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment	Required
name	Name of the user to filter by
order-by	Criteria to use when ordering user listings	One of: `name_asc`, `name_desc`
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `all`

Update an existing user for a deployment

Update an existing user for a deployment.

Usage:

Code
scw datawarehouse user update [arg=value ...]

Arguments:

Name	Description	Argument Specifications
deployment-id	UUID of the deployment	Required
name	Name of the user	Required
password	New password for the user
is-admin	Updates the user administrator permissions
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`

List available Clickhouse® versions

ClickHouse® versions powering your deployment.

List available ClickHouse® versions

List available ClickHouse® versions.

Usage:

Code
scw datawarehouse version list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
version
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `all`