Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

twc-rs database

Manage databases

SubcommandDescription
listList all databases
infoShow detailed info for a database
createCreate a new database
deleteDelete a database by ID
updateUpdate database settings
backup-listList backups for a database
backup-createCreate a backup for a database
user-listList users for a database
user-createCreate a user for a database
user-deleteDelete a user from a database
preset-listList available database presets
list-typesList available database cluster types (engines and versions)
list-instancesList individual database instances within a cluster

twc-rs database list

List all databases

ArgumentDescriptionRequiredEnvDefault
--limitMaximum number of databases to return
--offsetNumber of databases to skip
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database info

Show detailed info for a database

ArgumentDescriptionRequiredEnvDefault
--idDatabase IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database create

Create a new database

ArgumentDescriptionRequiredEnvDefault
--nameDatabase nameyes
--typeDatabase engine type (mysql, postgres, redis, mongodb, opensearch, clickhouse, kafka, rabbitmq)yes
-p, --preset-idPreset ID for the databaseyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database delete

Delete a database by ID

ArgumentDescriptionRequiredEnvDefault
--idDatabase IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database update

Update database settings

ArgumentDescriptionRequiredEnvDefault
--idDatabase IDyes
--nameNew database name
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database backup-list

List backups for a database

ArgumentDescriptionRequiredEnvDefault
--idDatabase IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database backup-create

Create a backup for a database

ArgumentDescriptionRequiredEnvDefault
--idDatabase IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database user-list

List users for a database

ArgumentDescriptionRequiredEnvDefault
--idDatabase IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database user-create

Create a user for a database

ArgumentDescriptionRequiredEnvDefault
--db-idDatabase IDyes
--loginDatabase user login nameyes
--passwordDatabase user passwordyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database user-delete

Delete a user from a database

ArgumentDescriptionRequiredEnvDefault
--db-idDatabase IDyes
--user-nameDatabase user login nameyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database preset-list

List available database presets

ArgumentDescriptionRequiredEnvDefault
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database list-types

List available database cluster types (engines and versions)

ArgumentDescriptionRequiredEnvDefault
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE

twc-rs database list-instances

List individual database instances within a cluster

ArgumentDescriptionRequiredEnvDefault
--idDatabase cluster IDyes
-f, --formatOutput format: table (default), json, yaml, or quietTWC_OUTPUTtable
-t, --tokenAPI token override (overrides config file and TWC_TOKEN env)TWC_TOKEN
--profileUse a named profile’s token from the config fileTWC_PROFILE