Skip to main content

SQL migrations for Postgres

Project description

SQL migrations for Postgres

PGPASSWORD=top-secret goose ./tests/master_migrations

(Assuming you have a Postgres server running on localhost:5432 with a high-entropy admin password)

Installation

pip install postgoose

Usage

usage: goose [-h] [--host HOST] [-p PORT] [-U USERNAME] [-d DBNAME]
             [-s SCHEMA] [-r ROLE] [--strict_digest_check STRICT_DIGEST_CHECK]
             [-m MIGRATIONS_TABLE_NAME] [-a AUTO_APPLY_DOWN] [-V VERBOSE] [-v]
             migrations_directory

positional arguments:
  migrations_directory  Path to directory containing migrations

optional arguments:
  -h, --help            show this help message and exit
  --host HOST
  -p PORT, --port PORT
  -U USERNAME, --username USERNAME
  -d DBNAME, --dbname DBNAME
  -s SCHEMA, --schema SCHEMA
  -r ROLE, --role ROLE

  --strict_digest_check STRICT_DIGEST_CHECK
                        Set Flase to compare with saved digest instead of re-computing digest.
                        Default is True

  -m MIGRATIONS_TABLE_NAME, --migrations_table_name MIGRATIONS_TABLE_NAME
                        Default is goose_migrations

  -a AUTO_APPLY_DOWN, --auto_apply_down AUTO_APPLY_DOWN
                        Accepts True/False, default is True

  -V VERBOSE, --verbose VERBOSE
                        Accepts True/False, default is True

  -v, --version         show program's version number and exit

Where migrations_directory is some directory of form:

./migrations
  1_up.sql
  1_down.sql
  2_up.sql
  2_down.sql
  3_up.sql
  3_down.sql

Current main difference from Play Framework migrations is that a migration in Goose is all-or-nothing.

E.g. you are on master branch on revision 5 and want to switch to a feature branch whose latest revision is 4'.

1 <- 2 <- 3 <- 4 <- 5
       \
         3' <- 4'

Applying migrations through Goose will leave you on either revision 5 (if an error is encountered) or revision 4' (if migration is successful) but not on any of 4, 3, 2, or 3'.

Testing on local machine

  • Check docs/testing.md

License

Copyright 2018 LeanTaas, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for postgoose, version 0.0.10
Filename, size File type Python version Upload date Hashes
Filename, size postgoose-0.0.10-py3-none-any.whl (7.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size postgoose-0.0.10.tar.gz (7.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page