pg

Documentation

Index

• Variables
• type Batch
• type BatchResults
• type Client
  • func New(ctx context.Context, cfg *Config) (Client, error)
  • func NewWithMock(pool Pool) Client
  • func NewWithPool(ctx context.Context, pool *pgxpool.Pool) (Client, error)
• type Config
• type Conn
• type CopyFromSource
• type Identifier
• type Pool
• type Row
• type Rows
• type Stat
• type Tx
• type TxOptions

Variables

var (
	ErrTxCommitRollback = pgx.ErrTxCommitRollback
	ErrTooManyRows      = pgx.ErrTooManyRows
	ErrTxClosed         = pgx.ErrTxClosed
	ErrNoRows           = pgx.ErrNoRows
)

Types

type Batch

type Batch = pgx.Batch

type BatchResults

type BatchResults = pgx.BatchResults

type Client

type Client interface {
	Pool

	RegisterTypes(types []string) error

	ToPgx() *pgxpool.Pool
}

Client is interface for communicate with postgres database.

func New

func New(ctx context.Context, cfg *Config) (Client, error)

ConnectToDb returns a pointer to a pgxpool.Pool representing the database connection pool.

func NewWithMock

func NewWithMock(pool Pool) Client

func NewWithPool

func NewWithPool(ctx context.Context, pool *pgxpool.Pool) (Client, error)

type Config

type Config struct {
	Host           string `yaml:"host"     env:"PG_HOST"    env-default:"localhost"`
	Port           int    `yaml:"port"     env:"PG_PORT"    env-default:"5432"`
	DBName         string `yaml:"dbname"   env:"PG_NAME"    env-default:"postgres"`
	Username       string `yaml:"username" env:"PG_USER"`
	Password       string `env:"POSTGRES_PASSWORD"`
	SSLMode        string `yaml:"sslmode"  env:"PG_SSLMODE" env-default:"disabled"`
	MigrationsRun  bool   `yaml:"migrations_run" env:"PG_MIGRATIONS_RUN" env-default:"false"`
	MigrationsPath string `yaml:"migrations_path" env:"PG_MIGRATIONS_PATH"`
}

Config is type for database connection.

type Conn

type Conn = pgx.Conn

type CopyFromSource

type CopyFromSource = pgx.CopyFromSource

type Identifier

type Identifier = pgx.Identifier

type Pool

type Pool interface {
	Acquire(ctx context.Context) (c *pgxpool.Conn, err error)
	AcquireFunc(ctx context.Context, f func(*pgxpool.Conn) error) error
	Exec(ctx context.Context, sql string, arguments ...any) (pgconn.CommandTag, error)
	AcquireAllIdle(ctx context.Context) []*pgxpool.Conn
	QueryRow(ctx context.Context, sql string, args ...any) pgx.Row
	SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults
	Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
	BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error)
	CopyFrom(ctx context.Context, tableName pgx.Identifier, columnNames []string, rowSrc pgx.CopyFromSource) (int64, error)
	Ping(ctx context.Context) error
	Begin(ctx context.Context) (pgx.Tx, error)
	Stat() *pgxpool.Stat
	Config() *pgxpool.Config
	Reset()
	Close()
}

type Row

type Row = pgx.Row

type Rows

type Rows = pgx.Rows

type Stat

type Stat = pgxpool.Stat

type Tx

type Tx = pgx.Tx

type TxOptions

type TxOptions = pgx.TxOptions