postgres

Documentation

Overview

Package postgres implements the migration.Provider for PostgreSQL.

Index

• type Provider
  • func Open(ctx context.Context, dsn string) (*Provider, error)
  • func (p *Provider) Close() error
  • func (p *Provider) DB() migration.DB
  • func (p *Provider) History() migration.HistoryStore
  • func (p *Provider) Locker(migration.DB) migration.Locker
  • func (p *Provider) Name() string
  • func (p *Provider) SupportsTransactionalDDL() bool

Types

type Provider

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

Provider is the PostgreSQL migration.Provider: it owns the connection pool and knows how to lock, store history and run DDL transactionally.

func Open

func Open(ctx context.Context, dsn string) (*Provider, error)

Open connects to PostgreSQL and verifies the connection.

It builds the pool from a pq.Connector (via sql.OpenDB) rather than sql.Open("postgres", dsn): lib/pq's Driver does not implement driver.DriverContext, so sql.Open falls back to a path that ignores the context entirely during the TCP dial — a ctx deadline would never actually cut off connecting to an unreachable host. Connector.Connect does honor it.

func (*Provider) Close

func (p *Provider) Close() error

Close releases the underlying connection pool.

func (*Provider) DB

func (p *Provider) DB() migration.DB

DB returns the migration.DB the engine should use. The concrete value also implements migration.TxCapableDB, which NewEngine detects since this provider reports SupportsTransactionalDDL() == true.

func (*Provider) History

func (p *Provider) History() migration.HistoryStore

func (*Provider) Locker

func (p *Provider) Locker(migration.DB) migration.Locker

func (*Provider) Name

func (p *Provider) Name() string

func (*Provider) SupportsTransactionalDDL

func (p *Provider) SupportsTransactionalDDL() bool