ev

package module

v0.1.2 Latest Latest Go to latest Published: Oct 1, 2023 License: BSD-3-Clause Imports: 11 Imported by: 6

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/sour-is/ev

Links

Open Source Insights

README ¶

ev - Eventsourcing Playground

This project is learnings in building an eventstore and applications around it.

Feel free to explore.

For examples of use of this see <go.sour.is/tools>

Documentation ¶

Overview ¶

package es implements an event store and drivers for extending its functionality.

Index ¶

Constants
Variables
func Create[A any, T PA[A]](ctx context.Context, es *EventStore, streamID string, ...) (agg T, err error)
func Init(ctx context.Context) error
func Register(ctx context.Context, name string, d driver.Driver) error
func Unwrap[T any](t T) T
func Update[A any, T PA[A]](ctx context.Context, es *EventStore, streamID string, ...) (agg T, err error)
func Upsert[A any, T PA[A]](ctx context.Context, es *EventStore, streamID string, ...) (agg T, err error)
type EventStore
- func Open(ctx context.Context, dsn string, options ...Option) (*EventStore, error)
type Option
type PA
type PE

Constants ¶

View Source

const AllEvents = int64(AppendOnly >> 1)

View Source

const AppendOnly = ^uint64(0)

Variables ¶

View Source

var (
	Mes_open   metric.Int64Counter
	Mes_read   metric.Int64Counter
	Mes_load   metric.Int64Counter
	Mes_save   metric.Int64Counter
	Mes_append metric.Int64Counter
)

View Source

var ErrNoDriver = errors.New("no driver")

View Source

var ErrNotFound = errors.New("not found")

View Source

var ErrShouldExist = event.ErrShouldExist

View Source

var ErrShouldNotExist = event.ErrShouldNotExist

View Source

var ErrWrongVersion = errors.New("wrong version")

Functions ¶

func Create ¶

func Create[A any, T PA[A]](ctx context.Context, es *EventStore, streamID string, fn func(context.Context, T) error) (agg T, err error)

Create uses fn to create a new aggregate and store in db.

func Init ¶

func Init(ctx context.Context) error

func Register ¶

func Register(ctx context.Context, name string, d driver.Driver) error

func Unwrap ¶

func Unwrap[T any](t T) T

func Update ¶

func Update[A any, T PA[A]](ctx context.Context, es *EventStore, streamID string, fn func(context.Context, T) error) (agg T, err error)

Update uses fn to update an exsisting aggregate and store in db.

func Upsert ¶

func Upsert[A any, T PA[A]](ctx context.Context, es *EventStore, streamID string, fn func(context.Context, T) error) (agg T, err error)

Update uses fn to update an exsisting aggregate and store in db.

Types ¶

type EventStore ¶

type EventStore struct {
	driver.Driver
}

func Open ¶

func Open(ctx context.Context, dsn string, options ...Option) (*EventStore, error)

func (*EventStore) Append ¶

func (es *EventStore) Append(ctx context.Context, streamID string, events event.Events) (uint64, error)

func (*EventStore) EventStream ¶

func (es *EventStore) EventStream() driver.EventStream

func (*EventStore) FirstIndex ¶

func (es *EventStore) FirstIndex(ctx context.Context, streamID string) (uint64, error)

func (*EventStore) LastIndex ¶

func (es *EventStore) LastIndex(ctx context.Context, streamID string) (uint64, error)

func (*EventStore) Load ¶

func (es *EventStore) Load(ctx context.Context, agg event.Aggregate) error

func (*EventStore) Option ¶

func (es *EventStore) Option(options ...Option)

func (*EventStore) Read ¶

func (es *EventStore) Read(ctx context.Context, streamID string, after, count int64) (event.Events, error)

func (*EventStore) ReadN ¶

func (es *EventStore) ReadN(ctx context.Context, streamID string, index ...uint64) (event.Events, error)

func (*EventStore) Save ¶

func (es *EventStore) Save(ctx context.Context, agg event.Aggregate) (uint64, error)

func (*EventStore) Truncate ¶

func (es *EventStore) Truncate(ctx context.Context, streamID string, index int64) error

type Option ¶

type Option interface {
	Apply(*EventStore)
}

type PA ¶

type PA[T any] interface {
	event.Aggregate
	*T
}

type PE ¶

type PE[T any] interface {
	event.Event
	*T
}

Source Files ¶

View all Source files

ev.go

Directories ¶

Path	Synopsis
driver package driver defines interfaces to be used by driver implementations.	package driver defines interfaces to be used by driver implementations.
disk-store
mem-store package memstore provides a driver that reads and writes events to memory.	package memstore provides a driver that reads and writes events to memory.
projecter package projecter provides a driver middleware to derive new events from other events.	package projecter provides a driver middleware to derive new events from other events.
resolve-links
streamer package streamer provides a driver to allow awaiting for new events to be added to a stream.	package streamer provides a driver to allow awaiting for new events to be added to a stream.
event package event implements functionality for working with an eventstore.	package event implements functionality for working with an eventstore.
gql
internal
clean

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL