数据模型管理

云开发提供了强大的「数据模型」功能,支持通过 CloudBase CLI 进行高效的数据模型管理。本文将详细介绍如何使用 CLI 工具进行数据模型的查看、拉取和推送操作。

数据模型功能详细介绍请参考 数据模型概述

命令变更说明

以下顶层命令已废弃，请迁移到新的 db model 子命令：

旧命令（废弃）	新命令（推荐）
tcb db list	tcb db model list
tcb db pull	tcb db model pull
tcb db push	tcb db model push

旧命令保留向后兼容，但在输出中会显示废弃提示。

查看数据模型

基本用法

使用以下命令列出云端所有数据模型,查看模型的基本信息:

# 推荐用法
tcb db model list -e your-env-id

# 兼容旧命令（已废弃）
tcb db list -e your-env-id

命令参数

Usage: tcb db list [options]

列出云端所有数据模型

Options:
  -e, --env-id <envId>  指定环境 Id
  -h, --help           查看命令帮助信息

参数说明:

• -e, --env-id:指定要查询的云开发环境 ID,不指定时会提示选择

拉取数据模型

基本用法

通过以下命令从云端拉取数据模型到本地:

# 推荐用法
tcb db model pull -e your-env-id

# 拉取指定模型
tcb db model pull -n sys_user,itinerary -e your-env-id

# 拉取到指定目录
tcb db model pull -d ./models -e your-env-id

# 兼容旧命令（已废弃）
tcb db pull -e your-env-id

生成的文件

拉取完成后,会在项目中生成以下文件:

• 模型定义文件:database-schemas/{模型标识}.json - 包含数据模型的完整定义
• 类型定义文件:cloud-models.d.ts - TypeScript 类型定义,支持 IDE 智能提示

命令参数

Usage: tcb db pull [options]

从云端拉取多个数据模型到本地

Options:
  -e, --env-id <envId>  环境 Id
  -d, --dir <dir>      本地存储数据库模型定义的目录,默认为 database-schemas
  -n, --name <name>    要拉取的模型英文标识列表,可指定多个,使用逗号分隔。不指定时默认拉取所有模型
  -h, --help           查看命令帮助信息

推送数据模型

基本用法

使用以下命令将本地的数据模型推送到云端:

# 推荐用法
tcb db model push -e your-env-id

# 推送指定模型
tcb db model push -n sys_user,product -e your-env-id

# 从指定目录推送
tcb db model push -d ./models -e your-env-id

# 兼容旧命令（已废弃）
tcb db push -e your-env-id

命令参数

Usage: tcb db push [options]

将本地数据模型推送到云端

Options:
  -e, --env-id <envId>  环境 Id
  -d, --dir <dir>      本地存储数据库模型定义的目录,默认为 database-schemas
  -n, --name <name>    要推送的模型名称列表,可指定多个,使用逗号分隔。不指定时默认推送本地目录下的所有数据模型
  -h, --help           查看命令帮助信息

参数说明:

• -d, --dir:指定本地模型文件目录
• -n, --name:指定要推送的模型,支持批量推送