outbox

Aug 14, 2026

Changes in this version

+ const DefaultChannel

+ const DefaultTable

+ var ErrDispatcherClosed = errors.New("outbox: the dispatcher is closed")

+ func DDL(opts Options) (string, error)

+ func Install(ctx context.Context, exec sqlb.Executor, opts Options) error

+ type Dispatcher struct

+ func MustDispatcher(d *Dispatcher, err error) *Dispatcher

+ func NewDispatcher(ctx context.Context, pool *pgxpool.Pool, opts DispatcherOptions) (*Dispatcher, error)

+ func (d *Dispatcher) Close()

+ func (d *Dispatcher) Run(ctx context.Context) error

+ func (d *Dispatcher) Stats() Stats

+ func (d *Dispatcher) Subscribe(ctx context.Context, since uint64) (<-chan rest.Delivery, error)

+ type DispatcherOptions struct

+ Batch int

+ Buffer int

+ DisableReplay bool

+ MaxReplay int

+ Poll time.Duration

+ StartAtBeginning bool

+ type Options struct

+ Channel string

+ OnError func(error)

+ Retention time.Duration

+ Table string

+ type Outbox struct

+ func Must(o *Outbox, err error) *Outbox

+ func New(exec sqlb.Executor, opts Options) (*Outbox, error)

+ func (o *Outbox) Prune(ctx context.Context) (int64, error)

+ func (o *Outbox) Publish(events ...rest.Event)

+ func (o *Outbox) Record(ctx context.Context, events ...rest.Event) error

+ func (o *Outbox) Table() string

+ type Stats struct

+ Cursor uint64

+ Delivered uint64

+ Listening bool

+ Notifications uint64

+ Subscribers int