pqx

Documentation

Index

• Constants
• type Postgres
  • func (p *Postgres) CreateDB(ctx context.Context, logf func(string, ...any), name, schema string) (db *sql.DB, dsn string, cleanup func(), err error)
  • func (p *Postgres) DSN(dbname string) string
  • func (p *Postgres) Flush()
  • func (p *Postgres) Pid() int
  • func (p *Postgres) Shutdown() error
  • func (p *Postgres) ShutdownAlone() error
  • func (p *Postgres) Start(ctx context.Context, logf func(string, ...any)) error

Constants

const DefaultVersion = "14.2.0"

Types

type Postgres

type Postgres struct {
	Version string // for a list of versions by OS, see: https://mvnrepository.com/artifact/io.zonky.test.postgres
	Dir     string
	Port    int // The port to bind postgres too. If the value is zero, a random port is assigned.

	DebugLevel int // passed to postgres using the ("-d") flag
	// contains filtered or unexported fields
}

func (*Postgres) CreateDB

func (p *Postgres) CreateDB(ctx context.Context, logf func(string, ...any), name, schema string) (db *sql.DB, dsn string, cleanup func(), err error)

Open creates a database for the schema, connects to it, and returns the *sql.DB. .. more words needed here.

func (*Postgres) DSN

func (p *Postgres) DSN(dbname string) string

func (*Postgres) Flush

func (p *Postgres) Flush()

func (*Postgres) Pid

func (p *Postgres) Pid() int

Pid returns the pid of the postgres process. It is an error to call Pid before Start.

func (*Postgres) Shutdown

func (p *Postgres) Shutdown() error

Shutdown waits for any inflight database cleanup functions to finish and then shutsdown postgres.

func (*Postgres) ShutdownAlone

func (p *Postgres) ShutdownAlone() error

ShutdownAlone is like Shutdown, but it leaves postgres running.

func (*Postgres) Start

func (p *Postgres) Start(ctx context.Context, logf func(string, ...any)) error

ctx only affects initdb and pingUntilUp; otherwise, the context is ignored.