Skip to content
On this page

JSON Schema

json

Output one file per table or a single bundled file (default: bundled)

Usage

Add to your sqldoc.config.ts:

typescript
export default {
  dialect: 'postgres',
  schema: ['./schema.sql'],
  codegen: [
    {
      template: 'json-schema',
      output: './generated/schema.json',
      config: {
        // See configuration options below
      },
    },
  ],
}

Then run:

bash
sqldoc codegen