boltdblib

Documentation

Index

• func Open(path string) (*bolt.DB, error)
• func TxFromContext(ctx context.Context) (*bolt.Tx, bool)
• func Update(ctx context.Context, db *bolt.DB, update func(tx *bolt.Tx) error) error
• func View(ctx context.Context, db *bolt.DB, view func(tx *bolt.Tx) error) error
• type TracingContext
  • func NewTracingContext(ctx TxContext) *TracingContext
  • func (t *TracingContext) Commit() error
  • func (t *TracingContext) Rollback() error
  • func (t *TracingContext) WithTracingDuration(d time.Duration) *TracingContext
• type TxContext
  • func NewTxContext(ctx context.Context, tx *bolt.Tx) TxContext

Functions

func Open

func Open(path string) (*bolt.DB, error)

func TxFromContext

func TxFromContext(ctx context.Context) (*bolt.Tx, bool)

TxFromContext retrieves the transaction from the context, if available.

func Update

func Update(ctx context.Context, db *bolt.DB, update func(tx *bolt.Tx) error) error

Update is a helper function that will update the job in the store it accepts a context, an update function and creates a new transaction to perform the update if no transaction is provided in the context

func View

func View(ctx context.Context, db *bolt.DB, view func(tx *bolt.Tx) error) error

View is a helper function that will perform a read-only operation on the store it accepts a context, a view function and creates a new transaction to perform the view if no transaction is provided in the context

Types

type TracingContext

type TracingContext struct {
	TxContext
	// contains filtered or unexported fields
}

TracingContext is a context that can be used to trace the duration of a transaction and log a debug message if it exceeds a certain threshold.

func NewTracingContext

func NewTracingContext(ctx TxContext) *TracingContext

NewTracingContext creates a new tracing context

func (*TracingContext) Commit

func (t *TracingContext) Commit() error

func (*TracingContext) Rollback

func (t *TracingContext) Rollback() error

func (*TracingContext) WithTracingDuration

func (t *TracingContext) WithTracingDuration(d time.Duration) *TracingContext

WithTracingDuration sets the duration threshold for transaction tracing

type TxContext

type TxContext interface {
	context.Context
	Commit() error
	Rollback() error
}

TxContext is a transactional context that can be used to commit or rollback

func NewTxContext

func NewTxContext(ctx context.Context, tx *bolt.Tx) TxContext

NewTxContext creates a new transactional context for a BoltDB transaction. It embeds a standard context and manages transaction commit/rollback based on the context's lifecycle.