twc-rs database
Manage databases
| Subcommand | Description |
|---|---|
list | List all databases |
info | Show detailed info for a database |
create | Create a new database |
delete | Delete a database by ID |
update | Update database settings |
backup-list | List backups for a database |
backup-create | Create a backup for a database |
user-list | List users for a database |
user-create | Create a user for a database |
user-delete | Delete a user from a database |
preset-list | List available database presets |
list-types | List available database cluster types (engines and versions) |
list-instances | List individual database instances within a cluster |
twc-rs database list
List all databases
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
--limit | Maximum number of databases to return | |||
--offset | Number of databases to skip | |||
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database info
Show detailed info for a database
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
--id | Database ID | yes | ||
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database create
Create a new database
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
--name | Database name | yes | ||
--type | Database engine type (mysql, postgres, redis, mongodb, opensearch, clickhouse, kafka, rabbitmq) | yes | ||
-p, --preset-id | Preset ID for the database | yes | ||
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database delete
Delete a database by ID
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
--id | Database ID | yes | ||
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database update
Update database settings
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
--id | Database ID | yes | ||
--name | New database name | |||
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database backup-list
List backups for a database
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
--id | Database ID | yes | ||
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database backup-create
Create a backup for a database
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
--id | Database ID | yes | ||
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database user-list
List users for a database
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
--id | Database ID | yes | ||
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database user-create
Create a user for a database
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
--db-id | Database ID | yes | ||
--login | Database user login name | yes | ||
--password | Database user password | yes | ||
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database user-delete
Delete a user from a database
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
--db-id | Database ID | yes | ||
--user-name | Database user login name | yes | ||
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database preset-list
List available database presets
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database list-types
List available database cluster types (engines and versions)
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |
twc-rs database list-instances
List individual database instances within a cluster
| Argument | Description | Required | Env | Default |
|---|---|---|---|---|
--id | Database cluster ID | yes | ||
-f, --format | Output format: table (default), json, yaml, or quiet | TWC_OUTPUT | table | |
-t, --token | API token override (overrides config file and TWC_TOKEN env) | TWC_TOKEN | ||
--profile | Use a named profile’s token from the config file | TWC_PROFILE |