query

Documentation

Index

• func Test(q snapshot.Query, s snapshot.Snapshot) bool
• type Option
  • func ID(ids ...uuid.UUID) Option
  • func Name(names ...string) Option
  • func SortBy(sort aggregate.Sorting, dir aggregate.SortDirection) Option
  • func SortByMulti(sorts ...aggregate.SortOptions) Option
  • func Time(constraints ...time.Option) Option
  • func Version(constraints ...version.Option) Option
• type Query
  • func New(opts ...Option) Query
  • func (q Query) Times() time.Constraints

Functions

func Test

func Test(q snapshot.Query, s snapshot.Snapshot) bool

Test tests the Snapshot s against the Query q and returns true if q should include s in its results. Test can be used by snapshot.Store implementations to filter events based on the query.

Types

type Option

type Option func(*builder)

func ID

func ID(ids ...uuid.UUID) Option

ID returns an Option that filters Snapshots by their AggregateID:

func Name

func Name(names ...string) Option

Name returns an Option that filters Snapshots by their AggregateName.

func SortBy

func SortBy(sort aggregate.Sorting, dir aggregate.SortDirection) Option

SortBy returns an Option that defines the sorting behaviour for a Query.

func SortByMulti

func SortByMulti(sorts ...aggregate.SortOptions) Option

SortByMulti returns an Option that defines the sorting behaviour for a Query.

func Time

func Time(constraints ...time.Option) Option

Time returns an Option that filters Snapshots by the time they were created.

func Version

func Version(constraints ...version.Option) Option

Version returns an Option that filters Snapshots by their AggregateVersion.

type Query

type Query struct {
	query.Query
	// contains filtered or unexported fields
}

Query is used by Snapshot Stores to filter Snapshots.

func New

func New(opts ...Option) Query

New returns a Query from opts.

func (Query) Times

func (q Query) Times() time.Constraints

Times returns the time.Constraints of the Query.