A Go package to help write migrations with go-pg/pg.
MIT License
A Go package to help write migrations with go-pg/pg
.
Because go-pg
now has Go modules
support, go-pg-migrations
also has
modules support; it currently depends on v10 of go-pg
. To install it, use the
following command in a project with a go.mod
:
$ go get github.com/robinjoseph08/go-pg-migrations/v3
If you are not yet using Go modules, you can still use v1 of this package.
To see how this package is intended to be used, you can look at the example
directory. All you need to do is have a main
package (e.g.
example
); call migrations.Run
with the directory you want the migration
files to be saved in (which will be the same directory of the main package, e.g.
example
), an instance of *pg.DB
, and os.Args
; and log any potential errors
that could be returned.
You can also call migrations.RunWithOptions
to configure the way that the
migrations run (e.g. customize the name of the migration tables).
Once this has been set up, then you can use the create
, migrate
, status
,
rollback
, help
commands like so:
$ go run example/*.go create create_users_table
Creating example/20180812001528_create_users_table.go...
$ go run example/*.go migrate
Running batch 1 with 1 migration(s)...
Finished running "20180812001528_create_users_table"
$ go run example/*.go status
+---------+-----------------------------------+-------+
| Applied | Migration | Batch |
+---------+-----------------------------------+-------+
| √ | 20180812001528_create_users_table | 1 |
+---------+-----------------------------------+-------+
$ go run example/*.go rollback
Rolling back batch 1 with 1 migration(s)...
Finished rolling back "20180812001528_create_users_table"
$ go run example/*.go help
Usage:
go run example/*.go [command]
Commands:
create - create a new migration in example with the provided name
migrate - run any migrations that haven't been run yet
rollback - roll back the previous run batch of migrations
status - show the status of each migration
help - print this help text
Examples:
go run example/*.go create create_users_table
go run example/*.go migrate
go run example/*.go rollback
go run example/*.go status
go run example/*.go help
While this works when you have the Go toolchain installed, there might be a
scenario where you have to run migrations and you don't have the toolchain
available (e.g. in a scratch
or alpine
Docker image deployed to production).
In that case, you should compile another binary (in addition to your actual
application) and copy it into the final image. This will include all of your
migrations and allow you to run it by overriding the command when running the
Docker container.
This would look something like this:
# Dockerfile
FROM golang:1.13.3 as build
WORKDIR /app
COPY go.mod go.mod
COPY go.sum go.sum
RUN go mod download
COPY . .
RUN CGO_ENABLED=0 GOOS=linux go build -installsuffix cgo -ldflags '-w -s' -o ./bin/serve ./cmd/serve
RUN CGO_ENABLED=0 GOOS=linux go build -installsuffix cgo -ldflags '-w -s' -o ./bin/migrations ./cmd/migrations
FROM alpine:3.8
RUN apk --no-cache add ca-certificates
COPY --from=build /app/bin /bin
CMD ["serve"]
$ docker build -t service:latest .
$ docker run --rm service:latest migrations migrate
While go-pg has its own migrations
package, it leaves a bit to be desired.
Some additional features that this package supports:
go-pg/migrations
checks the current version of migrations and runs anygo-pg/migrations
has some recommendations and examples, this packageMany of these features and expected behaviors come from using Knex.js migrations in production for many years. This project is heavily inspired by Knex to provide a robust and safe migration experience.
go-pg
is a great and performant project, and hopefully, this makes it a little
better.
To develop on this project, you'll need to have Postgres running because the tests depend on it.
If you have it running on your machine because it was installed through your
package manager (like brew
or apt-get
), you just need to run the following
to get it set up correctly:
make setup
If you don't have it on your laptop, you can run the following to start it within Docker:
make postgres
That should start the container and keep it running while you develop. Once
you're done, you can ^C
out of it and it will stop the container.
To run the tests, you should run:
make test
To run the linter, you should run:
make lint