Change8

rel_1_17_1

Breaking Changes
📦 alembicView on GitHub →
1 breaking1 features🐛 1 fixes🔧 3 symbols

Summary

Version 1.17.1 introduces a new `--check-heads` option for `alembic current` and tightens revision ID validation by rejecting ':' characters, requiring migration of any existing colon‑containing IDs.

⚠️ Breaking Changes

  • Custom revision identifiers may no longer contain ':'; existing revisions that include ':' will cause errors. Rename such revisions to remove ':' and update any references in migration scripts.

Migration Steps

  1. Search for revision IDs containing ':' in your Alembic history, rename them to IDs without ':', and update any scripts or dependencies that reference the old IDs.

✨ New Features

  • Added `command.current.check_heads` parameter to `command.current()` (exposed via `--check-heads` CLI option) to verify that all head revisions are applied, raising `DatabaseNotAtHead` on mismatch.

🐛 Bug Fixes

  • Disallowed ':' character in custom revision identifiers to prevent conflicts with revision range syntax.

🔧 Affected Symbols

alembic.command.currentalembic.command.current.check_headsalembic.revision