db

Documentation

Index

• Variables
• type Client
  • func New(cfg Config) (*Client, error)
  • func (c Client) TryLock(ctx context.Context, id string) (*Lock, error)
  • func (c Client) WithTimeout(ctx context.Context, collection, operation string, ...) (err error)
  • func (c Client) WithTxn(ctx context.Context, txnOptions sql.TxOptions, txFunc func(*sqlx.Tx) error) (err error)
• type Config
• type Lock
  • func (l Lock) Unlock(ctx context.Context) error

Variables

var (
	ErrLockBusy = errors.New("lock busy")
)

Types

type Client

type Client struct {
	*sqlx.DB
	// contains filtered or unexported fields
}

func New

func New(cfg Config) (*Client, error)

func (Client) TryLock

func (c Client) TryLock(ctx context.Context, id string) (*Lock, error)

TryLock uses postgres advisory locks to acquire a lock on a given id if acquired, it returns the Lock object, else fail with ErrLockBusy In worst case if not unlocked, it will be released after the session ends which is configured via SetConnMaxLifetime

func (Client) WithTimeout

func (c Client) WithTimeout(ctx context.Context, collection, operation string, op func(ctx context.Context) error) (err error)

func (Client) WithTxn

func (c Client) WithTxn(ctx context.Context, txnOptions sql.TxOptions, txFunc func(*sqlx.Tx) error) (err error)

WithTxn Handling transactions: https://stackoverflow.com/a/23502629/8244298

type Config

type Config struct {
	Driver          string        `yaml:"driver" mapstructure:"driver" default:"postgres"`
	URL             string        `yaml:"url" mapstructure:"url"`
	MaxIdleConns    int           `yaml:"max_idle_conns" mapstructure:"max_idle_conns" default:"10"`
	MaxOpenConns    int           `yaml:"max_open_conns" mapstructure:"max_open_conns" default:"10"`
	ConnMaxLifeTime time.Duration `yaml:"conn_max_life_time" mapstructure:"conn_max_life_time" default:"15m"`
	MaxQueryTimeout time.Duration `yaml:"max_query_timeout" mapstructure:"max_query_timeout" default:"5s"`
}

type Lock

type Lock struct {
	ID int64
	// contains filtered or unexported fields
}

func (Lock) Unlock

func (l Lock) Unlock(ctx context.Context) error

Unlock uses postgres advisory locks to release a lock on a given id