database

Documentation

Overview

Package database defines the interface to the database.

Package database defines the interface to the database.

Index

• type Connection
• type Pool
  • func New(ctx context.Context, URL string) (*Pool, error)
  • func ReadOnly(ctx context.Context, URL string) (*Pool, error)
  • func (p *Pool) Begin(ctx context.Context) (pgx.Tx, error)
  • func (p *Pool) BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error)
  • func (p *Pool) Exec(ctx context.Context, sql string, args ...interface{}) (pgconn.CommandTag, error)
  • func (p *Pool) Query(ctx context.Context, sql string, args ...interface{}) (pgx.Rows, error)
  • func (p *Pool) QueryRow(ctx context.Context, sql string, args ...interface{}) pgx.Row
  • func (p *Pool) Refresh(ctx context.Context) error
  • func (p *Pool) SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults

Types

type Connection

type Connection interface {
	Begin(ctx context.Context) (pgx.Tx, error)
	Exec(ctx context.Context, sql string, arguments ...interface{}) (pgconn.CommandTag, error)
	Query(ctx context.Context, sql string, args ...interface{}) (pgx.Rows, error)
	QueryRow(ctx context.Context, sql string, args ...interface{}) pgx.Row
}

Connection defines the methods used to access the database. It is also implemented by a mock database connection for testing.

type Pool

type Pool struct {
	URL string
	// contains filtered or unexported fields
}

Pool provides a set of connections to the target database.

func New

func New(ctx context.Context, URL string) (*Pool, error)

New creates a new connection to the database. It waits until a connection can be established, or that the context has been cancelled.

func ReadOnly

func ReadOnly(ctx context.Context, URL string) (*Pool, error)

ReadOnly creates a new connection to the database with follower reads It waits until a connection can be established, or that the context has been cancelled.

func (*Pool) Begin

func (p *Pool) Begin(ctx context.Context) (pgx.Tx, error)

Begin implements Connection.

func (*Pool) BeginTx

func (p *Pool) BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error)

BeginTx implements Connection.

func (*Pool) Exec

func (p *Pool) Exec(
	ctx context.Context, sql string, args ...interface{},
) (pgconn.CommandTag, error)

Exec implements Connection.

func (*Pool) Query

func (p *Pool) Query(ctx context.Context, sql string, args ...interface{}) (pgx.Rows, error)

Query implements Connection.

func (*Pool) QueryRow

func (p *Pool) QueryRow(ctx context.Context, sql string, args ...interface{}) pgx.Row

QueryRow implements Connection.

func (*Pool) Refresh

func (p *Pool) Refresh(ctx context.Context) error

Refresh creates a new pool, and reloads the certificates, if applicable. It is typically called when the process receives a SIGHUP.

func (*Pool) SendBatch

func (p *Pool) SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults

SendBatch implements Connection.