Interface IMaterializedReadModels

Namespace
Cratis.Chronicle.ReadModels
Assembly
Cratis.Chronicle.dll

Defines a system for working with materialized read model instances.

public interface IMaterializedReadModels
Extension Methods

Methods

GetInstances<TReadModel>(InstanceCountToSkip?, InstanceCount?)

Get paginated instances of a read model from the sink.

Task<IEnumerable<TReadModel>> GetInstances<TReadModel>(InstanceCountToSkip? skip = null, InstanceCount? take = null)

Parameters

skip InstanceCountToSkip

Number of instances to skip. Defaults to zero.

take InstanceCount

Number of instances to retrieve. Defaults to 50.

Returns

Task<IEnumerable<TReadModel>>

Collection of read model instances.

Type Parameters

TReadModel

The read model type.

ObserveInstances<TReadModel>(InstanceCountToSkip?, InstanceCount?)

Observe changes for a paginated window of read model instances.

IObservable<IEnumerable<TReadModel>> ObserveInstances<TReadModel>(InstanceCountToSkip? skip = null, InstanceCount? take = null)

Parameters

skip InstanceCountToSkip

Number of instances to skip. Defaults to zero.

take InstanceCount

Number of instances to observe. Defaults to 50.

Returns

IObservable<IEnumerable<TReadModel>>

An observable of IEnumerable<T>.

Type Parameters

TReadModel

Type of read model to observe changes for.