ehpg

README

EventHorizon with REDIS

Features

• EventStore

	
    options := redis.UniversalOptions{
		Addrs:              "localhost",
		DB:                 1,
		Password:           "mypassword",
	}

    db := redis.NewUniversalClient(&options)

    defer db.close()

    store, err := ehre.NewEventStore(db)

Documentation

Index

• Variables
• type AggregateEvent
  • func (a AggregateEvent) MarshalBinary() (data []byte, err error)
  • func (a *AggregateEvent) UnmarshalBinary(data []byte) error
• type AggregateRecord
• type Encoder
• type EventStore
  • func NewEventStore(db redis.UniversalClient) (*EventStore, error)
  • func (s *EventStore) Clear(ctx context.Context) error
  • func (s *EventStore) Close() error
  • func (s *EventStore) Load(ctx context.Context, id uuid.UUID) ([]eh.Event, error)
  • func (s *EventStore) Save(ctx context.Context, events []eh.Event, originalVersion int) error

Variables

var ErrCouldNotClearDB = errors.New("could not clear database")

ErrCouldNotClearDB is when the database could not be cleared.

var ErrCouldNotMarshalEvent = errors.New("could not marshal event")

ErrCouldNotMarshalEvent is when an event could not be marshaled into JSON.

var ErrCouldNotSaveAggregate = errors.New("could not save aggregate")

ErrCouldNotSaveAggregate is when an aggregate could not be saved.

var ErrCouldNotUnmarshalEvent = errors.New("could not unmarshal event")

ErrCouldNotUnmarshalEvent is when an event could not be unmarshalled into a concrete type.

var ErrVersionConflict = errors.New("can not create/update aggregate")

ErrConflictVersion is when a version conflict occurs when saving an aggregate.

var NewUUID = uuid.New

NewUUID for mocking in tests

Types

type AggregateEvent

type AggregateEvent struct {
	EventID       uuid.UUID
	Namespace     string
	AggregateID   uuid.UUID
	AggregateType eh.AggregateType
	EventType     eh.EventType
	RawEventData  json.RawMessage
	Timestamp     time.Time
	Version       int
	Context       map[string]interface{}
	MetaData      map[string]interface{}

	RawMetaData json.RawMessage
	// contains filtered or unexported fields
}

func (AggregateEvent) MarshalBinary

func (a AggregateEvent) MarshalBinary() (data []byte, err error)

func (*AggregateEvent) UnmarshalBinary

func (a *AggregateEvent) UnmarshalBinary(data []byte) error

type AggregateRecord

type AggregateRecord struct {
	Namespace   string
	AggregateID uuid.UUID
	Version     int
}

type Encoder

type Encoder interface {
	Marshal(eh.EventData) ([]byte, error)
	Unmarshal(eh.EventType, []byte) (eh.EventData, error)
	String() string
}

type EventStore

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

EventStore implements an eh.EventStore for PostgreSQL.

func NewEventStore

func NewEventStore(db redis.UniversalClient) (*EventStore, error)

NewEventStore creates a new EventStore.

func (*EventStore) Clear

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

Clear clears the event storage.

func (*EventStore) Close

func (s *EventStore) Close() error

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) Save

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

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