Merge pull request #161 from gregolsky/v4.0

Subscriptions example

Author: gregolsky

README.md

@@ -1,29 +1,18 @@
-# RavenDB client for Node.js
+# RavenDB Client for Node.js
 
-[![build status](https://travis-ci.org/ravendb/ravendb-nodejs-client.svg?branch=v4.0)](https://travis-ci.org/ravendb/ravendb-nodejs-client) [![Known Vulnerabilities](https://snyk.io/test/github/ravendb/ravendb-nodejs-client/badge.svg)](https://snyk.io/test/github/ravendb/ravendb-nodejs-client)
-
-## Changelog
+[![NPM](https://nodei.co/npm/ravendb.png?compact=true)](https://nodei.co/npm/ravendb/)
 
-### 4.0.3 - 2018-10-01
-Added support for the following features:
-- [Streaming](#streaming)
-- More like this
-- [Suggestions](#suggestions)
-- [Revisions](#revisions)
-- [Advanced patching](#advanced-patching)
+[![build status](https://travis-ci.org/ravendb/ravendb-nodejs-client.svg?branch=v4.0)](https://travis-ci.org/ravendb/ravendb-nodejs-client) [![Known Vulnerabilities](https://snyk.io/test/github/ravendb/ravendb-nodejs-client/badge.svg)](https://snyk.io/test/github/ravendb/ravendb-nodejs-client)
 
-### 4.0.2 - 2018-09-14
-Added support for the following features:
-- [Attachments](#attachments)
-- [Bulk Insert](#bulk-insert)
-- [Changes API](#changes-api)
 
 ## Installation
 
 ```bash
 npm install --save ravendb
 ```
 
+## Releases and Changelog - [click here](https://github.com/ravendb/ravendb-nodejs-client/releases)
+
 ## Getting started
 
 1. Require `DocumentStore` class from package
@@ -747,14 +736,67 @@ session.advanced.patch("users/1", "underAge", false);
 
 await session.saveChanges();
 ```
+### Subscriptions
+```javascript
+// create a subscription
+const subscriptionName = await store.subscriptions.create({
+    query: "from users where age >= 30"
+});
+
+// get subscription worker for your subscription
+const subscription = store.subscriptions.getSubscriptionWorker({ subscriptionName });
+
+subscription.on("error", err => {
+    // handle errors
+});
+
+subscription.on("batch", (batch, callback) => {
+    try {
+        // do batch processing on batch.items
+        // batch.items:
+        // [ Item {
+        //     changeVector: 'A:2-r6nkF5nZtUKhcPEk6/LL+Q',
+        //     id: 'users/1-A',
+        //     rawResult:
+        //      { name: 'John',
+        //        age: 30,
+        //        registeredAt: '2017-11-11T00:00:00.0000000',
+        //        kids: [Array],
+        //        '@metadata': [Object],
+        //        id: 'users/1-A' },
+        //     rawMetadata:
+        //      { '@collection': 'Users',
+        //        '@nested-object-types': [Object],
+        //        'Raven-Node-Type': 'User',
+        //        '@change-vector': 'A:2-r6nkF5nZtUKhcPEk6/LL+Q',
+        //        '@id': 'users/1-A',
+        //        '@last-modified': '2018-10-18T11:15:51.4882011Z' },
+        //     exceptionMessage: undefined } ]
+        // ...
+
+        // call the callback, once you're done
+        callback();
+    } catch(err) {
+        // if processing fails for a particular batch
+        // pass the error to the callback
+        callback(err);
+    }
+});
+```
 
 ## Using object literals for entities
 
-In order to comfortably use object literals as entities set function getting collection name based on the content of the object - `store.conventions.findCollectionNameForObjectLiteral()`. This needs to be done *before* an `initialize()` call on `DocumentStore` instance. If you fail to do so, your entites will land up in *@empty* collection having an *UUID* for an ID. E.g.
+In order to comfortably use object literals as entities set the function getting collection name based on the content of the object - `store.conventions.findCollectionNameForObjectLiteral()`. 
+
 ```javascript
+const store = new DocumentStore(urls, database);
 store.conventions.findCollectionNameForObjectLiteral = entity => entity["collection"];
+// ...
+store.initialize();
 ```
 
+This needs to be done *before* an `initialize()` call on `DocumentStore` instance. If you fail to do so, your entites will land up in *@empty* collection having an *UUID* for an ID. E.g.
+
 ## Using classes for entities
 
 1. Define your model as class. Attributes should be just public properties:

perf/results/bulk-insert.md

@@ -11,7 +11,7 @@ bulk-insert-2018-16-10-pipeline x10: 21635.223ms
 Buffer.concat() usage and redundant buffering logic removal.
 
 ```
-bulk-insert-2018-16-10-pipeline x10: 2490.231ms
-bulk-insert-2018-16-10-pipeline x50: 8280.333ms
-bulk-insert-2018-16-10-pipeline x100: 15802.916ms
+bulk-insert-2018-10-18-pipeline x10: 2490.231ms
+bulk-insert-2018-10-18-pipeline x50: 8280.333ms
+bulk-insert-2018-10-18-pipeline x100: 15802.916ms
 ```

test/Documents/ReadmeSamples.ts

@@ -428,6 +428,41 @@ describe("Readme query samples", function () {
             }
         });
 
+        it("can subscribe", async () => {
+
+            // create a subscription
+            const subscriptionName = await store.subscriptions.create({
+                query: "from users where age >= 30"
+            });
+
+            // get subscription worker for your subscription
+            const subscription = store.subscriptions.getSubscriptionWorker({ subscriptionName });
+
+            subscription.on("error", err => {
+                // handle errors
+            });
+
+            let done;
+            const testDone = new Promise(resolve => done = resolve);
+            subscription.on("batch", (batch, callback) => {
+                try {
+                    // do batch processing
+                    print(batch.items);
+
+                    // call the callback, once you're done
+                    callback();
+                } catch (err) {
+                    // if processing fails for a particular batch
+                    // pass the error to the callback
+                    callback(err);
+                }
+
+                done();
+            });
+
+            await testDone;
+        });
+
     });
 
     it("can use advanced.patch", async () => {