Documentation
¶
Overview ¶
Package config provides shared SQL (`database/sql`) configuration types for go-service.
This package defines configuration structs that are typically embedded into a larger service configuration and then consumed by driver-specific wiring (for example `database/sql/pg`).
Pool configuration ¶
The top-level `Config` models common connection pool settings such as:
- maximum connection lifetime,
- max open connections, and
- max idle connections.
DSNs and source strings ¶
Master and replica (slave) DSNs are configured via `DSN` entries. Each DSN URL is expressed as a go-service "source string" (resolved via `os.FS.ReadSource`), so it can be:
- "env:NAME" to read from an environment variable,
- "file:/path/to/dsn" to read from a file, or
- any other value treated as a literal DSN.
Start with `Config` and `DSN`.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// ConnMaxLifetime is the maximum amount of time a connection may be reused.
//
// The value is parsed as a Go duration string (for example "30s", "5m", "1h").
// Wiring that consumes this field typically parses it using time.ParseDuration semantics and may
// treat parsing failures as fatal configuration errors.
ConnMaxLifetime string `yaml:"conn_max_lifetime,omitempty" json:"conn_max_lifetime,omitempty" toml:"conn_max_lifetime,omitempty"`
// Masters is the set of primary (read-write) datasource DSNs.
//
// Each DSN URL is a "source string" resolved via `os.FS.ReadSource`, so it can be:
// - "env:NAME" to read the DSN from an environment variable,
// - "file:/path/to/dsn" to read the DSN from a file, or
// - any other value treated as a literal DSN string.
Masters []DSN `yaml:"masters,omitempty" json:"masters,omitempty" toml:"masters,omitempty"`
// Slaves is the set of replica (read-only) datasource DSNs.
//
// Each DSN URL is a "source string" resolved via `os.FS.ReadSource` (see Masters for the supported formats).
Slaves []DSN `yaml:"slaves,omitempty" json:"slaves,omitempty" toml:"slaves,omitempty"`
// MaxOpenConns is the maximum number of open connections to the database.
MaxOpenConns int `yaml:"max_open_conns,omitempty" json:"max_open_conns,omitempty" toml:"max_open_conns,omitempty"`
// MaxIdleConns is the maximum number of connections in the idle connection pool.
MaxIdleConns int `yaml:"max_idle_conns,omitempty" json:"max_idle_conns,omitempty" toml:"max_idle_conns,omitempty"`
}
Config contains shared `database/sql` connection pool configuration.
It is intended to be embedded by driver-specific configuration types (for example PostgreSQL) and consumed by the SQL wiring in this repository.
Masters and Slaves contain DSNs (connection strings) expressed as go-service "source strings" (literal values, `file:` paths, or `env:` references) that are resolved by `os.FS.ReadSource`.
type DSN ¶
type DSN struct {
// URL is a go-service "source string" for the datasource name/connection string.
//
// It is resolved via `os.FS.ReadSource`, so it can be:
// - "env:NAME" to read from an environment variable,
// - "file:/path/to/dsn" to read from a file, or
// - any other value treated as a literal connection string.
URL string `yaml:"url,omitempty" json:"url,omitempty" toml:"url,omitempty"`
}
DSN is a SQL datasource name (connection string) configuration.
Source Files