Skip to main content
Use audit before adopting an existing schema or provider-specific tree. The report shows what supaschema can model and which statements are outside the supported contract.

​
Use this when

  • You are onboarding a database into declarative management.
  • Unsupported DDL should be known before the first generated migration.
  • A support-matrix report belongs in migration planning.
  • CI needs JSON coverage output.

​
Run it

npx supaschema audit --from dir:database/schemas
npx supaschema audit --from "database:$DATABASE_URL"
npx supaschema audit --from dir:database/schemas --json

​
Flags

​
--from
source
Required source to audit against the support matrix.
​
--json
boolean
Print the audit report as JSON.

​
Exit codes

CodeMeaning
0Source is fully supported
1Runtime failure
2Unsupported coverage was found

Support matrix

Review modeled PostgreSQL objects.

Inspect

Print extracted model details.

Declarative management

Adopt schema files as source of truth.

Explain

Decode unsupported diagnostic codes.
Last modified on June 16, 2026