database

Documentation

Index

• type Lock
  • func (l *Lock) Close() error
  • func (l *Lock) Lock(ctx context.Context) (bool, error)
  • func (l *Lock) Unlock(ctx context.Context) error
  • func (l *Lock) WaitAndLock(ctx context.Context) error
• type Locker

Types

type Lock

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

Lock implements the Locker interface.

func (*Lock) Close

func (l *Lock) Close() error

Close closes the DB connection, consequently releasing all locks.

func (*Lock) Lock

func (l *Lock) Lock(ctx context.Context) (bool, error)

Lock obtains exclusive session level advisory lock if available. It’s similar to WaitAndLock, except it will not wait for the lock to become available. It will either obtain the lock and return true, or return false if the lock cannot be acquired immediately.

func (*Lock) Unlock

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

Unlock releases the lock.

func (*Lock) WaitAndLock

func (l *Lock) WaitAndLock(ctx context.Context) error

WaitAndLock obtains exclusive session level advisory lock. If another session already holds a lock on the same resource identifier, this function will wait until the resource becomes available. Multiple lock requests stack, so that if the resource is locked three times it must then be unlocked three times.

type Locker

type Locker interface {
	Lock(ctx context.Context) (bool, error)
	WaitAndLock(ctx context.Context) error
	Unlock(ctx context.Context) error
	Close() error
}

Locker simple interface for reusing the lock elsewhere