跳到主要内容

tcb db

管理 PG 模式与传统模式的数据库：SQL 执行、结构迁移、数据模型、文档型数据库与 MySQL。

命令索引​

PG 模式​

命令用途
tcb db execute执行 SQL 语句
tcb db pg migration new创建迁移文件
tcb db pg migration fetch拉取远端迁移文件
tcb db pg migration list查看迁移状态
tcb db pg migration up预览或执行待应用的迁移
tcb db pg migration repair修复迁移历史记录，不执行 SQL

迁移约定：

  • 本地迁移目录固定为项目目录下的 cloudbase/migrations/
  • 文件名格式为 <version>_<name>.sql，version 是 14 位 UTC 时间戳，name 仅允许小写字母和下划线
  • 目录不存在时 migration new 自动创建；migration up 与 migration repair 在目录缺失时直接报错
  • 除 migration new 外，其余子命令均需指定 -e/--env-id；所有子命令执行前检查登录态
  • --json 是全局选项，输出结构化 JSON，适合脚本和持续集成场景

传统模式 · 数据模型​

命令用途
tcb db model list列出云端数据模型
tcb db model pull从云端拉取模型到本地
tcb db model push将本地模型推送到云端

数据模型的完整介绍见数据模型概述。

传统模式 · 文档型数据库​

命令用途
tcb db nosql execute执行数据库原生命令
tcb db nosql dump导出集合数据
tcb db nosql restore-time查询可回档时间范围
tcb db nosql restore-tables查询可回档的集合
tcb db nosql restore执行回档
tcb db nosql restore-task查询回档任务进度

使用前需要在 CloudBase 控制台 开通文档型数据库服务。

传统模式 · 关系型数据库 MySQL​

命令用途
tcb db instance list列出 MySQL 实例
tcb db instance config查询或修改实例配置
tcb db monitor slow-log查看慢查询日志
tcb db instance restart重启实例
tcb db backup list列出备份记录
tcb db backup create创建备份
tcb db backup restore恢复备份
tcb db backup delete删除备份

说明​

  • tcb db execute 在 PG 模式与 MySQL 中的参数不同，用前先看执行 SQL
  • 文档型数据库用 tcb db nosql execute，不是 tcb db execute
  • 数据模型、文档型数据库、MySQL 只在传统模式可用
  • PG 模式的迁移可由 tcb deploy 声明式执行，配置见配置文件

已废弃​

命令替代
tcb db listtcb db model list
tcb db pulltcb db model pull
tcb db pushtcb db model push