postgres

README

PostgreSQL Driver

• Runs migrations in transactions. That means that if a migration fails, it will be safely rolled back.
• Tries to return helpful error messages.
• Stores migration version details in table schema_migrations. This table will be auto-generated.

Usage

migrate -url postgres://user@host:port/database -path ./db/migrations create add_field_to_table
migrate -url postgres://user@host:port/database -path ./db/migrations up
migrate help # for more info

# TODO(mattes): thinking about adding some custom flag to allow migration within schemas:
-url="postgres://user@host:port/database?schema=name"

# see more docs: https://godoc.org/github.com/lib/pq#hdr-Connection_String_Parameters

Authors

• Matthias Kadenbach, https://github.com/mattes

Documentation

Overview

Package postgres implements the Driver interface.

Index

• type Driver
  • func (driver *Driver) Close() error
  • func (driver *Driver) FilenameExtension() string
  • func (driver *Driver) Initialize(url string) error
  • func (driver *Driver) Migrate(f file.File, pipe chan interface{})
  • func (driver *Driver) Version() (uint64, error)

Types

type Driver

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

func (*Driver) Close

func (driver *Driver) Close() error

func (*Driver) FilenameExtension

func (driver *Driver) FilenameExtension() string

func (*Driver) Initialize

func (driver *Driver) Initialize(url string) error

func (*Driver) Migrate

func (driver *Driver) Migrate(f file.File, pipe chan interface{})

func (*Driver) Version

func (driver *Driver) Version() (uint64, error)