postgres

README

postgres

postgres://user:password@host:port/dbname?query (postgresql:// works, too)

URL Query	WithInstance Config	Description
x-migrations-table	MigrationsTable	Name of the migrations table
dbname	DatabaseName	The name of the database to connect to
search_path		This variable specifies the order in which schemas are searched when an object is referenced by a simple name with no schema specified.
user		The user to sign in as
password		The user's password
host		The host to connect to. Values that start with / are for unix domain sockets. (default is localhost)
port		The port to bind to. (default is 5432)
fallback_application_name		An application_name to fall back to if one isn't provided.
connect_timeout		Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely.
sslcert		Cert file location. The file must contain PEM encoded data.
sslkey		Key file location. The file must contain PEM encoded data.
sslrootcert		The location of the root certificate file. The file must contain PEM encoded data.
sslmode		Whether or not to use SSL (disable|require|verify-ca|verify-full)

Upgrading from v1

1. Write down the current migration version from schema_migrations
2. DROP TABLE schema_migrations
3. Wrap your existing migrations in transactions (BEGIN/COMMIT) if you use multiple statements within one migration.
4. Download and install the latest migrate version.
5. Force the current migration version with migrate force <current_version>.

Documentation

Index

• Variables
• func WithInstance(instance *sql.DB, config *Config) (database.Driver, error)
• type Config
• type Postgres
  • func (p *Postgres) Close() error
  • func (p *Postgres) Drop() error
  • func (p *Postgres) Lock() error
  • func (p *Postgres) Open(url string) (database.Driver, error)
  • func (p *Postgres) Run(migration io.Reader) error
  • func (p *Postgres) SetVersion(version int, dirty bool) error
  • func (p *Postgres) Unlock() error
  • func (p *Postgres) Version() (version int, dirty bool, err error)

Variables

var (
	ErrNilConfig      = fmt.Errorf("no config")
	ErrNoDatabaseName = fmt.Errorf("no database name")
	ErrNoSchema       = fmt.Errorf("no schema")
	ErrDatabaseDirty  = fmt.Errorf("database is dirty")
)

var DefaultMigrationsTable = "schema_migrations"

Functions

func WithInstance

func WithInstance(instance *sql.DB, config *Config) (database.Driver, error)

Types

type Config

type Config struct {
	MigrationsTable string
	DatabaseName    string
}

type Postgres

type Postgres struct {
	// contains filtered or unexported fields
}

func (*Postgres) Close

func (p *Postgres) Close() error

func (*Postgres) Drop

func (p *Postgres) Drop() error

func (*Postgres) Lock

func (p *Postgres) Lock() error

https://www.postgresql.org/docs/9.6/static/explicit-locking.html#ADVISORY-LOCKS

func (*Postgres) Open

func (p *Postgres) Open(url string) (database.Driver, error)

func (*Postgres) Run

func (p *Postgres) Run(migration io.Reader) error

func (*Postgres) SetVersion

func (p *Postgres) SetVersion(version int, dirty bool) error

func (*Postgres) Unlock

func (p *Postgres) Unlock() error

func (*Postgres) Version

func (p *Postgres) Version() (version int, dirty bool, err error)