Projections class

Utility class for projections

The name parameter is used as an identifier for operations on the created projection. The id of the resulting stream is by default \$projections-${name}-result if resultStreamName is not given with the options method in the query,

options({
  resultStreamName: "my_demo_projection_result",
  $includeLinks: false,
  reorderEvents: false,
  processingLag: 0
})

Projections Management API.

Projections docs

user-defined projections API.

Constructors

Projections()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

onState(List<String> names, EventStoreStreamsClient client, {UserCredentials? userCredentials, FutureOr<void> onTimeout()?, String eventType = SystemEvents.ProjectionUpdated, Duration? timeoutAfter = Defaults.OperationTimeout}) → Future<List<ResolvedEvent>>

Returns when system streams are running

onStatus(ProjectionStatus status, List<String> names, EventStoreProjectionsClient client, {UserCredentials? userCredentials, FutureOr<void> onTimeout()?, Duration? timeoutAfter = Defaults.OperationTimeout}) → Future<void>

Returns when system streams are running

resultStreamId(String name) → String

Get stream id of state-stream generated by stateful projections from projection name. The name parameter is used as an identifier for operations on the created projection. The id of the resulting stream is by default \$projections-${name}-result if resultStreamName is not given with the options method in the query,

stateStreamId(String name) → String

Get stream id of result-stream generated by stateful projections from projection name. The name parameter is used as an identifier for operations on the created projection. The id of the resulting stream is by default \$projections-${name}-result if resultStreamName is not given with the options method in the query,