pgkit

Documentation

Index

• type DB
  • func NewDB(connectionString string, opts ...DBOption) (DB, error)
• type DBOption
  • func WithHealthCheckPeriod(d time.Duration) DBOption
  • func WithMaxConnIdleTime(d time.Duration) DBOption
  • func WithMaxConnLifetime(d time.Duration) DBOption
  • func WithMaxConns(n int32) DBOption
  • func WithMinConns(n int32) DBOption
  • func WithPoolContext(ctx context.Context) DBOption
• type FakeDB
  • func (f *FakeDB) Close() error
  • func (f *FakeDB) Exec(ctx context.Context, query string, args ...any) (sql.Result, error)
  • func (f *FakeDB) Query(ctx context.Context, query string, args ...any) (Rows, error)
  • func (f *FakeDB) QueryRow(ctx context.Context, query string, args ...any) Row
• type FakeMigrator
  • func (f *FakeMigrator) ListMigrations(db DB, dirPath string) ([]Migration, error)
  • func (f *FakeMigrator) RunMigrations(db DB, dirPath string) error
  • func (f *FakeMigrator) RunMigrationsToVersion(db DB, dirPath string, toVersion int) error
• type FakeRow
  • func (f *FakeRow) Scan(dest ...any) error
• type FakeRows
  • func (f *FakeRows) Close() error
  • func (f *FakeRows) Err() error
  • func (f *FakeRows) Next() bool
  • func (f *FakeRows) Scan(dest ...any) error
• type Migration
  • func ListMigrationsFromDir(dirPath string) ([]Migration, error)
• type Migrator
  • func NewMigrator() Migrator
• type Row
• type Rows

Types

type DB

type DB interface {
	QueryRow(ctx context.Context, query string, args ...any) Row
	Query(ctx context.Context, query string, args ...any) (Rows, error)
	Exec(ctx context.Context, query string, args ...any) (sql.Result, error)
	Close() error
}

DB is an interface for database operations

func NewDB

func NewDB(connectionString string, opts ...DBOption) (DB, error)

NewDB creates a new database connection pool from a connection string. It opens the connection pool and verifies it with a ping. Optional DBOption parameters can be provided to configure connection pooling.

type DBOption

type DBOption func(*dbOptions)

DBOption is a functional option for configuring NewDB

func WithHealthCheckPeriod

func WithHealthCheckPeriod(d time.Duration) DBOption

WithHealthCheckPeriod sets how frequently to check the health of idle connections

func WithMaxConnIdleTime

func WithMaxConnIdleTime(d time.Duration) DBOption

WithMaxConnIdleTime sets the maximum amount of time a connection may be idle

func WithMaxConnLifetime

func WithMaxConnLifetime(d time.Duration) DBOption

WithMaxConnLifetime sets the maximum amount of time a connection may be reused

func WithMaxConns

func WithMaxConns(n int32) DBOption

WithMaxConns sets the maximum number of connections in the pool

func WithMinConns

func WithMinConns(n int32) DBOption

WithMinConns sets the minimum number of connections in the pool

func WithPoolContext

func WithPoolContext(ctx context.Context) DBOption

WithPoolContext sets the context used for creating the connection pool

type FakeDB

type FakeDB struct {
	QueryRowFake func(ctx context.Context, query string, args ...any) Row
	QueryFake    func(ctx context.Context, query string, args ...any) (Rows, error)
	ExecFake     func(ctx context.Context, query string, args ...any) (sql.Result, error)
	CloseFake    func() error
}

func (*FakeDB) Close

func (f *FakeDB) Close() error

func (*FakeDB) Exec

func (f *FakeDB) Exec(ctx context.Context, query string, args ...any) (sql.Result, error)

func (*FakeDB) Query

func (f *FakeDB) Query(ctx context.Context, query string, args ...any) (Rows, error)

func (*FakeDB) QueryRow

func (f *FakeDB) QueryRow(ctx context.Context, query string, args ...any) Row

type FakeMigrator

type FakeMigrator struct {
	RunMigrationsFake          func(db DB, dirPath string) error
	RunMigrationsToVersionFake func(db DB, dirPath string, toVersion int) error
	ListMigrationsFake         func(db DB, dirPath string) ([]Migration, error)
}

func (*FakeMigrator) ListMigrations

func (f *FakeMigrator) ListMigrations(db DB, dirPath string) ([]Migration, error)

func (*FakeMigrator) RunMigrations

func (f *FakeMigrator) RunMigrations(db DB, dirPath string) error

func (*FakeMigrator) RunMigrationsToVersion

func (f *FakeMigrator) RunMigrationsToVersion(db DB, dirPath string, toVersion int) error

type FakeRow

type FakeRow struct {
	ScanFake func(dest ...any) error
}

func (*FakeRow) Scan

func (f *FakeRow) Scan(dest ...any) error

type FakeRows

type FakeRows struct {
	NextFake  func() bool
	ScanFake  func(dest ...any) error
	CloseFake func() error
	ErrFake   func() error
}

func (*FakeRows) Close

func (f *FakeRows) Close() error

func (*FakeRows) Err

func (f *FakeRows) Err() error

func (*FakeRows) Next

func (f *FakeRows) Next() bool

func (*FakeRows) Scan

func (f *FakeRows) Scan(dest ...any) error

type Migration

type Migration struct {
	Version     int
	Description string
	Filename    string
	Applied     bool
	AppliedAt   *time.Time
}

Migration represents a database migration file

func ListMigrationsFromDir

func ListMigrationsFromDir(dirPath string) ([]Migration, error)

ListMigrationsFromDir returns a list of migrations from a directory without checking applied status

type Migrator

type Migrator interface {
	RunMigrations(db DB, dirPath string) error
	RunMigrationsToVersion(db DB, dirPath string, toVersion int) error
	ListMigrations(db DB, dirPath string) ([]Migration, error)
}

Migrator is an interface for running database migrations

func NewMigrator

func NewMigrator() Migrator

NewMigrator creates a new Migrator

type Row

type Row interface {
	Scan(dest ...any) error
}

Row is an interface for scanning a single row result

type Rows

type Rows interface {
	Next() bool
	Scan(dest ...any) error
	Close() error
	Err() error
}

Rows is an interface for iterating over multiple row results