database

Documentation

Index

• func ConnString(cfg Config) string
• func Connect(ctx context.Context, cfg Config) (*pgxpool.Pool, error)
• func ConnstrWithDatabase(connstr, database string) (string, error)
• func SanitizeDatabaseName(schema string) string
• func StatusCheck(ctx context.Context, db *pgxpool.Pool) error
• type Config
• type DB
  • func ConnectWithURI(ctx context.Context, uri string) (*DB, error)

Functions

func ConnString

func ConnString(cfg Config) string

ConnString translates config to a db connection string.

func Connect

func Connect(ctx context.Context, cfg Config) (*pgxpool.Pool, error)

Connect establishes a database connection based on the configuration.

func ConnstrWithDatabase

func ConnstrWithDatabase(connstr, database string) (string, error)

ConnstrWithDatabase changes the main database in the connection string.

func SanitizeDatabaseName

func SanitizeDatabaseName(schema string) string

SanitizeDatabaseName ensures that the database name is a valid postgres identifier.

func StatusCheck

func StatusCheck(ctx context.Context, db *pgxpool.Pool) error

StatusCheck returns nil if it can successfully talk to the database. It returns a non-nil error otherwise.

Types

type Config

type Config struct {
	User       string
	Password   string
	Host       string
	Name       string
	DisableTLS bool
}

Config is the required properties to use the database.

type DB

type DB struct {
	*pgxpool.Pool
}

func ConnectWithURI

func ConnectWithURI(ctx context.Context, uri string) (*DB, error)