TailorDB Commands

Commands for managing TailorDB tables, data, and schema migrations.

tailordb

Manage TailorDB tables and data.

Usage

tailor tailordb <command>

See Global Options for options available to all commands.

Commands

Command	Description
`tailordb truncate`	Truncate (delete all records from) TailorDB tables.
`tailordb migration`	Manage TailorDB schema migrations.

tailordb truncate

Truncate (delete all records from) TailorDB tables.

Usage

tailor tailordb truncate [options] [types]

Arguments

Argument	Description	Required
`types`	Type names to truncate	No

Options

Option	Alias	Description	Required	Default	Env
`--workspace-id <WORKSPACE_ID>`	`-w`	Workspace ID	No	-	`TAILOR_PLATFORM_WORKSPACE_ID`
`--profile <PROFILE>`	`-p`	Workspace profile	No	-	`TAILOR_PLATFORM_PROFILE`
`--config <CONFIG>`	`-c`	Path to Tailor config file	No	`"tailor.config.ts"`	`TAILOR_CONFIG_PATH`
`--yes`	`-y`	Skip confirmation prompts	No	`false`	-
`--all`	`-a`	Truncate all tables in all owned namespaces (excludes external namespaces)	No	`false`	-
`--namespace <NAMESPACE>`	`-n`	Truncate all tables in specified namespace	No	-	-

See Global Options for options available to all commands.

Usage Examples:

bash

# Truncate all tables in all namespaces (requires confirmation)
tailor tailordb truncate --all

# Truncate all tables in all namespaces (skip confirmation)
tailor tailordb truncate --all --yes

# Truncate all tables in a specific namespace
tailor tailordb truncate --namespace myNamespace

# Truncate specific types (namespace is auto-detected)
tailor tailordb truncate User Post Comment

# Truncate specific types with confirmation skipped
tailor tailordb truncate User Post --yes

Notes:

You must specify exactly one of: --all, --namespace, or type names
When truncating specific types, the namespace is automatically detected from your config
Confirmation prompts vary based on the operation:
- --all: requires typing truncate all
- --namespace: requires typing truncate <namespace-name>
- Specific types: requires typing yes
Use --yes flag to skip confirmation prompts (useful for scripts and CI/CD)
Namespaces declared with { external: true } are skipped by --all and rejected with a dedicated error when targeted by --namespace. Run truncate from the app that owns the namespace.

tailordb migration

Manage TailorDB schema migrations.

Note: Migration scripts are automatically executed during tailor deploy. See Automatic Migration Execution for details.

Usage

tailor tailordb migration <command>

Commands

Command	Description
`tailordb migration generate`	Generate migration files by detecting schema differences between current local types and the previous migration snapshot.
`tailordb migration rebaseline`	Collapse the full migration history into a new 0000 baseline.
`tailordb migration script`	Add a migration script (migrate.ts) template to an existing migration directory, or record with --no-script that a migration intentionally has none.
`tailordb migration set`	Set migration checkpoint to a specific number.
`tailordb migration status`	Show the current migration status for TailorDB namespaces, including applied and pending migrations.
`tailordb migration sync`	Sync remote TailorDB schema to a specific migration snapshot (recovery from --no-schema-check drift).
`tailordb migration test`	Test pending migrations with seed fixtures or cloned data in a temporary workspace.
`tailordb migration validate`	Validate the full migration history, unreviewed generated migration scripts, and schema drift (local types vs. migration snapshot, remote schema vs. migration checkpoint) without deploying. This includes the migration and schema-drift checks used by 'deploy' and exits with a non-zero code when issues are found.

See Global Options for options available to all commands.

tailordb migration generate

Generate migration files by detecting schema differences between current local types and the previous migration snapshot.

Usage

tailor tailordb migration generate [options]

Options

Option	Alias	Description	Required	Default	Env
`--yes`	`-y`	Skip confirmation prompts	No	`false`	-
`--config <CONFIG>`	`-c`	Path to Tailor config file	No	`"tailor.config.ts"`	`TAILOR_CONFIG_PATH`
`--name <NAME>`	`-n`	Optional description for the migration	No	-	-
`--init`	-	Delete existing migrations and start fresh	No	`false`	-
`--rename <RENAME>`	-	Record a field rename instead of remove + add (format: "Type.oldField:newField"; repeatable). Renames require a migration script that copies the data.	No	-	-
`--drop <DROP>`	-	Confirm that a removed field is a genuine removal, not a rename (format: "Type.field"; repeatable). Required in non-interactive runs for a removed field with rename candidates.	No	-	-

See Global Options for options available to all commands.

tailordb migration rebaseline

Collapse the full migration history into a new 0000 baseline.

Usage

