tb deployment¶
Deploys your project to the Tinybird platform. Run using --cloud to deploy to Tinybird Cloud.
Global options apply to this command. See Global options.
The following subcommands are available:
| Subcommand | Description |
|---|---|
| create [OPTIONS] | Validates and deploys the project in Tinybird. |
| ls | Lists all the deployments of your project. |
| promote | Promotes last deploy to ready and remove old one. Accepts the --wait / --no-wait option. |
| discard | Discards the last deployment. Accepts the --wait / --no-wait option. |
tb deployment create¶
Validates and deploys the project in Tinybird. Run using --cloud to deploy to Tinybird Cloud. When deploying to Tinybird Cloud, the command shows the URL of the deployment.
| Option | Description |
|---|---|
| --wait / --no-wait | Waits for the deployment to finish. Defaults to not waiting. |
| --auto / --no-auto | Automatically promotes the deployment. Only works if --wait is used. |
| --check / --no-check | Validates the deployment before creating it. Disabled by default. |
| --allow-destructive-operations / --no-allow-destructive-operations | Allows destructive operations, like removing data sources, dropping historical data from tables, and so on. Disabled by default. |
| --template TEXT | Deploy from a template name or URL. If a URL is provided, it should point to a valid Tinybird project template. |
| -v, --verbose | Shows verbose output. Disabled by default. |
Removing data sources is an irreversible operation. Be careful when using the --allow-destructive-operations flag.
The --check flag validates external connections to S3, Kafka, GCS, and databases referenced via table functions. For local success, set connection secrets with tb secret set and use tb local start --use-aws-creds for S3 connections.
tb deployment ls¶
Lists the deployments of your project.
| Option | Description |
|---|---|
| --include-deleted | Includes deleted deployments. Disabled by default. |
tb deployment promote¶
Promotes the last deployment to ready and removes the old one.
| Option | Description |
|---|---|
| --wait / --no-wait | Waits for the promotion to finish. Defaults to not waiting. |
tb deployment discard¶
Discards the current staging deployment. Use this command to cancel an unfinished deployment. The previous live deployment remains active.
When you run tb deployment discard, the following happens:
- The current staging deployment is cancelled.
- The deployment resources associated with the staging deployment are removed.
- The previous live deployment remains active.
| Option | Description |
|---|---|
| --wait / --no-wait | Waits for the discard operation to finish. Defaults to not waiting. |
For example, if a deployment is taking a long time due to backfills, you can discard it:
tb deployment discard --wait
After discarding, the staging deployment and its resources are removed. Your project continues running on the previous live deployment.
Environment support¶
| Environment | Supported | Description |
|---|---|---|
--local | ✓ Yes (default) | Manages deployments locally. |
--cloud | ✓ Yes | Manages deployments in Tinybird Cloud. |
--branch=BRANCH_NAME | ✓ Yes | Manages deployments in a branch. |