postgres

Documentation

Index

• type Option
  • func WithConnAttempts(connAttempts int) Option
  • func WithConnTimeout(connTimeout time.Duration) Option
  • func WithLogger(log logger.Logger) Option
  • func WithMaxPoolSize(maxSize int) Option
• type Postgres
  • func New(ctx context.Context, url string, opts ...Option) (*Postgres, error)
  • func (p *Postgres) Close()
  • func (p *Postgres) GetTransactionConn(ctx context.Context) trmpgx.Tr

Types

type Option

type Option func(*Postgres) error

Option defines the functional option pattern for configuring Postgres.

func WithConnAttempts

func WithConnAttempts(connAttempts int) Option

WithConnAttempts sets the number of connection attempts.

func WithConnTimeout

func WithConnTimeout(connTimeout time.Duration) Option

WithConnTimeout sets the connection timeout.

func WithLogger

func WithLogger(log logger.Logger) Option

WithLogger sets the logger.

func WithMaxPoolSize

func WithMaxPoolSize(maxSize int) Option

WithMaxPoolSize sets the maximum pool size.

type Postgres

type Postgres struct {
	// Use Pool for better performance if there are no transactions.
	Pool *pgxpool.Pool
	// Use TrManager to work with transactions.
	TrManager *manager.Manager
	// contains filtered or unexported fields
}

Postgres represents a Postgres instance with pool and transaction manager.

func New

func New(ctx context.Context, url string, opts ...Option) (*Postgres, error)

New creates a new Postgres instance with given url and functional options.

func (*Postgres) Close

func (p *Postgres) Close()

Close closes the Postgres pool.

func (*Postgres) GetTransactionConn

func (p *Postgres) GetTransactionConn(ctx context.Context) trmpgx.Tr