Documentation

ucat documentation

The pages below are Markdown files in the repository; they open on GitHub.

Start here

• Getting startedInstall, authenticate and run your first plan in five minutes.
• ConceptsDesired state, live state, no state file, one file per table, renames, drops.
• Project layoutucat.yml, catalogs, targets and the tables directory.

Reference

• Table YAMLEvery field: columns, types, clustering, table properties, comments, nullability.
• Commandsinit, validate, plan, apply, drop, pull, version: flags, exit codes, JSON output.
• Authentication and permissionsCredential chain, priorities, minimum permissions, SQL warehouse.

Guides

• CI/CDRunning ucat in pipelines, exit codes, service principals, GitHub Actions example.
• TroubleshootingCommon errors and what to do about them.
• FAQTerraform, manual edits, rollback, shared schemas.
• Comparisonucat next to Terraform, Bundles and Lakeflow, dbt, Atlas and notebooks.

Limits and project

• LimitationsWhat v1 does and does not do.
• RoadmapWhat is planned after v1 and how priorities are set.
• ContributingHow to build, test and send a change; the architecture is in docs/contributing.