database

Documentation

Overview

Package database provides database instrumentation.

Index

• func SetupStorage(cfg Config, logger ctxd.Logger, statsTracker stats.Tracker, ...) (*sqluct.Storage, error)
• func SetupStorageDSN(cfg Config, logger ctxd.Logger, statsTracker stats.Tracker, migrations fs.FS) (*sqluct.Storage, error)
• type Config

Functions

func SetupStorage

func SetupStorage(cfg Config, logger ctxd.Logger, statsTracker stats.Tracker, conn driver.Connector, migrations fs.FS) (*sqluct.Storage, error)

SetupStorage initializes database pool and prepares storage.

func SetupStorageDSN

func SetupStorageDSN(cfg Config, logger ctxd.Logger, statsTracker stats.Tracker, migrations fs.FS) (*sqluct.Storage, error)

SetupStorageDSN initializes database pool and prepares storage.

Types

type Config

type Config struct {
	DriverName      string        `split_words:"true"`
	DSN             string        `required:"true"`
	MaxLifetime     time.Duration `split_words:"true" default:"4h"`
	MaxIdle         int           `split_words:"true" default:"5"`
	MaxOpen         int           `split_words:"true" default:"5"`
	InitConn        bool          `split_words:"true"`
	ApplyMigrations bool          `split_words:"true"`

	// MethodSkipPackages provides helper package paths to skip when identifying method name for observability.
	// Item example: "github.com/jmoiron/sqlx".
	MethodSkipPackages []string
}

Config describes database pool.