heimdall

Documentation

Overview

Package heimdall manages the acquisition of a lock from PostgreSQL via the `pg_try_advisory_lock(int, int)` function.

Index

• type Lock
  • func New(database, namespace, name string) (lock *Lock, err error)
  • func (l *Lock) Acquire() (lockStatus bool, err error)
  • func (l *Lock) Release()

Types

type Lock

type Lock struct {
	Database  *sql.DB
	Namespace int32
	Name      int32
}

Lock represents the components of a `pg_try_advisory_lock` lock.

func New

func New(database, namespace, name string) (lock *Lock, err error)

New establishes a connection to the PostgreSQL database with a connection string and creates a Lock.

func (*Lock) Acquire

func (l *Lock) Acquire() (lockStatus bool, err error)

Acquire attempts to acquire a lock from PostgreSQL using `pg_try_advisory_lock`.

func (*Lock) Release

func (l *Lock) Release()

Release closes the connection to the database, which releases the lock.