EventStoreProjectionsClient class

Class implementing the Projections Management API..

Projections require the event body of events queried for to be in JSON.

For more information about defining queries, see the user-defined projections API.. See also Projections docs.

Inheritance
Mixed in types

Properties

api → Versions
Get api versions. If verify is not invoked, Versions.server is null.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isGrpcWeb → bool
True if this client is using grpc-web protocol
finalinherited
leader → EndPoint
Get EndPoint for last known leader node. If connecting to a single node, this returns EventStoreClientSettings.singleNode.
no setterinherited
options → CallOptions?
GRPC CallOptions instance
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
settings → EventStoreClientSettings
Connection name supplied as metadata to server
finalinherited
supportsClientStreamingRpc → bool
Check if grpc protocol supports client streaming See https://github.com/grpc/grpc-web/blob/master/doc/interop-test-descriptions.md
no setterinherited

Methods

$createChannel(EndPoint endPoint) → GrpcOrGrpcWebClientChannel
inherited
$getClient() → Future<ProjectionsClient>
inherited
abort(String name, {UserCredentials? userCredentials}) → Future<void>
Abort given projection.
inherited
createContinuous(String name, String query, {bool trackEmittedStreams = false, UserCredentials? userCredentials}) → Future<void>
Creates a continuous projection.
inherited
createOneTime(String query, {UserCredentials? userCredentials}) → Future<void>
Creates a projection that runs until the end of the log and then stops. The query parameter contains the JavaScript you want created as a one time projection. See user-defined projections API. for more information about the query language (javascript).
inherited
createTransient(String name, String query, {UserCredentials? userCredentials}) → Future<void>
Creates a transient projection.
inherited
disable(String name, {UserCredentials? userCredentials}) → Future<void>
Disable given projection.
inherited
discover() → Future<EndPoint>
Discover node EndPoint given current EventStoreClientSettings.nodePreference.
inherited
enable(String name, {UserCredentials? userCredentials}) → Future<void>
Enable given projection.
inherited
getResult(String name, {String? partition, UserCredentials? userCredentials}) → Future
Gets the result of an projection as an untyped json document. The name argument identifies the projection result. The partition argument identifies the partition of given projection.
inherited
getState(String name, {String? partition, UserCredentials? userCredentials}) → Future
Gets the state of an projection as an untyped json document. The name argument identifies the projection state. The partition argument identifies the partition of given projection.
inherited
getStatus(String name, {Duration? timeoutAfter, UserCredentials? userCredentials}) → Future<ProjectionDetails>
Get statistics for all projections. The name argument identifies the projection.
inherited
isFeatureSupported(ApiFeature feature) → bool
Check if given feature is supported by api.
inherited
listAll({UserCredentials? userCredentials}) → Future<List<ProjectionDetails>>
Get statistics for all projections.
inherited
listContinuous({UserCredentials? userCredentials}) → Future<List<ProjectionDetails>>
Get statistics for continuous projections.
inherited
listOneTime({UserCredentials? userCredentials}) → Future<List<ProjectionDetails>>
Get statistics for one-time projections.
inherited
listTransient({UserCredentials? userCredentials}) → Future<List<ProjectionDetails>>
Get statistics for transient projections.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reset(String name, {UserCredentials? userCredentials}) → Future<void>
Reset given projection back to beginning of the log.
inherited
restartSubsystem({UserCredentials? userCredentials}) → Future<void>
Restarts the projection subsystem.
inherited
shutdown() → Future<void>
Shutdown all channels
inherited
toString() → String
A string representation of this object.
inherited
update(String name, String query, {bool? emitEnabled, UserCredentials? userCredentials}) → Future<void>
Updates given projection. The name parameter identifies the projection that is updated. The query parameter contains the updated JavaScript. See user-defined projections API. for more information about the query language (javascript). The emitEnabled parameter controls if projection emits events
inherited
verify() → Future<void>
Verify that EventStoreClientSettings.apiVersion is compatible with server version. Throws a UnsupportedApiVersionException if MemberInfo.apiVersion is incompatible with requested EventStoreClientSettings.apiVersion.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited