stdpgxfx

type Config ¶

type Config struct {
	// MainDatabaseURL configures the database connection string for the main connection.
	MainDatabaseURL string `env:"MAIN_DATABASE_URL,required"`
	// IamAuthRegion when set cause the password to be replaced by an IAM token for authentication.
	IamAuthRegion string `env:"IAM_AUTH_REGION"`
}

Config configures the module.

type Deriver ¶ added in v0.0.13

type Deriver func(logs *zap.Logger, base *pgxpool.Config) *pgxpool.Config

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

type Driver ¶ added in v0.0.117

type Driver[DBT any] interface {
	NewPool(pcfg *pgxpool.Config) (DBT, error)
	Close(pool DBT) error
}

Driver abstracts turning a pgxpool config into connection pool and closing it.

func NewPgxV5Driver() Driver[*pgxpool.Pool]

func NewStandardDriver() Driver[*sql.DB]

type EndRole ¶ added in v0.0.120

type EndRole struct {
	Username string
	Password string
}

EndRole defines a type that can be provided if the role that actually connects to the database in tests is different from the migration role.

type Params ¶

type Params struct {
	fx.In
	Config    Config
	AwsConfig aws.Config `optional:"true"`
	Logs      *zap.Logger
}

Params describe the main parameters for providing components.

type PgtestdbTestMigratorParams ¶ added in v0.0.58

type PgtestdbTestMigratorParams struct {
	fx.In
	Migrator pgtestdb.Migrator
	Role     *pgtestdb.Role `optional:"true"`
	EndRole  *EndRole       `optional:"true"`
}

type Result ¶

type Result struct {
	fx.Out
	PoolConfig *pgxpool.Config
}

Result describe the main components provided for this module.

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

type TestMigrator ¶ added in v0.0.58

type TestMigrator interface {
	Migrate(
		tb testing.TB,
		cfg Config,
		pcfg *pgxpool.Config,
	) (*pgxpool.Config, error)
}

TestMigrator can be implemented and provided to migrate the database for tests.

func NewPgtestdbTestMigrator(params PgtestdbTestMigratorParams) TestMigrator

type TestMigratorFunc ¶ added in v0.0.58

type TestMigratorFunc func(
	tb testing.TB,
	cfg Config,
	pcfg *pgxpool.Config,
) (*pgxpool.Config, error)

TestMigratorFunc makes it easy to implement the migrator.

func (f TestMigratorFunc) Migrate(
	tb testing.TB, cfg Config, pcfg *pgxpool.Config,
) (*pgxpool.Config, error)