postgres

Documentation

Index

• type EventStore
  • func NewEventStore(ctx context.Context, uri string, options ...Option) (*EventStore, error)
  • func NewEventStoreWithConnPool(ctx context.Context, pool *pgxpool.Pool, options ...Option) (*EventStore, error)
  • func (s *EventStore) Close() error
  • func (s *EventStore) Load(ctx context.Context, id uuid.UUID) ([]eh.Event, error)
  • func (s *EventStore) LoadFrom(ctx context.Context, id uuid.UUID, version int) ([]eh.Event, error)
  • func (s *EventStore) LoadSnapshot(ctx context.Context, id uuid.UUID) (*eh.Snapshot, error)
  • func (s *EventStore) Save(ctx context.Context, events []eh.Event, originalVersion int) error
  • func (s *EventStore) SaveSnapshot(ctx context.Context, id uuid.UUID, snapshot eh.Snapshot) error
• type Option
  • func WithEventHandler(h eh.EventHandler) Option
  • func WithEventHandlerInTX(h eh.EventHandler) Option

Types

type EventStore

type EventStore struct {
	// contains filtered or unexported fields
}

EventStore is an eventhorizon.EventStore for PostgreSQL, using one collection for all events and another to keep track of all aggregates/streams. It also keep tracks of the global position of events, stored as metadata.

func NewEventStore

func NewEventStore(ctx context.Context, uri string, options ...Option) (*EventStore, error)

NewEventStore creates a new EventStore with a Postgres URI: `postgres://user:password@hostname:port/db?options`

func NewEventStoreWithConnPool

func NewEventStoreWithConnPool(ctx context.Context, pool *pgxpool.Pool, options ...Option) (*EventStore, error)

func (*EventStore) Close

func (s *EventStore) Close() error

Close closes the database client.

func (*EventStore) Load

func (s *EventStore) Load(ctx context.Context, id uuid.UUID) ([]eh.Event, error)

Load implements the Load method of the eventhorizon.EventStore interface.

func (*EventStore) LoadFrom

func (s *EventStore) LoadFrom(ctx context.Context, id uuid.UUID, version int) ([]eh.Event, error)

LoadFrom implements LoadFrom method of the eventhorizon.SnapshotStore interface.

func (*EventStore) LoadSnapshot

func (s *EventStore) LoadSnapshot(ctx context.Context, id uuid.UUID) (*eh.Snapshot, error)

func (*EventStore) Save

func (s *EventStore) Save(ctx context.Context, events []eh.Event, originalVersion int) error

Save implements the Save method of the eventhorizon.EventStore interface.

func (*EventStore) SaveSnapshot

func (s *EventStore) SaveSnapshot(ctx context.Context, id uuid.UUID, snapshot eh.Snapshot) error

type Option

type Option func(*EventStore) error

Option is an option setter used to configure creation.

func WithEventHandler

func WithEventHandler(h eh.EventHandler) Option

WithEventHandler adds an event handler that will be called after saving events. An example would be to add an event bus to publish events.

func WithEventHandlerInTX

func WithEventHandlerInTX(h eh.EventHandler) Option

WithEventHandlerInTX adds an event handler that will be called during saving of events. An example would be to add an outbox to further process events. For an outbox to be atomic it needs to use the same transaction as the save operation, which is passed down using the context.