Merge pull request #241 from ml054/v5.0

V5.0

Author: gregolsky

.github/workflows/RavenClient.yml

@@ -2,9 +2,9 @@ name: tests/node
 
 on:
   push:
-    branches: [ v4.2 ]
+    branches: [ v5.0 ]
   pull_request:
-    branches: [ v4.2 ]
+    branches: [ v5.0 ]
 
 jobs:
   build:
@@ -17,13 +17,13 @@ jobs:
       RAVENDB_TEST_CLIENT_CERT_PATH: ./certs/nodejs.pem
       RAVENDB_TEST_CA_PATH: /usr/local/share/ca-certificates/ca.crt
       RAVENDB_TEST_HTTPS_SERVER_URL: https://localhost:8989
-      RAVENDB_BUILD_TYPE: stable
+      RAVENDB_BUILD_TYPE: nightly
       RAVEN_License: ${{ secrets.RAVEN_LICENSE }}
 
     strategy:
       matrix:
         node-version: [10.x, 12.x, 14.x]
-        serverVersion: ["4.2"]
+        serverVersion: ["5.0", "5.1"]
       fail-fast: false
 
     steps:

README.md

@@ -69,15 +69,6 @@ session.load('Users/1-A')
         // here session is complete
     });
 ```
-2. Callbacks
-```javascript
-session.load('users/1-A', (user) => {
-    user.password = PBKDF2('new password');
-    session.saveChanges(() => {
-        // data is persisted
-    });
-});
-```
 
 ## CRUD example
 
@@ -164,6 +155,11 @@ By index name:
 const query = session.query({ indexName: 'productsByCategory' });
 ```
 
+By index:
+```javascript
+const query = session.query(Product, Product_ByName);
+```
+
 Using entity type:
 ```javascript
 import { User } from "./models";
@@ -573,6 +569,29 @@ await session.advanced.attachments.getNames(doc);
 //     size: 4579 } ]
 ```
 
+### TimeSeries
+
+#### Store time series
+
+```javascript
+// create document with time series
+const session = store.openSession();
+await session.store({ name: "John" }, "users/1");
+const tsf = session.timeSeriesFor("users/1", "heartbeat");
+tsf.append(new Date(), 120);
+await session.saveChanges();
+```
+
+#### Get time series for document
+
+```javascript
+// load time series by document by given name
+const session = store.openSession();
+const tsf = session.timeSeriesFor("users/1", "heartbeat");
+const heartbeats = await tsf.get();
+```
+
+
 ### Bulk Insert
 
 ```javascript
@@ -713,18 +732,22 @@ const revisions = await session.advanced.revisions.getFor("users/1");
 //     id: 'users/1-A' },
 
 // and a static index like:
-class UsersIndex extends AbstractIndexCreationTask {
+class UsersIndex extends AbstractJavaScriptIndexCreationTask {
     constructor() {
         super();
-        this.map = "from doc in docs.Users select new { doc.name }";
+        this.map(User, doc => {
+            return {
+                name: doc.name
+            }
+        });
         this.suggestion("name");
     }
 }
 
 // ...
 
 const session = store.openSession();
-const suggestionQueryResult = await session.query({ collection: "users" })
+const suggestionQueryResult = await session.query(User, UsersIndex)
     .suggestUsing(x => x.byField("name", "Jon"))
     .execute();
 // { name: { name: 'name', suggestions: [ 'john' ] } }