Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pgoutbox

package module

Go to main page

Versions in this module

v0

v0.4.0

Jul 29, 2026

Changes in this version

+ var ErrExclusiveLeaseRequired = errors.New("exclusive lease required: call AcquireTopic first")

+ type AddOpt func(*addOpts)

+ func WithNotifier(n *Notifier) AddOpt

+ type Notifier struct

+ func (n *Notifier) Notify(ctx context.Context)

type Outbox

+ Subscribe func(ctx context.Context, topic string, opts ...SubscribeOpt) error

type OutboxOpt

+ func WithPubSub(ps PubSub) OutboxOpt

+ type PGPubSubOpt func(*pgPubSubOpts)

+ func WithNotifyChannel(name string) PGPubSubOpt

+ func WithNotifyLogger(l zerolog.Logger) PGPubSubOpt

+ type PubSub interface

+ Pub func(ctx context.Context, topic string, payload []byte) error

+ Sub func(ctx context.Context, topic string) (<-chan *PubSubMessage, error)

+ func NewPGPubSub(ctx context.Context, pool *pgxpool.Pool, fs ...PGPubSubOpt) (PubSub, error)

+ type PubSubMessage struct

+ Payload []byte

+ Topic string

+ type SubscribeOpt func(*subscribeOpts)

+ func WithExclusive() SubscribeOpt

+ func WithPollInterval(d time.Duration) SubscribeOpt

+ func WithProcessOpts(popts ...ProcessOpt) SubscribeOpt

+ type TxPublisher interface

+ PubInTx func(ctx context.Context, tx pgx.Tx, topic string, payload []byte) error

v0.3.0

Jul 6, 2026

Changes in this version

type Outbox

+ ReleaseTopic func(ctx context.Context, topic string) error

v0.2.0

Jun 25, 2026

Changes in this version

+ var ErrExclusiveLeaseHeld = errors.New("exclusive lease held by another instance")

+ type FlushContext interface

+ Tx func() pgx.Tx

+ type NopFlusher struct

+ func NewNopFlusher() *NopFlusher

+ func (f *NopFlusher) Flush(_ FlushContext, _ []*sqlc.Message) error

type Outbox

+ AcquireTopic func(ctx context.Context, topic string) error

type OutboxOpt

+ func WithDefaultExpiration(ttl time.Duration) OutboxOpt

+ func WithLogger(l zerolog.Logger) OutboxOpt

+ func WithTopicExpiration(topic string, ttl time.Duration) OutboxOpt

+ type ProcessOpt func(*processOpts)

v0.1.2

Jun 23, 2026

v0.1.1

Jun 22, 2026

v0.1.0

Jun 19, 2026

Changes in this version

+ func Migrate(ctx context.Context, pool *pgxpool.Pool, opts ...OutboxOpt) error

+ type Flusher interface

+ Flush func(ctx context.Context, msgs []*sqlc.Message) error

+ type MessageOpts struct

+ Payload []byte

+ type Outbox interface

+ AddFlusher func(topic string, flusher Flusher)

+ AddMessages func(ctx context.Context, tx pgx.Tx, topic string, msgs []MessageOpts) error

+ ProcessMessages func(ctx context.Context, topic string) ([]*sqlc.Message, error)

+ func NewOutbox(pool *pgxpool.Pool, fs ...OutboxOpt) (Outbox, error)

+ type OutboxOpt func(*outboxImplOpts)

+ func WithAutoMigrate(enabled bool) OutboxOpt

+ func WithBatchSize(n int) OutboxOpt

+ func WithSchema(searchPath string) OutboxOpt

+ type TxFlusher interface

+ FlushWithTx func(ctx context.Context, tx pgx.Tx, msgs []*sqlc.Message) error