Create and Update Subscription API

Subscriptions can be created using the following create methods available through the subscriptions property of the DocumentStore.

// Available overloads:
// ====================

create(options);

create(options, database);

create(documentType);

Examples for creating subscriptions are available here.

// The SubscriptionCreationOptions object:
// =======================================
{
    name;
    query;
    includes;
    changeVector;
    mentorNode;
    pinToMentorNode;
    disabled;
    documentType;
}

Including documents:

includeDocuments(path);

An example of including documents is available here.

Including counters:

// Include a single counter
includeCounter(name);

// Include multiple counters
includeCounters(names);

// Include ALL counters from ALL documents that match the subscription criteria
includeAllCounters();

An example of including counters is available here.

Including time series:

includeTimeSeries(name, type, time);
includeTimeSeries(name, type, count);

includeTimeSeries(names, type, time);
includeTimeSeries(names, type, count);

includeAllTimeSeries(type, time);
includeAllTimeSeries(type, count);

Existing subscriptions can be modified using the following update methods available through the subscriptions property of the DocumentStore.

// Available overloads:
// ====================

update(options);

update(options, database);

Examples for updating an existing subscription are available here.

The subscription update options object extends the creation options object and adds two additional fields:

// The SubscriptionUpdateOptions object:
// =====================================
{
    id;
    createNew;
}

To define a data subscription that sends document revisions to the client,
you must first configure revisions for the specific collection managed by the subscription.

Create a subscription that sends document revisions using the following createForRevisions methods:

// Available overloads:
// ====================

createForRevisions(options);

createForRevisions(options, database);

When providing raw RQL to the query param in the options object,
concatenate the (Revisions = true) clause to the collection being queried.
For example: From Orders(Revisions = true) as o

Learn more about subscribing to revisions in revisions support.

All subscriptions are eventually translated to an RQL-like statement. These statements have the following parts:

• Functions definition part, like in ordinary RQL. Those functions can contain any JavaScript code, and also supports load and include operations.

• From statement, defining the documents source, ex: from Orders. The from statement can only address collections, therefore, indexes are not supported.

• Where statement describing the criteria according to which it will be decided to either send the documents to the worker or not. Those statements support either RQL like equality operations (=, ==) ,
  plain JavaScript expressions or declared function calls, allowing to perform complex filtering logic.
  The subscriptions RQL does not support any of the known RQL searching keywords.

• Select statement, that defines the projection to be performed. The select statements can contain function calls, allowing complex transformations.

• Include statement allowing to define include path in document.

from Orders as o
where o.Lines[].Product = "products/1-A"

declare function filterLines(doc, productId)
{
    if (!!doc.Lines){
        return doc.Lines.filter(x=>x.Product == productId).length >0;
    }
    return false;
}

from Orders as o
where filterLines(o, "products/1-A")