C# Class EventStore.ClientAPI.Projections.ProjectionsManager

API for managing projections in the Event Store through C# code. Communicates with the Event Store over the RESTful API.

ファイルを表示 Open project: EventStore/EventStore Class Usage Examples

Public Methods

Method	Description
AbortAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task	Asynchronously disables a projection.
CreateContinuousAsync ( string name, string query, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task	Asynchronously creates a continuous projection.
CreateContinuousAsync ( string name, string query, bool trackEmittedStreams, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task	Asynchronously creates a continuous projection.
CreateOneTimeAsync ( string query, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task	Asynchronously creates a one-time query.
CreateTransientAsync ( string name, string query, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task	Asynchronously creates a one-time query.
DeleteAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task	Asynchronously deletes a projection
DeleteAsync ( string name, bool deleteEmittedStreams, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task	Asynchronously deletes a projection
DisableAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task	Asynchronously aborts and disables a projection without writing a checkpoint.
EnableAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task	Asynchronously enables a projection
GetPartitionResultAsync ( string name, string partitionId, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task	Asynchronously gets the state of a projection for a specified partition.
GetPartitionStateAsync ( string name, string partitionId, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task	Asynchronously gets the state of a projection for a specified partition.
GetQueryAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task	Asynchronously gets the status of a query.
GetResultAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task	Asynchronously gets the state of a projection.
GetStateAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task	Asynchronously gets the state of a projection.
GetStatisticsAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task	Asynchronously gets the statistics of a projection.
GetStatusAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task	Asynchronously gets the status of a projection.
ListAllAsync ( EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task>	Asynchronously lists this status of all projections.
ListContinuousAsync ( EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task>	Synchronously lists this status of all continuous projections.
ListOneTimeAsync ( EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task>	Asynchronously lists this status of all one-time projections.
ProjectionsManager ( ILogger log, IPEndPoint httpEndPoint, System.TimeSpan operationTimeout ) : System	Creates a new instance of ProjectionsManager.
UpdateQueryAsync ( string name, string query, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task	Asynchronously updates the definition of a query.

Private Methods

Method	Description
ListAllAsStringAsync ( EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task
ListContinuousAsStringAsync ( EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task
ListOneTimeAsStringAsync ( EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task

Method Details

AbortAsync() public method

Asynchronously disables a projection.

public AbortAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task
name	string	The name of the projection.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for a user with permission to disable a projection.
return	System.Threading.Tasks.Task

CreateContinuousAsync() public method

Asynchronously creates a continuous projection.

public CreateContinuousAsync ( string name, string query, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task
name	string	The name of the projection.
query	string	The JavaScript source code for the query.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for a user with permission to create a query.
return	System.Threading.Tasks.Task

CreateContinuousAsync() public method

Asynchronously creates a continuous projection.

public CreateContinuousAsync ( string name, string query, bool trackEmittedStreams, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task
name	string	The name of the projection.
query	string	The JavaScript source code for the query.
trackEmittedStreams	bool	Whether the streams emitted by this projection should be tracked.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for a user with permission to create a query.
return	System.Threading.Tasks.Task

CreateOneTimeAsync() public method

Asynchronously creates a one-time query.

public CreateOneTimeAsync ( string query, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task
query	string	The JavaScript source code for the query.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for a user with permission to create a query.
return	System.Threading.Tasks.Task

CreateTransientAsync() public method

Asynchronously creates a one-time query.

public CreateTransientAsync ( string name, string query, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task
name	string	A name for the query.
query	string	The JavaScript source code for the query.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for a user with permission to create a query.
return	System.Threading.Tasks.Task

DeleteAsync() public method

Asynchronously deletes a projection

public DeleteAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task
name	string	The name of the projection.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for a user with permission to delete a projection
return	System.Threading.Tasks.Task

DeleteAsync() public method

Asynchronously deletes a projection

public DeleteAsync ( string name, bool deleteEmittedStreams, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task
name	string	The name of the projection.
deleteEmittedStreams	bool	Whether to delete the streams that were emitted by this projection.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for a user with permission to delete a projection
return	System.Threading.Tasks.Task

DisableAsync() public method

Asynchronously aborts and disables a projection without writing a checkpoint.

public DisableAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task
name	string	The name of the projection.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for a user with permission to disable a projection.
return	System.Threading.Tasks.Task

EnableAsync() public method

Asynchronously enables a projection

public EnableAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task
name	string	The name of the projection.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for a user with permission to enable a projection
return	System.Threading.Tasks.Task

GetPartitionResultAsync() public method

Asynchronously gets the state of a projection for a specified partition.

public GetPartitionResultAsync ( string name, string partitionId, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task
name	string	The name of the projection.
partitionId	string	The id of the partition.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for the operation.
return	Task

GetPartitionStateAsync() public method

Asynchronously gets the state of a projection for a specified partition.

public GetPartitionStateAsync ( string name, string partitionId, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task
name	string	The name of the projection.
partitionId	string	The id of the partition.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for the operation.
return	Task

GetQueryAsync() public method

Asynchronously gets the status of a query.

public GetQueryAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task
name	string	The name of the query.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for the operation.
return	Task

GetResultAsync() public method

Asynchronously gets the state of a projection.

public GetResultAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task
name	string	The name of the projection.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for the operation.
return	Task

GetStateAsync() public method

Asynchronously gets the state of a projection.

public GetStateAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task
name	string	The name of the projection.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for the operation.
return	Task

GetStatisticsAsync() public method

Asynchronously gets the statistics of a projection.

public GetStatisticsAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task
name	string	The name of the projection.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for the operation.
return	Task

GetStatusAsync() public method

Asynchronously gets the status of a projection.

public GetStatusAsync ( string name, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task
name	string	The name of the projection.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for the operation.
return	Task

ListAllAsync() public method

Asynchronously lists this status of all projections.

public ListAllAsync ( EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task>
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for the operation.
return	Task>

ListContinuousAsync() public method

Synchronously lists this status of all continuous projections.

public ListContinuousAsync ( EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task>
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for the operation.
return	Task>

ListOneTimeAsync() public method

Asynchronously lists this status of all one-time projections.

public ListOneTimeAsync ( EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : Task>
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for the operation.
return	Task>

ProjectionsManager() public method

Creates a new instance of ProjectionsManager.

public ProjectionsManager ( ILogger log, IPEndPoint httpEndPoint, System.TimeSpan operationTimeout ) : System
log	ILogger	An instance of to use for logging.
httpEndPoint	System.Net.IPEndPoint	HTTP endpoint of an Event Store server.
operationTimeout	System.TimeSpan
return	System

UpdateQueryAsync() public method

Asynchronously updates the definition of a query.

public UpdateQueryAsync ( string name, string query, EventStore.ClientAPI.SystemData.UserCredentials userCredentials = null ) : System.Threading.Tasks.Task
name	string	The name of the query.
query	string	The JavaScript source code of the query.
userCredentials	EventStore.ClientAPI.SystemData.UserCredentials	Credentials for the operation.
return	System.Threading.Tasks.Task