tcb db

Manage the database in PG mode and classic mode: SQL execution, schema migrations, data models, the document database, and MySQL.

Command index

Command	Purpose
`tcb db execute`	Execute SQL statements
`tcb db pg migration new`	Create a migration file
`tcb db pg migration fetch`	Fetch remote migration files
`tcb db pg migration list`	List migration status
`tcb db pg migration up`	Preview or apply pending migrations
`tcb db pg migration repair`	Repair migration history without executing SQL

Migration conventions:

Migration files live in cloudbase/migrations/ under the project directory
File name format is <version>_<name>.sql, where version is a 14-digit UTC timestamp and name allows lowercase letters and underscores only
migration new creates the directory when missing; migration up and migration repair fail if the directory is missing
Every subcommand except migration new requires -e/--env-id; all subcommands check the login state first
--json is a global option and outputs structured JSON for scripts and CI

Command	Purpose
`tcb db model list`	List cloud data models
`tcb db model pull`	Pull models from the cloud
`tcb db model push`	Push local models to the cloud

See Data model overview for the full introduction.

Command	Purpose
`tcb db nosql execute`	Execute database native commands
`tcb db nosql dump`	Export collection data
`tcb db nosql restore-time`	Query the restorable time range
`tcb db nosql restore-tables`	Query restorable collections
`tcb db nosql restore`	Run a restore
`tcb db nosql restore-task`	Query restore task progress

Enable the document database in the CloudBase console before use.

Command	Purpose
`tcb db instance list`	List MySQL instances
`tcb db instance config`	Query or change instance configuration
`tcb db monitor slow-log`	View slow query logs
`tcb db instance restart`	Restart an instance
`tcb db backup list`	List backups
`tcb db backup create`	Create a backup
`tcb db backup restore`	Restore a backup
`tcb db backup delete`	Delete a backup

tcb db execute takes different parameters in PG mode and in MySQL, see Execute SQL
The document database uses tcb db nosql execute, not tcb db execute
Data models, the document database, and MySQL are available in classic mode only
PG migrations can run declaratively through tcb deploy, see Configuration file