pg-idempotent 0.2.0

Transform PostgreSQL migrations into idempotent versions that can be run multiple times without errors. Includes native Supabase integration.

PG Idempotent

Transform PostgreSQL migrations into idempotent versions that can be safely run multiple times without errors. Includes native Supabase integration!

What It Does

• Makes SQL migrations safe to re-run - No more broken deployments from partial migration failures
• Native Supabase support - Automatically detects and processes Supabase migration files
• Preserves original functionality - Adds safety checks without changing behavior
• Works with any PostgreSQL setup - Supabase, raw PostgreSQL, Docker, etc.

Quick Start

Installation

# Basic installation (core functionality)
pip install pg-idempotent

# With all optional features (test generation, validation, etc.)
pip install pg-idempotent[all]

For Supabase Projects

# Check your migration files
pg-idempotent supabase check

# Fix them to be idempotent
pg-idempotent supabase fix

# Now safely deploy
supabase db push

For General PostgreSQL

# Transform a single file
pg-idempotent transform migration.sql

# Process multiple files
pg-idempotent batch migrations/ --recursive

CLI Commands

pg-idempotent --help

Contributing

Prerequisites

1. Generate an SSH key and add the SSH key to your GitHub account.

2. Configure SSH to automatically load your SSH keys:

   cat << EOF >> ~/.ssh/config
   
   Host *
     AddKeysToAgent yes
     IgnoreUnknown UseKeychain
     UseKeychain yes
     ForwardAgent yes
   EOF
   

3. Install Docker Desktop.

4. Install VS Code and VS Code's Dev Containers extension. Alternatively, install PyCharm.

5. Optional: install a Nerd Font such as FiraCode Nerd Font and configure VS Code or PyCharm to use it.

Development environments

The following development environments are supported:

1. ⭐️ GitHub Codespaces: click on Open in GitHub Codespaces to start developing in your browser.

2. ⭐️ VS Code Dev Container (with container volume): click on Open in Dev Containers to clone this repository in a container volume and create a Dev Container with VS Code.

3. ⭐️ uv: clone this repository and run the following from root of the repository:

   # Create and install a virtual environment
   uv sync --python 3.10 --all-extras
   
   # Activate the virtual environment
   source .venv/bin/activate
   
   # Install the pre-commit hooks
   pre-commit install --install-hooks
   

4. VS Code Dev Container: clone this repository, open it with VS Code, and run Ctrl/⌘ + ⇧ + P → Dev Containers: Reopen in Container.

5. PyCharm Dev Container: clone this repository, open it with PyCharm, create a Dev Container with Mount Sources, and configure an existing Python interpreter at /opt/venv/bin/python.

Developing

• This project follows the Conventional Commits standard to automate Semantic Versioning and Keep A Changelog with Commitizen.
• Run poe from within the development environment to print a list of Poe the Poet tasks available to run on this project.
• Run uv add {package} from within the development environment to install a run time dependency and add it to pyproject.toml and uv.lock. Add --dev to install a development dependency.
• Run uv sync --upgrade from within the development environment to upgrade all dependencies to the latest versions allowed by pyproject.toml. Add --only-dev to upgrade the development dependencies only.
• Run cz bump to bump the package's version, update the CHANGELOG.md, and create a git tag. Then push the changes and the git tag with git push origin main --tags.

📦pg-idempotent ┣ 📂.devcontainer ┃ ┗ 📜devcontainer.json ┣ 📂.github ┃ ┣ 📂workflows ┃ ┃ ┣ 📜publish.yml ┃ ┃ ┗ 📜test.yml ┃ ┗ 📜dependabot.yml ┣ 📂.shrimpy ┃ ┗ 📜tasks.json ┃ ┗ 📜simple.sql ┣ 📂scripts ┃ ┣ 📜README.md ┃ ┣ 📜__init__.py ┃ ┣ 📜benchmark_generator.py ┃ ┣ 📜check_fireworks_models.py ┃ ┗ 📜generate_sql_tests_parallel.py ┣ 📂src ┃ ┗ 📂pg_idempotent ┃ ┃ ┣ 📂__pycache__ ┃ ┃ ┃ ┣ 📜__init__.cpython-312.pyc ┃ ┃ ┃ ┗ 📜cli.cpython-312.pyc ┃ ┃ ┣ 📂cli ┃ ┃ ┣ 📂parser ┃ ┃ ┣ 📂transformer ┃ ┃ ┣ 📂utils ┃ ┃ ┣ 📜__init__.py ┃ ┃ ┗ 📜cli.py ┣ 📂tests ┃ ┣ 📂fixtures ┃ ┣ 📂integration ┃ ┣ 📂unit ┃ ┣ 📜__init__.py ┃ ┣ 📜test_cli.py ┃ ┗ 📜test_import.py ┣ 📜.copier-answers.yml ┣ 📜.dockerignore ┣ 📜.gitignore ┣ 📜.pre-commit-config.yaml ┣ 📜DEVELOPMENT_GUIDE.md ┣ 📜Dockerfile ┣ 📜README.md ┣ 📜docker-compose.yml ┣ 📜justfile ┣ 📜pyproject.toml ┣ 📜quickstart.sh ┗ 📜uv.lock