Data Warehouse Service (DWS)¶

The DWS client is the command-line interface (CLI) for the Data Warehouse Service (DWS) API and its extensions.

For help on a specific dws command, enter:

$ openstack dws help SUBCOMMAND

DWS Cluster Operations¶

dws cluster create¶

Create a new DWS cluster instance.

openstack dws cluster create
    --flavor <flavor>
    --availability-zone <availability_zone>
    [--num-nodes <num_nodes>]
    [--num-cn <num_cn>]
    --router-id <router_id>
    --network-id <network_id>
    --security-group-id <security_group_id>
    --username <username>
    --password <password>
    [--port <port>]
    [--floating-ip <floating_ip>]
    [--enterprise-project-id <enterprise_project_id>]
    [--wait]
    [--timeout <timeout>]
    <name>

--flavor <flavor>¶: DWS Cluster Flavor (Node Type).

--availability-zone <availability_zone>¶: Availability Zone.

--num-nodes <num_nodes>¶: Number of cluster Nodes. The value range is 3 to 256. For a hybrid data warehouse (standalone), the value is 1.

--num-cn <num_cn>¶: Number of deployed CNs. The value ranges from 2 to the number of cluster nodes minus 1. The maximum value is 20 and the default value is 3.

--router-id <router_id>¶: Router ID.

--network-id <network_id>¶: Network ID.

--security-group-id <security_group_id>¶: Security group ID.

--username <username>¶: Administrator username for logging in to a GaussDB(DWS) cluster. The username must: - Consist of lowercase letters, digits, or underscores. - Start with a lowercase letter or an underscore. - Contain 1 to 63 characters. - Cannot be a keyword of the GaussDB(DWS) database.

--password <password>¶: Administrator password for logging in to a GaussDB(DWS) cluster.

--port <port>¶: Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.

--floating-ip <floating_ip>¶: Bind Floating Ip to a DWS Cluster. Possible values can be: - “auto” - To automatically assign Floating IP. - ID or IP of existing floating ip.

--enterprise-project-id <enterprise_project_id>¶: Enterprise project. The default enterprise project ID is 0.

--wait¶: Wait for the Cluster status to be available.

--timeout <timeout>¶: Timeout for the wait in seconds (Default 1800 seconds).

name¶: Cluster Name.

This command is provided by the otcextensions plugin.

dws cluster delete¶

Delete DWS Cluster(s)

openstack dws cluster delete
    [--keep-last-manual-snapshot <keep_last_manual_snapshot>]
    <cluster>
    [<cluster> ...]

--keep-last-manual-snapshot <keep_last_manual_snapshot>¶: The number of latest manual snapshots that need to be retained for a cluster.

cluster¶: ID or Name of the DWS cluster(s) to be deleted.

This command is provided by the otcextensions plugin.

dws cluster list¶

List DWS Clusters.

openstack dws cluster list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

dws cluster password reset¶

Reset the password of cluster administrator.

openstack dws cluster password reset --password <password> <cluster>

--password <password>¶: New password of the GaussDB(DWS) cluster administrator. A password must conform to the following rules: - Contains 8 to 32 characters. - Cannot be the same as the username or the username written in reverse order. - Contains at least three types of the following: - > Lowercase letters - > Uppercase letters - > Digits - > Special characters - Cannot be the same as previous passwords. - Cannot be a weak password.

cluster¶: ID or Name of the DWS cluster to be restart.

This command is provided by the otcextensions plugin.

dws cluster restart¶

Restart a DWS cluster

openstack dws cluster restart [--wait] [--timeout <timeout>] <cluster>

--wait¶: Wait for the Cluster restart action to complete.

--timeout <timeout>¶: Timeout for the wait in seconds. (Default 300 seconds)

cluster¶: ID or Name of the DWS cluster to be restart.

This command is provided by the otcextensions plugin.

dws cluster scale out¶

Scaling Out a Cluster with only Common Nodes.

openstack dws cluster scale out
    --add-nodes <add_nodes>
    [--wait]
    [--timeout <timeout>]
    <cluster>

--add-nodes <add_nodes>¶: Number of dws nodes to be scaled out.

--wait¶: Wait for the Cluster Scaling Task to complete.

--timeout <timeout>¶: Timeout for the wait in seconds. (Default 1800 seconds)

cluster¶: ID or Name of the DWS cluster to be extended.

This command is provided by the otcextensions plugin.

dws cluster show¶

Show details of a DWS cluster

openstack dws cluster show <cluster>

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

DWS Snapshot Operations¶

dws snapshot create¶

Create snapshot for a specified cluster.

openstack dws snapshot create
    [--description <description>]
    [--wait]
    [--timeout <timeout>]
    <cluster>
    <name>

--description <description>¶: Snapshot description. If no value is specified, the description is empty. Enter a maximum of 256 characters. The following special characters are not allowed: !<>’=&”

--wait¶: Wait for the Cluster snapshotting task to finish.

--timeout <timeout>¶: Timeout for the wait in seconds (Default 900 seconds).

cluster¶: ID or name of the cluster for which you want to create a snapshot.

name¶: Snapshot name, which must be unique and start with a letter. It consists of 4 to 64 characters, which are case-insensitive and contain letters, digits, hyphens (-), and underscores (_) only.

This command is provided by the otcextensions plugin.

dws snapshot delete¶

Delete specified manual snapshot(s).

openstack dws snapshot delete <snapshot> [<snapshot> ...]

snapshot¶: ID or Name of the Snapshot(s) to be deleted.

This command is provided by the otcextensions plugin.

dws snapshot list¶

List DWS Backups.

openstack dws snapshot list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

dws snapshot restore¶

Restore clusters using the snapshot.

openstack dws snapshot restore
    --snapshot-id <snapshot_id>
    [--availability-zone <availability_zone>]
    [--router-id <router_id>]
    [--network-id <network_id>]
    [--security-group-id <security_group_id>]
    [--port <port>]
    [--floating-ip <floating_ip>]
    [--enterprise-project-id <enterprise_project_id>]
    [--wait]
    [--timeout <timeout>]
    <name>

--snapshot-id <snapshot_id>¶: ID of the snapshot to be restored.

--availability-zone <availability_zone>¶: AZ of a cluster. The default value is the same as that of the original cluster.

--router-id <router_id>¶: Router ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.

--network-id <network_id>¶: Network ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.

--security-group-id <security_group_id>¶: Security group ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.

--port <port>¶: Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.

--floating-ip <floating_ip>¶: Public IP address. If the parameter is not specified, public connection is not used by default. Possible values can be: - “auto” - To automatically assign Floating IP. - “ID” or “IP” of existing floating ip.

--enterprise-project-id <enterprise_project_id>¶: Enterprise project. The default enterprise project ID is 0.

--wait¶: Wait for the status of Restored cluster to be available.

--timeout <timeout>¶: Timeout for the wait in seconds (Default 1800 seconds).

name¶: Cluster Name.

This command is provided by the otcextensions plugin.

dws snapshot show¶

Show details of a DWS snapshot.

openstack dws snapshot show <snapshot>

snapshot¶: Snapshot name or ID.

This command is provided by the otcextensions plugin.

DWS Flavor Operations¶

dws flavor list¶

List Flavors (Node Types) of a DWS Cluster

openstack dws flavor list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

last updated: 2023-06-12 09:35