Data Subscriptions: Maintenance Operations

The DocumentSubscriptions class is the class that manages all interaction with the data subscriptions.
The class is available through DocumentStore's Subscriptions property.

Subscriptions can be entirely deleted from the system.

This operation can be very useful in ad-hoc subscription scenarios when a lot of subscriptions tasks information may accumulate, making tasks management very hard.

void Delete(string name, string database = null);
Task DeleteAsync(string name, string database = null, CancellationToken token = default);

usage:

store.Subscriptions.Delete(subscriptionName);

Existing subscription tasks can be disabled from the client.

void Disable(string name, string database = null);
Task DisableAsync(string name, string database = null, CancellationToken token = default);

usage:

store.Subscriptions.Disable(subscriptionName);

Existing subscription tasks can be enabled from the client.
This operation can be useful for already disabled subscriptions.

void Enable(string name, string database = null);
Task EnableAsync(string name, string database = null, CancellationToken token = default);

usage:

store.Subscriptions.Enable(subscriptionName);

See examples and API description.

string Update(SubscriptionUpdateOptions options, string database = null);

Task<string> UpdateAsync(SubscriptionUpdateOptions options, string database = null,
                    CancellationToken token = default);

Active subscription connections established by workers can be dropped remotely from the client.
Once dropped, the worker will not attempt to reconnect to the server.

void DropConnection(string name, string database = null);
Task DropConnectionAsync(string name, string database = null, CancellationToken token = default);

usage:

store.Subscriptions.DropConnection(subscriptionName);

SubscriptionState GetSubscriptionState(string subscriptionName, string database = null);
Task<SubscriptionState> GetSubscriptionStateAsync(string subscriptionName, string database = null, CancellationToken token = default);

usage:

var subscriptionState = store.Subscriptions.GetSubscriptionState(subscriptionName);