psql

Documentation

Overview

Common helpers for managing postgres database connections and migrations.

Index

• func Open(ctx context.Context, config Config) (*sql.DB, error)
• type Config
  • func (config Config) DSN() string
• type Migrator
  • func NewMigrator(ctx context.Context, db *sql.DB, source string) (*Migrator, error)
  • func (m *Migrator) Down(steps int) error
  • func (m *Migrator) Force(v int) error
  • func (m *Migrator) Up(steps int) error
  • func (m *Migrator) Version() (*Version, error)
• type Version

Functions

func Open

func Open(ctx context.Context, config Config) (*sql.DB, error)

Open opens a database connection pool to a database server

Types

type Config

type Config struct {
	User           string
	Pass           string
	DBName         string
	Host           string
	SSLMode        string
	MaxConnections int
}

Config contains data source name settings

func (Config) DSN

func (config Config) DSN() string

DSN returns the data source name as a string in the correct format

type Migrator

type Migrator struct {
	Db      *sql.DB
	Migrate *migrate.Migrate
}

Migrator

func NewMigrator

func NewMigrator(ctx context.Context, db *sql.DB, source string) (*Migrator, error)

NewMigrator returns a new database migrator for the given connection using a file path for the migrations source

func (*Migrator) Down

func (m *Migrator) Down(steps int) error

MigrateDown run down migrations

func (*Migrator) Force

func (m *Migrator) Force(v int) error

MigrateForce force version

func (*Migrator) Up

func (m *Migrator) Up(steps int) error

MigrateUp run up migrations

func (*Migrator) Version

func (m *Migrator) Version() (*Version, error)

MigrateVersion prints the current migration version

type Version

type Version struct {
	Version uint
	Dirty   bool
}