tailor tailordb migration rebaseline [options]

Options

Option	Alias	Description	Required	Default	Env
`--workspace-id <WORKSPACE_ID>`	`-w`	Workspace ID	No	-	`TAILOR_PLATFORM_WORKSPACE_ID`
`--profile <PROFILE>`	`-p`	Workspace profile	No	-	`TAILOR_PLATFORM_PROFILE`
`--config <CONFIG>`	`-c`	Path to Tailor config file	No	`"tailor.config.ts"`	`TAILOR_CONFIG_PATH`
`--yes`	`-y`	Skip confirmation prompts	No	`false`	-
`--namespace <NAMESPACE>`	`-n`	Target TailorDB namespace (required if multiple namespaces exist)	No	-	-

See Global Options for options available to all commands.

Notes

Re-baselining removes migrations after 0000 from the working tree, records a new migration history ID, and resets the connected workspace checkpoint without changing its schema or data. Every environment must already have applied the latest migration before you run this command.

tailordb migration script

Add a migration script (migrate.ts) template to an existing migration directory, or record with --no-script that a migration intentionally has none.

Usage

tailor tailordb migration script [options] <number>

Arguments

Argument	Description	Required
`number`	Migration number to add a script to (e.g., 0001 or 1)	Yes

Options

Option	Alias	Description	Required	Default	Env
`--config <CONFIG>`	`-c`	Path to Tailor config file	No	`"tailor.config.ts"`	`TAILOR_CONFIG_PATH`
`--namespace <NAMESPACE>`	`-n`	Target TailorDB namespace (required if multiple namespaces exist)	No	-	-
`--no-script`	-	Record that this migration intentionally runs without a migration script (requires --reason)	No	-	-
`--reason <REASON>`	-	Reason why no migration script is needed (used with --no-script)	No	-	-
`--with-test`	-	Also add a migrate.test.ts unit-test scaffold; when migrate.ts already exists, only the test is added	No	-	-

See Global Options for options available to all commands.

Notes

When migrate.ts already exists, running the command clears a previously recorded --no-script acknowledgment.

tailordb migration set

Set migration checkpoint to a specific number.

Usage

tailor tailordb migration set [options] <number>

Arguments

Argument	Description	Required
`number`	Migration number to set (e.g., 0001 or 1)	Yes

Options

Option	Alias	Description	Required	Default	Env
`--workspace-id <WORKSPACE_ID>`	`-w`	Workspace ID	No	-	`TAILOR_PLATFORM_WORKSPACE_ID`
`--profile <PROFILE>`	`-p`	Workspace profile	No	-	`TAILOR_PLATFORM_PROFILE`
`--config <CONFIG>`	`-c`	Path to Tailor config file	No	`"tailor.config.ts"`	`TAILOR_CONFIG_PATH`
`--yes`	`-y`	Skip confirmation prompts	No	`false`	-
`--namespace <NAMESPACE>`	`-n`	Target TailorDB namespace (required if multiple namespaces exist)	No	-	-

See Global Options for options available to all commands.

Notes

The migration number must be a 4-digit value (e.g. 0001) or a bare integer (e.g. 1) within 0–9999, and must exist in the local migration history; 0 is always accepted as the baseline, provided the local history passes validation. A gapped history is rejected.

Metadata lookup failures (authentication, permission, or network errors) are reported as errors; only a not-yet-deployed namespace is treated as having no checkpoint.

tailordb migration status

Show the current migration status for TailorDB namespaces, including applied and pending migrations.

Usage

tailor tailordb migration status [options]

Options

Option	Alias	Description	Required	Default	Env
`--workspace-id <WORKSPACE_ID>`	`-w`	Workspace ID	No	-	`TAILOR_PLATFORM_WORKSPACE_ID`
`--profile <PROFILE>`	`-p`	Workspace profile	No	-	`TAILOR_PLATFORM_PROFILE`
`--config <CONFIG>`	`-c`	Path to Tailor config file	No	`"tailor.config.ts"`	`TAILOR_CONFIG_PATH`
`--namespace <NAMESPACE>`	`-n`	Target TailorDB namespace (shows all namespaces if not specified)	No	-	-

See Global Options for options available to all commands.

Notes

Every local migration file is checked for a compatible format version, and deployed migration history IDs must match the local baseline. Compatibility errors, history mismatches, and metadata lookup failures are reported per namespace and make the command exit non-zero; only a not-yet-deployed namespace is treated as having no applied migrations.

tailordb migration sync

Sync remote TailorDB schema to a specific migration snapshot (recovery from --no-schema-check drift).

Usage

tailor tailordb migration sync [options] <number>

Arguments

