mongodb

Documentation

Index

• type EventStore
  • func NewEventStore(uri, dbName string, options ...Option) (*EventStore, error)
  • func NewEventStoreWithClient(client *mongo.Client, dbName string, options ...Option) (*EventStore, error)
  • func NewMongoDBEventStore(db eh.MongoDB, options ...Option) (*EventStore, error)
  • func (s *EventStore) Clear(ctx context.Context) error
  • func (s *EventStore) Close() error
  • func (s *EventStore) EventsCollectionName() string
  • 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) RenameEvent(ctx context.Context, from, to eh.EventType) error
  • func (s *EventStore) Replace(ctx context.Context, event eh.Event) error
  • func (s *EventStore) Save(ctx context.Context, events []eh.Event, originalVersion int) error
• type Option
  • func WithCollectionName(eventsColl string) 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 implements an eventhorizon.EventStore for MongoDB using a single collection with one document per aggregate/stream which holds its events as values.

func NewEventStore

func NewEventStore(uri, dbName string, options ...Option) (*EventStore, error)

NewEventStore creates a new EventStore with a MongoDB URI: `mongodb://hostname`.

func NewEventStoreWithClient

func NewEventStoreWithClient(client *mongo.Client, dbName string, options ...Option) (*EventStore, error)

NewEventStoreWithClient creates a new EventStore with a client.

func NewMongoDBEventStore

func NewMongoDBEventStore(db eh.MongoDB, options ...Option) (*EventStore, error)

NewMongoDBEventStore creates a new EventStore using the eventhorizon.MongoDB interface.

func (*EventStore) Clear

func (s *EventStore) Clear(ctx context.Context) error

Clear implements the Clear method of the eventhorizon.EventStoreMaintenance interface.

func (*EventStore) Close

func (s *EventStore) Close() error

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

func (*EventStore) EventsCollectionName

func (s *EventStore) EventsCollectionName() string

EventsCollectionName returns the name of the events collection.

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 loads all events from version for the aggregate id from the store.

func (*EventStore) RenameEvent

func (s *EventStore) RenameEvent(ctx context.Context, from, to eh.EventType) error

RenameEvent implements the RenameEvent method of the eventhorizon.EventStoreMaintenance interface.

func (*EventStore) Replace

func (s *EventStore) Replace(ctx context.Context, event eh.Event) error

Replace implements the Replace method of the eventhorizon.EventStoreMaintenance interface.

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.

type Option

type Option func(*EventStore) error

Option is an option setter used to configure creation.

func WithCollectionName

func WithCollectionName(eventsColl string) Option

WithCollectionName uses a different event collection than the default "events".

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.