db

Documentation

Overview

Package db manages interaction with an underlying database store.

This package is a thin layer around pgx that provides a configuration interface.

Index

• type Config
• type ConnPool
  • func New(c Config, l log.Logger) (*ConnPool, error)
  • func (p *ConnPool) Open() (*pgx.Conn, error)
  • func (p *ConnPool) Release(c *pgx.Conn)

Types

type Config

type Config struct {
	ConnString     string `toml:"connection_string"`
	MaxConnections int    `toml:"max_connections"`
}

Config represents configuration details for creating a connection pool.

type ConnPool

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

Type ConnPool represents a connection pool.

func New

func New(c Config, l log.Logger) (*ConnPool, error)

New creates a new ConnPool using the given Config.

Generally only one ConnPool should be used, shared by the entire application.

func (*ConnPool) Open

func (p *ConnPool) Open() (*pgx.Conn, error)

Open acquires a connection for the caller.

Remember to Release the DB when you're done with it! Otherwise the connection will not be released back to the pool, and eventually you will run out of available connections.

func (*ConnPool) Release

func (p *ConnPool) Release(c *pgx.Conn)

Release returns the given connection back to the connection pool.

This method should be called, probably in a defer statement, before the end of any function that Opens a connection. If a connection is not released, eventually the application will run out of available connections and fail.