Merge pull request #102 from semi-technologies/node_name-consistency_level-WEAVIATE-462

Add support for node_name and consistency_level get by id query params

Author: antas-marcin

data/getterById.js

@@ -25,6 +25,16 @@ export default class GetterById {
 
   withVector = () => this.extendAdditionals("vector");
 
+  withConsistencyLevel = (cl) => {
+    this.consistencyLevel = cl;
+    return this;
+  };
+
+  withNodeName = (nodeName) => {
+    this.nodeName = nodeName;
+    return this;
+  };
+
   validateId = () => {
     if (this.id == undefined || this.id == null || this.id.length == 0) {
       this.errors = [
@@ -38,6 +48,11 @@ export default class GetterById {
     this.validateId();
   };
 
+  buildPath = () => {
+    return this.objectsPath.buildGetOne(this.id, this.className,
+      this.additionals, this.consistencyLevel, this.nodeName)
+  }
+
   do = () => {
     this.validate();
     if (this.errors.length > 0) {
@@ -46,7 +61,7 @@ export default class GetterById {
       );
     }
 
-    return this.objectsPath.buildGetOne(this.id, this.className, this.additionals)
+    return this.buildPath()
       .then(this.client.get);
   };
 }

data/journey.test.js

@@ -584,6 +584,40 @@ describe("data", () => {
       .catch((e) => fail("it should not have errord: " + e));
   });
 
+  it("forms a get by id query with node_name set", () => {
+    const id = "1565c06c-463f-466c-9092-5930dbac3887";
+
+    return client.data
+      .getterById()
+      .withClassName(thingClassName)
+      .withId(id)
+      .withVector()
+      .withNodeName("node1")
+      .buildPath()
+      .then(path => {
+        expect(path).toContain("?include=vector");
+        expect(path).toContain("&node_name=node1");
+      })
+      .catch((e) => fail("it should not have errord: " + e));
+  })
+
+  it("forms a get by id query with consistency_level set", () => {
+    const id = "1565c06c-463f-466c-9092-5930dbac3887";
+
+    return client.data
+      .getterById()
+      .withClassName(thingClassName)
+      .withId(id)
+      .withVector()
+      .withConsistencyLevel(weaviate.replication.ConsistencyLevel.QUORUM)
+      .buildPath()
+      .then(path => {
+        expect(path).toContain("?include=vector");
+        expect(path).toContain("consistency_level=QUORUM");
+      })
+      .catch((e) => fail("it should not have errord: " + e));
+  })
+
   it("tears down and cleans up", () => {
     return Promise.all([
       client.schema.classDeleter().withClassName(thingClassName).do(),

data/path.js

@@ -17,8 +17,9 @@ export class ObjectsPath {
   buildCheck(id, className) {
     return this.build({id, className}, [this.addClassNameDeprecatedNotSupportedCheck, this.addId]);
   }
-  buildGetOne(id, className, additionals) {
-    return this.build({id, className, additionals}, [this.addClassNameDeprecatedNotSupportedCheck, this.addId, this.addQueryParams]);
+  buildGetOne(id, className, additionals, consistencyLevel, nodeName) {
+    return this.build({id, className, additionals, consistencyLevel, nodeName}, 
+      [this.addClassNameDeprecatedNotSupportedCheck, this.addId, this.addQueryParams]);
   }
   buildGet(className, limit, additionals) {
     return this.build({className, limit, additionals}, [this.addQueryParamsForGet]);
@@ -73,6 +74,12 @@ export class ObjectsPath {
     if (Array.isArray(params.additionals) && params.additionals.length > 0) {
       queryParams.push(`include=${params.additionals.join(",")}`);
     }
+    if (isValidStringProperty(params.nodeName)) {
+      queryParams.push(`node_name=${params.nodeName}`);
+    }
+    if (isValidStringProperty(params.consistencyLevel)) {
+      queryParams.push(`consistency_level=${params.consistencyLevel}`);
+    }
     if (queryParams.length > 0) {
       return `${path}?${queryParams.join("&")}`;
     }

data/replication/consts.js

@@ -0,0 +1,11 @@
+export const ConsistencyLevel = {
+  ONE: "ONE",
+  QUORUM: "QUORUM",
+  ALL: "ALL",
+};
+
+const replicationConsts = {
+  ConsistencyLevel,
+};
+
+export default replicationConsts;

index.js

@@ -13,6 +13,7 @@ import batchConsts from "./batch/consts.js";
 import filtersConsts from "./filters/consts.js";
 import cluster from "./cluster/index.js";
 import clusterConsts from "./cluster/consts.js";
+import replicationConsts from "./data/replication/consts.js";
 
 const app = {
   client: function (params) {
@@ -47,6 +48,7 @@ const app = {
   batch: batchConsts,
   filters: filtersConsts,
   cluster: clusterConsts,
+  replication: replicationConsts,
 };
 
 function initDbVersionProvider(conn) {