mrpostgres

Documentation

Index

• type ConnAdapter
  • func New() *ConnAdapter
  • func (c *ConnAdapter) Cli() (*pgxpool.Pool, error)
  • func (c *ConnAdapter) Close() error
  • func (c *ConnAdapter) Connect(ctx context.Context, opts Options) error
  • func (c *ConnAdapter) Exec(ctx context.Context, sql string, args ...any) error
  • func (c *ConnAdapter) HijackConn(ctx context.Context) (*pgx.Conn, error)
  • func (c *ConnAdapter) Ping(ctx context.Context) error
  • func (c *ConnAdapter) Query(ctx context.Context, sql string, args ...any) (mrstorage.DBQueryRows, error)
  • func (c *ConnAdapter) QueryRow(ctx context.Context, sql string, args ...any) mrstorage.DBQueryRow
• type ConnManager
  • func NewConnManager(conn *ConnAdapter, logger mrlog.Logger) *ConnManager
  • func (m *ConnManager) Conn(ctx context.Context) mrstorage.DBConn
  • func (m *ConnManager) ConnAdapter() *ConnAdapter
  • func (m *ConnManager) Do(ctx context.Context, job func(ctx context.Context) error) error
• type Options
• type ProcessWaitForNotification
  • func NewProcessWaitForNotification(conn *ConnAdapter, logger mrlog.Logger, channels []string) *ProcessWaitForNotification
  • func (p *ProcessWaitForNotification) Caption() string
  • func (p *ProcessWaitForNotification) ReadyTimeout() time.Duration
  • func (p *ProcessWaitForNotification) Shutdown(ctx context.Context) error
  • func (p *ProcessWaitForNotification) Start(ctx context.Context, ready func()) error
• type ReceiverChannel
• type ReceiverChannels
  • func (rc *ReceiverChannels) Find(name string) (<-chan struct{}, error)
  • func (rc *ReceiverChannels) MustFind(name string) <-chan struct{}
• type TxManagerStub
  • func NewTxManagerStub() *TxManagerStub
  • func (m *TxManagerStub) Do(ctx context.Context, job func(ctx context.Context) error) error

Types

type ConnAdapter

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

ConnAdapter - адаптер для работы с Postgres клиентом.

func New

func New() *ConnAdapter

New - создаёт объект ConnAdapter.

func (*ConnAdapter) Cli

func (c *ConnAdapter) Cli() (*pgxpool.Pool, error)

Cli - возвращается нативный объект, с которым работает данный адаптер.

func (*ConnAdapter) Close

func (c *ConnAdapter) Close() error

Close - закрывает пул соединений.

func (*ConnAdapter) Connect

func (c *ConnAdapter) Connect(ctx context.Context, opts Options) error

Connect - создаёт пул соединений с указанными опциями.

func (*ConnAdapter) Exec

func (c *ConnAdapter) Exec(ctx context.Context, sql string, args ...any) error

Exec - отправляет SQL запрос к БД и исполняет его.

func (*ConnAdapter) HijackConn

func (c *ConnAdapter) HijackConn(ctx context.Context) (*pgx.Conn, error)

HijackConn - извлекает соединение из пула, которое будет использоваться независимо от него и должно быть закрыто тем, кто вызвал данный метод.

func (*ConnAdapter) Ping

func (c *ConnAdapter) Ping(ctx context.Context) error

Ping - проверяет работоспособность пула соединений.

func (*ConnAdapter) Query

func (c *ConnAdapter) Query(ctx context.Context, sql string, args ...any) (mrstorage.DBQueryRows, error)

Query - отправляет SQL запрос к БД и возвращает результат в виде списка записей.

func (*ConnAdapter) QueryRow

func (c *ConnAdapter) QueryRow(ctx context.Context, sql string, args ...any) mrstorage.DBQueryRow

QueryRow - отправляет SQL запрос к БД и возвращает результат в виде одной записи.

type ConnManager

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

ConnManager - менеджер транзакций.

func NewConnManager

func NewConnManager(conn *ConnAdapter, logger mrlog.Logger) *ConnManager

NewConnManager - создаёт объект ConnManager.

func (*ConnManager) Conn

func (m *ConnManager) Conn(ctx context.Context) mrstorage.DBConn

Conn - возвращает соединение с PostgreSQL или транзакцию, если она была открыта.

func (*ConnManager) ConnAdapter

func (m *ConnManager) ConnAdapter() *ConnAdapter

ConnAdapter - возвращает соединение с PostgreSQL.

func (*ConnManager) Do

func (m *ConnManager) Do(ctx context.Context, job func(ctx context.Context) error) error

Do - запускает задачу с запросом в транзакции. Пытается запустить в текущей транзакции, если ее нет, создает новую транзакцию.

type Options

type Options struct {
	DSN             string // если указано, то Host, Port, Database, Username не используются, но Password более приоритетен если явно указан
	Host            string
	Port            string
	Database        string
	Username        string
	Password        string
	MaxPoolSize     int
	MaxConnLifetime time.Duration
	MaxConnIdleTime time.Duration
	ConnTimeout     time.Duration
	QueryTracer     pgx.QueryTracer
	AfterConnect    func(ctx context.Context, conn *pgx.Conn) error
}

Options - опции для создания соединения для ConnAdapter.

type ProcessWaitForNotification

type ProcessWaitForNotification struct {
	ReceiverChannels ReceiverChannels
	// contains filtered or unexported fields
}

ProcessWaitForNotification - объект для прослушивания и обработки событий присылаемых БД.

func NewProcessWaitForNotification

func NewProcessWaitForNotification(
	conn *ConnAdapter,
	logger mrlog.Logger,
	channels []string,
) *ProcessWaitForNotification

NewProcessWaitForNotification - создаёт объект ProcessWaitForNotification.

func (*ProcessWaitForNotification) Caption

func (p *ProcessWaitForNotification) Caption() string

Caption - comment struct.

func (*ProcessWaitForNotification) ReadyTimeout

func (p *ProcessWaitForNotification) ReadyTimeout() time.Duration

ReadyTimeout - comment struct.

func (*ProcessWaitForNotification) Shutdown

func (p *ProcessWaitForNotification) Shutdown(ctx context.Context) error

Shutdown - comment struct.

func (*ProcessWaitForNotification) Start

func (p *ProcessWaitForNotification) Start(ctx context.Context, ready func()) error

Start - comment struct.

type ReceiverChannel

type ReceiverChannel struct {
	Name    string
	Channel <-chan struct{}
}

ReceiverChannel - comment struct.

type ReceiverChannels

type ReceiverChannels []ReceiverChannel

ReceiverChannels - comment array.

func (*ReceiverChannels) Find

func (rc *ReceiverChannels) Find(name string) (<-chan struct{}, error)

Find - comment method.

func (*ReceiverChannels) MustFind

func (rc *ReceiverChannels) MustFind(name string) <-chan struct{}

MustFind - comment method.

type TxManagerStub

type TxManagerStub struct{}

TxManagerStub - фиктивный менеджер транзакций, который запускает только переданную работу без открытия транзакции.

func NewTxManagerStub

func NewTxManagerStub() *TxManagerStub

NewTxManagerStub - создаёт объект TxManagerStub.

func (*TxManagerStub) Do

func (m *TxManagerStub) Do(ctx context.Context, job func(ctx context.Context) error) error

Do - запускает работу без использования транзакции.