stdpgxfx

Documentation

Overview

Package stdpgxfx provides postgres pgx package as fx dependencies.

Index

• func NewPoolConfig(cfg Config, logs *zap.Logger) (*pgxpool.Config, error)
• func Provide(derivedPoolNames ...string) fx.Option
• func ProvideDeriver(name string, deriver Deriver) fx.Option
• func SnapshotProvide(filename string) fx.Option
• func TestProvide(tb testing.TB, derivedPoolNames ...string) fx.Option
• type Config
• type Deriver
• type Params
• type Result
  • func New(params Params) (res Result, err error)

Functions

func NewPoolConfig

func NewPoolConfig(cfg Config, logs *zap.Logger) (*pgxpool.Config, error)

NewPoolConfig inits a pool configuration from the package config.

func Provide

func Provide(derivedPoolNames ...string) fx.Option

Provide components as fx dependencies.

func ProvideDeriver

func ProvideDeriver(name string, deriver Deriver) fx.Option

ProvideDeriver is a short-hande function for providing a named deriver function that.

func SnapshotProvide

func SnapshotProvide(filename string) fx.Option

SnapshotProvide provides a snapshot migrater.

func TestProvide

func TestProvide(tb testing.TB, derivedPoolNames ...string) fx.Option

TestProvide provides the package's components as an fx module with a setup more useful for testing.

Types

type Config

type Config struct {
	// RWDatabaseURL configures the database connection string for the read-write connection.
	RWDatabaseURL string `env:"RW_DATABASE_URL"`
	// PoolConnectionTimeout configures how long the pgx pool connect logic waits for the connection to establish
	PoolConnectionTimeout time.Duration `env:"POOL_CONNECTION_TIMEOUT" envDefault:"5s"`
	// PoolCloseTimeout is the time we'll allow to to close the connection pool. Only effective if shorter than
	// the fx shutdown timeout
	PoolCloseTimeout time.Duration `env:"POOL_CLOSE_TIMEOUT" envDefault:"5s"`
}

Config configures the components.

type Deriver

type Deriver func(base *pgxpool.Config) *pgxpool.Config

Deriver needs to be provided by the user of this module if derived pools are created.

type Params

type Params struct {
	fx.In
	fx.Lifecycle
	Logs          *zap.Logger
	Config        Config
	PgxPoolConfig *pgxpool.Config
}

Params define the dependencies of the main component(s).

type Result

type Result struct {
	fx.Out
	RW *pgxpool.Pool `name:"rw"`
}

Result declare the main components produced by this package.

func New

func New(params Params) (res Result, err error)

New build the main components of this package.