cybertec-postgresql/pgx-migrator

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 19 Commits
.github		.github
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
go.mod		go.mod
go.sum		go.sum
migrator.go		migrator.go
migrator_test.go		migrator_test.go

Repository files navigation

Go Reference Go Report Card Coverage Status

pgx-migrator

Simple pgx oriented PostgreSQL schema migration library for Go based on lopezator/migrator.

Features

Simple code
Usage as a library, embeddable and extensible on your behalf
Made to use with jackc/pgx
Go code migrations, either transactional or transaction-less, using pgx.Tx (migrator.Migration) or pgx.Conn and pgx.Pool (migrator.MigrationNoTx)
No need to use //go:embed or others, since all migrations are just Go code

Usage

Customize this to your needs by changing the driver and/or connection settings.

QuickStart:

package main
import (
	pgx "github.com/jackc/pgx/v5"
	migrator "github.com/cybertec-postgresql/pgx-migrator"
)
func main() {
 // Configure migrations
 m, err := migrator.New(
 migrator.Migrations(
 &migrator.Migration{
 Name: "Create table foo",
 Func: func(ctx context.Context, tx pgx.Tx) error {
 _, err := tx.Exec(ctx, "CREATE TABLE foo (id INT PRIMARY KEY)")
 return err
 },
 },
 ),
 )
 if err != nil {
 panic(err)
 }
 
 // Open database connection
 conn, err := pgx.Connect(context.Background(), os.Getenv("DATABASE_URL"))
 if err != nil {
 panic(err)
 }
 
 // Migrate up
 if err := m.Migrate(conn); err != nil {
 panic(err)
 }
}