Skip to content
HALOWERK

Codewerk

pg migration safety

Splits a PostgreSQL migration into statements with its own tokenizer (dollar quotes, nested comments, BEGIN ATOMIC bodies) and checks every statement against the squawk rule set (docs at commit 0795f5e, 2026-10-31), for example adding-field-with-default, adding-not-nullable-field, constraint-missing-not-valid, changing-column-type, require-concurrent-index-creation, ban-drop-*, require-lock-timeout and transaction-nesting.

POST https://code.halowerk.com/v1/pg-migration-safety

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
sqlstringYesMigration SQL (PostgreSQL), one or more statements.
pg_versionintegerNoTarget PostgreSQL major version (affects DEFAULT rewrite and SET NOT NULL rules).
assume_in_transactionbooleanNoSet true if the migration tool wraps the file in a transaction.
ignore_rulesarrayNoRule ids to skip.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "sql"
  ],
  "properties": {
    "sql": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500000,
      "description": "Migration SQL (PostgreSQL), one or more statements."
    },
    "pg_version": {
      "type": "integer",
      "minimum": 10,
      "maximum": 19,
      "default": 16,
      "description": "Target PostgreSQL major version (affects DEFAULT rewrite and SET NOT NULL rules)."
    },
    "assume_in_transaction": {
      "type": "boolean",
      "default": false,
      "description": "Set true if the migration tool wraps the file in a transaction."
    },
    "ignore_rules": {
      "type": "array",
      "maxItems": 40,
      "items": {
        "type": "string",
        "maxLength": 60
      },
      "default": [],
      "description": "Rule ids to skip."
    }
  }
}

Open original schema

Published input example

{
  "sql": "ALTER TABLE users ADD COLUMN token uuid DEFAULT gen_random_uuid();\nCREATE INDEX users_email_idx ON users (email);",
  "pg_version": 16
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’