postgres

package

v0.0.1 Latest Latest Go to latest Published: Apr 10, 2026 License: MIT Imports: 6 Imported by: 0

Details

Package sqlite provides a PostgreSQL based database configuration.

View Source

const Type database.Type = "postgres"

Type of PostgreSQL database configurations.

This section is empty.

This section is empty.

type Config struct {
	// contains filtered or unexported fields
}

Config represents the PostgreSQL database configuration.

func NewConfig(dbName, user, password string, options ...ConfigSetter) *Config

NewConfig creates a new PostgreSQL database configuration using the given options.

func (c *Config) DSN() string

DSN get the Data Source Name to be used for accessing the database.

func (c *Config) DriverName() string

DriverName gets the name of the sql driver providing access to the database represented by this configuration.

func (c *Config) RedactedDSN() string

DSN get the Data Source Name with any sensitive data redacted.

func (c *Config) SchemaScripts() [][]byte

SchemaScripts gets the schema updated scripts to be applied to the database during schema initialization or a schema update.

func (c *Config) Type() database.Type

Type gets the database type represented by this configuration.

type ConfigSetter interface {
	Apply(*Config)
}

ConfigSetter interface is used to set database configuration options during a NewConfig call.

func WithAddress(address string) ConfigSetter

WithAddress sets the address string to use to connect to the PostgreSQL database.

func WithSchemaScripts(scripts ...[]byte) ConfigSetter

WithSchemaScripts defines the schema update scripts to be applied during database schema update.

type ConfigSetterFunc func(*Config)

ConfigSetterFunc functions are used to set database configuration options during a NewConfig call.

func (f ConfigSetterFunc) Apply(c *Config)