Subscription Task
-
Data subscriptions are task that automatically send certain documents to a subscribed client, called the "subscription worker".
-
This page explains how to create a subscription on the server side using the Studio.
-
In this page:
Subscription Task Definition
Subscription Task Definition
-
The RQL query which selects which documents the subscription sends to the client.
-
Limit the age of the documents that will be retrieved. Default: "the beginning of time" - meaning all documents are retrieved regardless of age. The other options are:
- Latest document - of the documents that existed before the subscription task began, retrieve only the newest one.
- Change vector - specify a starting point for the subscription by a document change vector.
-
Choose which node will perform this task by default.
-
Test the subscription query.
Testing
Testing Subscription
Testing the subscription shows which documents are retrieved by the specified query.
-
Limit the number of results to retrieve for this test.
-
Limit how long - in seconds - the test should continue before stopping automatically.
-
Run the test.
Details in Task List View
Task List View
Press the info button on a task in the task list view to see more detailed information.
-
Task status - will be "active" while a client is subscribed to this task, and "not active" when there is not.
-
Client IP - the IP address of the subscription worker subscribed to this task.
-
Connection strategy - determines the automatic behavior of communication between server and worker.
-
Change vector for next batch - the change vector of the last document in the batch that will be sent next.
-
Last batch acknowledgement time - the last time a worker responded that it has recieved a batch.
-
Last client connection time - the last time a worker communicated with or pinged the server.