Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Basic SQL migration tool favoring configuration over convention.

Project Description


Goose is a tool for managing and applying SQL Database Migrations.

Because our geese use SQLAlchemy to manage their migration tables you can connect to and migrate any database supported by SQLAlchemy.

Migrations are just plain SQL files and the order migrations are applied is specified through configuration in a YAML file.


First initialize your database by installing the migration_info table:

goose -d sqlite:///my.db -m migrations/ init

Now go ahead and migrate:

goose -d sqlite:///my.db -m migrations/ migrate

To find out what migrations have been applied you can do:

goose -d sqlite:///my.db -m migrations/ list


pip install pyyaml pip install sqlalchemy

And install whichever DB API driver you need for your specific DB:

pip install psycopg2

Project Layout

Assuming you have a project you want to add migrations to in a directory like this:

`-- package

You could add migrations like this:

|-- package/
|   |--
|   `--
`-- migrations/
    |-- create_user_tables.sql
    |-- db_skeleton.sql
    |-- index.yaml
    `-- update_users.sql

The contents of index.yaml would look like:

  - db_skeleton.sql
  - create_user_tables.sql
  - update_users.sql
Release History

Release History

This version
History Node


Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting