Data Subscriptions: Maintenance Operations

Subscription tasks can be entirely deleted from the system.

await documentStore.subscriptions.delete("subscriptionNameToDelete");

// Available overloads:
delete(name);
delete(name, database);

Existing subscription tasks can be disabled from the client.

await documentStore.subscriptions.disable("subscriptionNameToDisable");

// Available overloads:
disable(name);
disable(name, database);

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

await documentStore.subscriptions.enable("subscriptionNameToEnable");

// Available overloads:
enable(name);
enable(name, database);

See examples and API description.

const updateOptions = {
    id: "<theSubscriptionId>",
    query: "<theSubscriptionQuery>"
    // ...
}
await documentStore.subscriptions.update(updateOptions);

// Available overloads:
update(options);
update(options, database);

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.

// Drop all connections to the subscription:
// =========================================

await documentStore.subscriptions.dropConnection("subscriptionName");

// Drop specific worker connection:
// ===============================

const workerOptions = {
    subscriptionName: "subscriptionName",
    // ...
};

const worker = documentStore.subscriptions.getSubscriptionWorker(workerOptions);


worker.on("batch", (batch, callback) => {
    // worker processing logic 
});

await documentStore.subscriptions.dropConnection(worker);

// Available overloads:
dropConnection(options);
dropConnection(options, database);
dropSubscriptionWorker(worker); 
dropSubscriptionWorker(worker, database); 

Get a list of all existing subscription tasks in the database.

const subscriptions = await documentStore.subscriptions.getSubscriptions(0, 10);

// Available overloads:
getSubscriptions(start, take);
getSubscriptions(start, take, database);

const subscriptionState = 
    await documentStore.subscriptions.getSubscriptionState("subscriptionName");

// Available overloads:
getSubscriptionState(subscriptionName);
getSubscriptionState(subscriptionName, database);

The DocumentSubscriptions class manages all interaction with the data subscriptions.
The class is available through the subscriptions property in the documentStore.