Argument	Description	Required
`number`	Migration number to sync to (e.g., 0001 or 1; 0 targets the baseline snapshot)	Yes

Options

Option	Alias	Description	Required	Default	Env
`--workspace-id <WORKSPACE_ID>`	`-w`	Workspace ID	No	-	`TAILOR_PLATFORM_WORKSPACE_ID`
`--profile <PROFILE>`	`-p`	Workspace profile	No	-	`TAILOR_PLATFORM_PROFILE`
`--config <CONFIG>`	`-c`	Path to Tailor config file	No	`"tailor.config.ts"`	`TAILOR_CONFIG_PATH`
`--yes`	`-y`	Skip confirmation prompts	No	`false`	-
`--namespace <NAMESPACE>`	`-n`	Target TailorDB namespace (required if multiple namespaces exist)	No	-	-

See Global Options for options available to all commands.

tailordb migration test

Test pending migrations with seed fixtures or cloned data in a temporary workspace.

Usage

tailor tailordb migration test [options]

Options

Option	Alias	Description	Required	Default	Env
`--workspace-id <WORKSPACE_ID>`	`-w`	Workspace ID	No	-	`TAILOR_PLATFORM_WORKSPACE_ID`
`--profile <PROFILE>`	`-p`	Workspace profile	No	-	`TAILOR_PLATFORM_PROFILE`
`--config <CONFIG>`	`-c`	Path to Tailor config file	No	`"tailor.config.ts"`	`TAILOR_CONFIG_PATH`
`--yes`	`-y`	Acknowledge that a designated target workspace may be overwritten	No	`false`	-
`--data <DATA>`	-	Data source for the migration test (seed or clone)	No	`"seed"`	-
`--target-workspace-id <TARGET_WORKSPACE_ID>`	-	Existing throwaway workspace to retain after the test (requires --yes)	No	-	-
`--keep`	-	Keep the automatically created workspace after the test	No	`false`	-
`--assert <ASSERT>`	-	Path to a TypeScript assertion script to run after migrations	No	-	-
`--assert-namespace <ASSERT_NAMESPACE>`	-	TailorDB namespace exposed to the assertion script	No	-	-
`--machine-user <MACHINE_USER>`	-	Machine user for seed and assertion script execution	No	-	-

See Global Options for options available to all commands.

Notes

The source workspace is read-only. Without --target-workspace-id, the command creates a workspace in the source workspace's region and deletes it after success or failure; pass --keep to retain it for inspection. A designated target is retained and requires --yes. Clone mode copies TailorDB records only; it does not copy IdP users or file blobs.

tailordb migration validate

Validate the full migration history, unreviewed generated migration scripts, and schema drift (local types vs. migration snapshot, remote schema vs. migration checkpoint) without deploying. This includes the migration and schema-drift checks used by 'deploy' and exits with a non-zero code when issues are found.

Usage

tailor tailordb migration validate [options]

Options

Option	Alias	Description	Required	Default	Env
`--workspace-id <WORKSPACE_ID>`	`-w`	Workspace ID	No	-	`TAILOR_PLATFORM_WORKSPACE_ID`
`--profile <PROFILE>`	`-p`	Workspace profile	No	-	`TAILOR_PLATFORM_PROFILE`
`--config <CONFIG>`	`-c`	Path to Tailor config file	No	`"tailor.config.ts"`	`TAILOR_CONFIG_PATH`
`--namespace <NAMESPACE>`	`-n`	Target TailorDB namespace (validates all namespaces if not specified)	No	-	-
`--strict`	-	Also fail when a pending migration can drop data without an acknowledgment	No	`false`	-

See Global Options for options available to all commands.

See also: For migration concepts, configuration, workflow, and troubleshooting, see the TailorDB Migrations guide.

tailordb erd

The tailordb erd commands (export, diff, serve, deploy) are provided by the @tailor-platform/sdk-plugin-tailordb-erd CLI plugin. Install it next to the SDK and keep running tailor tailordb erd <command> as before:

bash

npm install -D @tailor-platform/sdk-plugin-tailordb-erd
tailor tailordb erd export --namespace myNamespace

See the plugin's README for the full command reference.

TailorDB Commands ​

tailordb ​

tailordb truncate ​

tailordb migration ​

tailordb migration generate ​

tailordb migration rebaseline ​

tailordb migration script ​

tailordb migration set ​

tailordb migration status ​

tailordb migration sync ​

tailordb migration test ​

tailordb migration validate ​

tailordb erd ​

TailorDB Commands

tailordb

tailordb truncate

tailordb migration

tailordb migration generate

tailordb migration rebaseline

tailordb migration script

tailordb migration set

tailordb migration status

tailordb migration sync

tailordb migration test

tailordb migration validate

tailordb erd