seagull
Getting Started
The basic workflow is as follows:
seagull init
# seagull.toml
Commands
seagull init
creates a seagull.toml
file for storing connection strings and other config values. This file is optional, you can use the other commands without it.
seagull poop
firstly creates a directory named migrations
if one does not already exist. Secondly creates an empty .sql
file in the format V{1}__{2}.sql
where {1}
is an auto-incremented version number and {2}
is a description.
# creates ./migrations/V1__initial.sql
# creates ./migrations/V1_create_users_table.sql
# creates ./migrations/V2_another_migration.sql assuming V1 exists
seagull migrate
firstly creates a database table named __migration_history
if one does not already exist. Runs all migrations in the migrations
directory in a single transaction. If one fails, they all fail and the database is rolled back.
# reads config from seagull.toml
# specify your PostgreSQL connection string
# looks for migrations in src/migrations
seagull remigrate
Same as seagull migrate
except that it will firstly reset the whole database before running all migrations. Useful for development if you're using a Docker database and changing migrations often. Would NOT suggest running it on production! :skull_and_crossbones:
# reads config from seagull.toml
# specify your PostgreSQL connection string
# looks for migrations in src/migrations