Skip to content
HALOWERK

Codewerk

ddl diff migrate

Parses old and new DDL (CREATE TABLE, CREATE INDEX and pg_dump-style ALTER TABLE . ADD CONSTRAINT) and diffs tables, columns, constraints and indexes. Changes are emitted with the low-lock patterns of the squawk documentation (Apache-2.0): CREATE INDEX CONCURRENTLY, UNIQUE/PRIMARY KEY via CREATE UNIQUE INDEX CONCURRENTLY . USING INDEX, foreign keys and checks as NOT VALID plus VALIDATE, SET NOT NULL via a validated CHECK (PostgreSQL 12+), ADD COLUMN with non-volatile defaults in one step.

POST https://code.halowerk.com/v1/ddl-diff-migrate

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
old_ddlstringYesCurrent schema DDL (may be empty).
new_ddlstringYesTarget schema DDL.
renamesarrayNo
include_destructivebooleanNoEmit DROP COLUMN / DROP TABLE as executable statements.
pg_versionintegerNo
lock_timeoutstringNo
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "old_ddl",
    "new_ddl"
  ],
  "properties": {
    "old_ddl": {
      "type": "string",
      "maxLength": 1000000,
      "description": "Current schema DDL (may be empty)."
    },
    "new_ddl": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000000,
      "description": "Target schema DDL."
    },
    "renames": {
      "type": "array",
      "maxItems": 50,
      "default": [],
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "table",
          "from",
          "to"
        ],
        "properties": {
          "table": {
            "type": "string",
            "maxLength": 130
          },
          "from": {
            "type": "string",
            "maxLength": 63
          },
          "to": {
            "type": "string",
            "maxLength": 63
          }
        }
      }
    },
    "include_destructive": {
      "type": "boolean",
      "default": false,
      "description": "Emit DROP COLUMN / DROP TABLE as executable statements."
    },
    "pg_version": {
      "type": "integer",
      "minimum": 10,
      "maximum": 19,
      "default": 16
    },
    "lock_timeout": {
      "type": "string",
      "pattern": "^[0-9]{1,6}(ms|s|min)$",
      "default": "5s"
    }
  }
}

Open original schema

Published input example

{
  "old_ddl": "CREATE TABLE users (id bigint PRIMARY KEY, email text NOT NULL);",
  "new_ddl": "CREATE TABLE users (id bigint PRIMARY KEY, email text NOT NULL, name text);\nCREATE INDEX users_email_idx ON users (email);"
}

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 โ†’