locking

Documentation

Overview

Package locking provides functions for acquiring and releasing PostgreSQL advisory locks.

Index

• func AcquireXact(tx *gorm.DB, lockKey string, opts ...Option) error
• type Option
  • func WithRetry(opts *backoff.Options) Option
• type Options

Functions

func AcquireXact

func AcquireXact(tx *gorm.DB, lockKey string, opts ...Option) error

AcquireXact acquires a PostgreSQL transaction-level advisory lock. The caller is responsible for ensuring that a transaction is active, and that the lock is released after use.

Types

type Option

type Option func(*Options)

Option is a function that applies an option to an Options instance.

func WithRetry

func WithRetry(opts *backoff.Options) Option

WithRetry sets the retry options.

type Options

type Options struct {
	Retry *backoff.Options
}

Options represents the locking options.