Documentation
¶
Overview ¶
Package stdpgxfx provides postgres pgx package as fx dependencies.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewPoolConfig ¶
NewPoolConfig inits a pool configuration from the package config.
func SnapshotProvide ¶
SnapshotProvide provides a snapshot migrater.
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 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 PgTestDBHook ¶ added in v0.0.11
PgTestDBHook can be provided to modify the testdb configuration before it's being used in creating a pgx connection pool.
Click to show internal directories.
Click to hide internal directories.