tcb db model pull
Pull data models from the cloud to your local project.
Usage
tcb db model pull [options] -e <envId>
Parameters
| Parameter | Required | Description | Default |
|---|---|---|---|
-e, --env-id <envId> | No | Environment ID | — |
-d, --dir <dir> | No | Local directory for model definitions, resolved against the current directory | database-schemas under the project directory |
-n, --name <name> | No | Comma-separated model identifiers to pull, all models when omitted | All |
Examples
# Pull all models
tcb db model pull -e your-env-id
# Pull specific models
tcb db model pull -n sys_user,itinerary -e your-env-id
# Pull to a specific directory
tcb db model pull -d ./models -e your-env-id
Generated files
- Model definition files:
database-schemas/{modelId}.json, containing the full model definition - Type definition file:
cloud-models.d.ts, TypeScript types that enable IDE hints