Import: Postgres

Creates a data contract from a Postgres schema by reading table metadata from information_schema — including column types with length and precision, nullability, primary keys, and the comments stored in pg_description. Works with Postgres and Postgres-compatible databases (e.g. RisingWave).

datacontract import postgres \
  --source localhost \
  --database postgres \
  --schema public \
  --output datacontract.yaml

--source is the host of your Postgres server. Add --port if it doesn't listen on the default 5432, and repeat --table to import only specific tables (by default every table and view in the schema is imported). --schema defaults to public.

The generated contract includes a ready-to-test servers block, so you can run datacontract test datacontract.yaml immediately afterwards — see the Postgres connection guide for the full 5-minute walkthrough and troubleshooting.

Credentials are provided as environment variables and are the same ones datacontract test uses: DATACONTRACT_POSTGRES_USERNAME and DATACONTRACT_POSTGRES_PASSWORD — see the Postgres Reference.

Working from a DDL file instead of a live database? Use datacontract import sql --dialect postgres.