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. It uses the same executable support contract as the support matrix (src/sql/support.ts) and extraction diagnostics.

​
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

​
Flags

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

​
Exit codes

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 24, 2026