Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Set up init

kater init schema-sync

Syncs the schemas that you select into Kater.

This is step 2 of kater init. It saves your selection in the connection’s connection.yaml, then writes the DB datasets and Kater datasets of their tables.

Examples

Terminal window
# Sync one schema, and do not profile its columns
kater init schema-sync --schema DEMO_DB.ANALYTICS_AD_REPORTING --no-profile-columns
# Sync two schemas, and profile each column
kater init schema-sync --schema DEMO_DB.ANALYTICS_AD_REPORTING --schema DEMO_DB.ANALYTICS_VELIR_GA4 --profile-columns

Options

OptionDescription
--schema <database.schema>Required. A schema to sync, as its database and its schema with a dot between them, such as DEMO_DB.ANALYTICS_AD_REPORTING. kater init schemas lists them. You can give it more than one time.
--no-profile-columns, --profile-columnsRequired. Profiles each column, or does not. Profiling marks each column as a label, or as an amount or a time. It queries each column one time, so it uses warehouse credits.

It also takes --help.

The sync job

  • The command waits for the job to finish, 9 minutes at most. When the job still runs after that, run kater init status --wait.
  • You cannot change the schemas while a job of the setup runs.
  • A new selection sets the first query step back to pending. Run kater init first-query again after it.

It needs the settings:manage permission.

See also