postgrespgxdb

Documentation

Overview

Package postgrespgxdb provides constructor to connect to postgresql with pgx

Index

• Constants
• func IsConstraintError(err error, name string) bool
• type AffectedLessThenNecessaryError
  • func (e *AffectedLessThenNecessaryError) Error() string
• type Config
  • func (cfg *Config) GetDSN() string
• type Conn
• type DBQuery
  • func New(cfg *Config, log types.SQLLoggerFunc) (DBQuery, error)

Constants

const (
	// SCMPrepare
	// Statement Cache Mode value - "prepare" - is default
	SCMPrepare = "prepare"

	// SCMDescribe
	// Statement Cache Mode value - "describe" - use it for PGBouncer connections
	SCMDescribe = "describe"
)

const (
	ConstraintErrorCode = "23505"
)

Functions

func IsConstraintError

func IsConstraintError(err error, name string) bool

Types

type AffectedLessThenNecessaryError

type AffectedLessThenNecessaryError struct {
	Affected  int64
	Necessary int64
}

func (*AffectedLessThenNecessaryError) Error

func (e *AffectedLessThenNecessaryError) Error() string

type Config

type Config struct {
	Host                string
	Port                string
	Name                string
	User                string
	Password            string
	SSLMode             string
	BinaryParameters    string // lib/pq setting for prepared statements in pgbouncer
	StatementCacheMode  string
	MaxConnections      string
	UseConnectionPooler bool
}

Config describe connection params to database

func (*Config) GetDSN

func (cfg *Config) GetDSN() string

GetDSN return DSN string for db connection params

type Conn

type Conn struct {
	*pgxpool.Pool
	*types.DBLog
}

Conn database connection and log

type DBQuery

type DBQuery interface {
	Exec(ctx context.Context, sql string, arguments ...any) (pgconn.CommandTag, error)
	Query(ctx context.Context, sql string, optionsAndArgs ...any) (pgx.Rows, error)
	QueryRow(ctx context.Context, sql string, optionsAndArgs ...any) pgx.Row
	Begin(ctx context.Context) (pgx.Tx, error)
	BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error)
	SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults
	Close()
	types.SQLLogger
}

DBQuery describe interface

func New

func New(cfg *Config, log types.SQLLoggerFunc) (DBQuery, error)

New create new database connection