xdb

Documentation

Index

• func DBHealthCheck(cfg *Config, db DB, logger xlog.OptionalLogger) xhealth.CheckMapping
• func Module() fx.Option
• type Config
  • func LoadConfig(params LoadConfigParams) (*Config, error)
• type ConfigConnection
• type DB
• type DBQualifier
  • func NewDB(cfg *Config) (DBQualifier, error)
• type LoadConfigParams

Functions

func DBHealthCheck

func DBHealthCheck(cfg *Config, db DB, logger xlog.OptionalLogger) xhealth.CheckMapping

DBHealthCheck register a health check for the database. officially it supports only mysql, postgres and mysql. however it try to register the unknown anyways.

func Module

func Module() fx.Option

Module provides an *sql.DB properly configured with values from env vars it also register itself in the health check module.

Types

type Config

type Config struct {
	// DriverName can be one of sqlite, mysql or postgres
	DriverName string           `yaml:"driver"`
	DSN        string           `yaml:"dsn"`
	Connection ConfigConnection `yaml:"connection"`
}

Config holds options to configure the database sql.DB pool of connections

func LoadConfig

func LoadConfig(params LoadConfigParams) (*Config, error)

type ConfigConnection

type ConfigConnection struct {
	MaxIdle     int           `yaml:"max_idle"`
	MaxOpen     int           `yaml:"max_open"`
	MaxLifetime time.Duration `yaml:"max_lifetime"`
}

type DB

type DB struct {
	fx.In

	DB *sql.DB `name:"x_sql_db"`
}

type DBQualifier

type DBQualifier struct {
	fx.Out

	DB *sql.DB `name:"x_sql_db"`
}

func NewDB

func NewDB(cfg *Config) (DBQualifier, error)

NewDB creates a sql.SB with the given config.

type LoadConfigParams

type LoadConfigParams struct {
	fx.In

	Provider config.Provider `optional:"true"`
}