Asqueel Migration

An autonomous Python library for SQL schema migrations: compare a normalized JSON description of a database (the contract) against a live database and generate or apply the realignment SQL. ORM-agnostic by design — any producer that emits the JSON contract can drive it.

Supported dialects: PostgreSQL, SQLite, MySQL, MSSQL.

The producer guide covers normalized input, reviewed plan_migration / apply_migration execution, connection ownership and the PostgreSQL CLI. HTTP, OpenAPI, MCP and backup/restore belong to the separate Asqueel DB Manager application.

Contents

• Producer Guide — describing your database
  • Compatibility is additive
  • 1. End-to-end quickstart (human JSON)
  • 2. The human JSON format
  • 3. The XML format
  • 4. dtype reference
  • 5. What NOT to emit (attribute cleaning)
  • 6. The normalized contract (advanced)
  • 7. Input ownership and repeated preparation
  • 8. Command-line interface
  • References
  • Dialect support
  • PostgreSQL 32-bit generated keys (unreleased)
• Dialect capabilities
  • PostgreSQL
  • SQLite
  • MySQL and SQL Server
  • Interpreting a plan
• Known limits
  • Additive comparison, removals and renames
  • Execution and concurrency
  • SQLite
  • PostgreSQL SERIAL4 and SERIAL8
  • PostgreSQL initial public schema
  • Other contract boundaries
• Development, typing and releases
  • Test environments
  • Typing policy
  • Documentation checks
  • Release checklist