Exporting Schema¶

By default, crdb-dump export writes the full database DDL to crdb_dump_output/<db>/<db>_schema.sql.

Full-database DDL¶

For a whole-database export, crdb-dump uses CockroachDB's native bulk DDL:

crdb-dump export --db=mydb

It emits, in dependency order:

CREATE SCHEMA IF NOT EXISTS for every non-public schema,
SHOW CREATE ALL TYPES (enums),
SHOW CREATE ALL TABLES (sequences → tables → views, with foreign-key constraints split into trailing ALTER TABLE ... ADD CONSTRAINT ... VALIDATE).

This makes the resulting mydb_schema.sql safe to replay into a fresh database.

Output formats¶

crdb-dump export --db=mydb --format sql     # default
crdb-dump export --db=mydb --format json
crdb-dump export --db=mydb --format yaml

One file per object¶

crdb-dump export --db=mydb --per-table
# e.g. table_mydb.public.users.sql, type_mydb.public.status.sql

Selecting objects¶

# Include specific objects (table / schema.table / db.schema.table)
crdb-dump export --db=mydb --tables=public.users,cpkit.tasks

# Exclude specific objects
crdb-dump export --db=mydb --exclude-tables=public.audit_log

See the Naming Model for how names are interpreted.

Permissions¶

Add roles, grants, and role memberships with --include-permissions — see Permissions.