pglock

Aug 8, 2023

Changes in this version

type ClientOption

+ func WithLevelLogger(l LevelLogger) ClientOption

+ type LevelLogger interface

+ Debug func(msg string, args ...any)

+ Error func(msg string, args ...any)

May 18, 2023

Changes in this version

type Client

+ func (c *Client) GetAllLocks() ([]*ReadOnlyLock, error)

+ func (c *Client) GetAllLocksContext(ctx context.Context) ([]*ReadOnlyLock, error)

+ func (c *Client) TryCreateTable() error

+ type ReadOnlyLock Lock

+ func (l *ReadOnlyLock) Data() []byte

+ func (l *ReadOnlyLock) Name() string

+ func (l *ReadOnlyLock) Owner() string

Jun 5, 2022

Changes in this version

type Client

+ func (c *Client) DropTable() error

Nov 8, 2019

Changes in this version

type LockOption

+ func WithCustomHeartbeatContext(ctx context.Context) LockOption

Oct 11, 2019

Changes in this version

type Client

+ func UnsafeNew(db *sql.DB, opts ...ClientOption) (_ *Client, err error)

May 25, 2019

Changes in this version

type Lock

+ func (l *Lock) RecordVersionNumber() int64

Apr 3, 2019

Changes in this version

type Client

+ func Open(dsn string, opts ...ClientOption) (_ *Client, err error)

+ type FailedPreconditionError struct

+ func (err *FailedPreconditionError) Error() string

+ func (err *FailedPreconditionError) Unwrap() error

+ type NotExistError struct

+ func (err *NotExistError) Error() string

+ func (err *NotExistError) Unwrap() error

+ type OtherError struct

+ func (err *OtherError) Error() string

+ func (err *OtherError) Unwrap() error

+ type UnavailableError struct

+ func (err *UnavailableError) Error() string

+ func (err *UnavailableError) Unwrap() error

Jan 26, 2019

Changes in this version

type Client

+ func (c *Client) Get(name string) (*Lock, error)

+ func (c *Client) GetContext(ctx context.Context, name string) (*Lock, error)

type ClientOption

+ func WithOwner(owner string) ClientOption

type Lock

+ func (l *Lock) Owner() string

Dec 28, 2018

Changes in this version

+ const DefaultHeartbeatFrequency

+ const DefaultLeaseDuration

+ const DefaultTableName

+ var ErrDurationTooSmall = errors.E(...)

+ var ErrLockAlreadyReleased = errors.E("lock is already released")

+ var ErrLockNotFound = errors.E(errors.NotExist, "lock not found")

+ var ErrNotAcquired = errors.E("cannot acquire lock")

+ var ErrNotPostgreSQLDriver = errors.E("this is not a PostgreSQL connection")

+ type Client struct

+ func New(db *sql.DB, opts ...ClientOption) (*Client, error)

+ func (c *Client) Acquire(name string, opts ...LockOption) (*Lock, error)

+ func (c *Client) AcquireContext(ctx context.Context, name string, opts ...LockOption) (*Lock, error)

+ func (c *Client) CreateTable() error

+ func (c *Client) Do(ctx context.Context, name string, f func(context.Context, *Lock) error, ...) error

+ func (c *Client) GetData(name string) ([]byte, error)

+ func (c *Client) GetDataContext(ctx context.Context, name string) ([]byte, error)

+ func (c *Client) Release(l *Lock) error

+ func (c *Client) ReleaseContext(ctx context.Context, l *Lock) error

+ func (c *Client) SendHeartbeat(ctx context.Context, l *Lock) error

+ type ClientOption func(*Client)

+ func WithCustomTable(tableName string) ClientOption

+ func WithHeartbeatFrequency(d time.Duration) ClientOption

+ func WithLeaseDuration(d time.Duration) ClientOption

+ func WithLogger(l Logger) ClientOption

+ type Lock struct

+ func (l *Lock) Close() error

+ func (l *Lock) Data() []byte

+ func (l *Lock) IsReleased() bool

+ type LockOption func(*Lock)

+ func FailIfLocked() LockOption

+ func KeepOnRelease() LockOption

+ func ReplaceData() LockOption

+ func WithData(data []byte) LockOption

+ type Logger interface

+ Println func(v ...interface{})