pgx

README

pgx

This package is for pgx/v4. A backend for the newer pgx/v5 is also available.

pgx://user:password@host:port/dbname?query

URL Query	WithInstance Config	Description
x-migrations-table	MigrationsTable	Name of the migrations table
x-migrations-table-quoted	MigrationsTableQuoted	By default, migrate quotes the migration table for SQL injection safety reasons. This option disable quoting and naively checks that you have quoted the migration table name. e.g. "my_schema"."schema_migrations"
x-statement-timeout	StatementTimeout	Abort any statement that takes more than the specified number of milliseconds
x-multi-statement	MultiStatementEnabled	Enable multi-statement execution (default: false)
x-multi-statement-max-size	MultiStatementMaxSize	Maximum size of single statement in bytes (default: 10MB)
x-lock-strategy	LockStrategy	Strategy used for locking during migration (default: advisory)
x-lock-table	LockTable	Name of the table which maintains the migration lock (default: schema_lock)
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>.

Multi-statement mode

In PostgreSQL running multiple SQL statements in one Exec executes them inside a transaction. Sometimes this behavior is not desirable because some statements can be only run outside of transaction (e.g. CREATE INDEX CONCURRENTLY). If you want to use CREATE INDEX CONCURRENTLY without activating multi-statement mode you have to put such statements in a separate migration files.

Documentation

Index

• Constants
• Variables
• func WithInstance(instance *sql.DB, config *Config) (database.Driver, error)
• type Config
• type Postgres
  • func (p *Postgres) Close() error
  • func (p *Postgres) Drop() (err error)
  • func (p *Postgres) ListAppliedVersions() ([]int, 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) SetSourceDriver(sourceDrv source.Driver) error
  • func (p *Postgres) SetVersion(version int, dirty bool, forced bool, knownDirection *source.Direction) (*source.Direction, error)
  • func (p *Postgres) Unlock() error
  • func (p *Postgres) Version() (version int, dirty bool, err error)

Constants

const (
	LockStrategyAdvisory = "advisory"
	LockStrategyTable    = "table"
)

Variables

var (
	DefaultMigrationsTable       = "schema_migrations"
	DefaultMultiStatementMaxSize = 10 * 1 << 20 // 10 MB
	DefaultLockTable             = "schema_lock"
	DefaultLockStrategy          = LockStrategyAdvisory
)

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

Functions

func WithInstance

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

Types

type Config

type Config struct {
	MigrationsTable string
	DatabaseName    string
	SchemaName      string
	LockTable       string
	LockStrategy    string

	StatementTimeout      time.Duration
	MigrationsTableQuoted bool
	MultiStatementEnabled bool
	MultiStatementMaxSize int
	// contains filtered or unexported fields
}

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() (err error)

func (*Postgres) ListAppliedVersions

func (p *Postgres) ListAppliedVersions() ([]int, error)

func (*Postgres) Lock

func (p *Postgres) Lock() error

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) SetSourceDriver

func (p *Postgres) SetSourceDriver(sourceDrv source.Driver) error

This database driver does not currently support file sourcing.

func (*Postgres) SetVersion

func (p *Postgres) SetVersion(version int, dirty bool, forced bool, knownDirection *source.Direction) (*source.Direction, error)

func (*Postgres) Unlock

func (p *Postgres) Unlock() error

func (*Postgres) Version

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