Create and Update Subscription API

Subscriptions can be created using the create_for_options and create_for_class methods.

def create_for_options(self, options: SubscriptionCreationOptions, database: Optional[str] = None) -> str: ...

def create_for_class(
    self,
    object_type: Type[_T],
    options: Optional[SubscriptionCreationOptions] = None,
    database: Optional[str] = None,
) -> str: ...

An RQL statement will be built based on the fields.

class SubscriptionCreationOptions:
    def __init__(
        self,
        name: Optional[str] = None,
        query: Optional[str] = None,
        includes: Optional[Callable[[SubscriptionIncludeBuilder], None]] = None,
        change_vector: Optional[str] = None,
        mentor_node: Optional[str] = None,
    ):
        self.name = name
        self.query = query
        self.includes = includes
        self.change_vector = change_vector
        self.mentor_node = mentor_node

Modifies an existing data subscription. These methods are accessible at DocumentStore.Subscriptions.

def update(self, options: SubscriptionUpdateOptions, database: Optional[str] = None) -> str: ...

Inherits from SubscriptionCreationOptions and has all the same fields (see above) plus the two additional fields described below:

class SubscriptionUpdateOptions(SubscriptionCreationOptions):
    def __init__(
        self,
        name: Optional[str] = None,
        query: Optional[str] = None,
        includes: Optional[Callable[[SubscriptionIncludeBuilder], None]] = None,
        change_vector: Optional[str] = None,
        mentor_node: Optional[str] = None,
        key: Optional[int] = None,
        create_new: Optional[bool] = None,
    ): ...

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")