pgxmigrate

Documentation

Overview

Package pgxmigrate provides a migrate.DB adapter for pgx.

Index

• func NewDriver(q Querier) migrate.DB
• type Querier

Functions

func NewDriver

func NewDriver(q Querier) migrate.DB

NewDriver wraps a pgx Querier (typically *pgxpool.Pool or *pgx.Conn) to satisfy the migrate.DB interface.

Types

type Querier

type Querier interface {
	Exec(ctx context.Context, sql string, args ...any) (pgconn.CommandTag, error)
	Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
	Begin(ctx context.Context) (pgx.Tx, error)
}

Querier is the subset of pgx methods used by the migrator. Both *pgxpool.Pool and *pgx.Conn satisfy this interface.