postgres

Documentation

Index

• func Connect(c *Config) (*pgxpool.Pool, *sql.DB, error)
• func Migrate(db *sql.DB, path, action string) error
• type Config
  • func (c *Config) Check() func(ctx context.Context) error
  • func (c *Config) ConnectAndMigrate(logger *zap.Logger) (*Handler, error)
  • func (c *Config) ToDSN() string
• type Handler
  • func (h *Handler) Shutdown(ctx context.Context) error

Functions

func Connect

func Connect(c *Config) (*pgxpool.Pool, *sql.DB, error)

func Migrate

func Migrate(db *sql.DB, path, action string) error

Types

type Config

type Config struct {
	Host          string
	Port          string
	User          string
	Password      string
	Database      string
	MigrationPath string
}

Config holds all values used to configure and connect to a postgres db.

func (*Config) Check

func (c *Config) Check() func(ctx context.Context) error

Check allows to probe the liveness of postgres database.

func (*Config) ConnectAndMigrate

func (c *Config) ConnectAndMigrate(logger *zap.Logger) (*Handler, error)

ConnectAndMigrate establishes a connection to the database based on the configuration provided. Additionally it performs a data migration to ensure that the schema is on the latest version.

func (*Config) ToDSN

func (c *Config) ToDSN() string

type Handler

type Handler struct {
	StdDB *sql.DB
	PGx   *pgxpool.Pool
}

Handler holds two connections to the database. sqlx connection and original pgx connection. PGx is primarily used for PostgreSQL and StdDB for migration and integration testing.

func (*Handler) Shutdown

func (h *Handler) Shutdown(ctx context.Context) error

Shutdown closes all connections.