MLE-15458 : Specify search options when using fromSearchDocs with the Node Client

Author: anu3990

lib/plan-builder-generated.js

@@ -8699,9 +8699,9 @@ fromSQL(...args) {
     */
 fromSearchDocs(...args) {
     const namer = bldrbase.getNamer(args, 'query');
-    const paramdefs = [['query', [types.XsString, types.CtsQuery], true, false], ['qualifierName', [types.XsString], false, false]];
+    const paramdefs = [['query', [types.XsString, types.CtsQuery], true, false], ['qualifierName', [types.XsString], false, false], ['option', [PlanSearchOption], false, false]];
     const checkedArgs = (namer !== null) ?
-        bldrbase.makeNamedArgs(namer, 'PlanBuilder.fromSearchDocs', 1, new Set(['query', 'qualifierName']), paramdefs, args) :
+        bldrbase.makeNamedArgs(namer, 'PlanBuilder.fromSearchDocs', 1, new Set(['query', 'qualifierName', 'option']), paramdefs, args) :
         bldrbase.makePositionalArgs('PlanBuilder.fromSearchDocs', 1, false, paramdefs, args);
     return new PlanAccessPlan(null, 'op', 'from-search-docs', checkedArgs);
 

test-basic/plan-search.js

@@ -183,7 +183,7 @@ describe('search', function() {
 // console.log(JSON.stringify(output, null, 2));
   });
 
-  describe('tests for new scoring methods -  bm25, random and zero.', function() {
+  describe('tests for new scoring methods -  bm25, random and zero using fromSearch.', function() {
     before(function (done) {
       if(serverConfiguration.serverVersion < 12) {
         this.skip();
@@ -253,4 +253,70 @@ describe('search', function() {
       }).catch(error => done(error));
     });
   });
+
+  describe('tests for new scoring methods -  bm25, random and zero using fromSearchDocs.', function() {
+    before(function (done) {
+      if(serverConfiguration.serverVersion < 12) {
+        this.skip();
+      }
+      done();
+    });
+
+    it('should search documents with bm25', function(done) {
+      execPlan(
+          p.fromSearchDocs('Armstrong', null, {scoreMethod:'bm25', bm25LengthWeight:0.75})
+      ).then(function(response) {
+        assert(response.columns != null)
+        assert(response.rows != null)
+        done();
+      }).catch(error => done(error));
+    });
+
+    it('should throw error with invalid bm25LengthWeight', function(done) {
+      execPlan(
+          p.fromSearchDocs('Armstrong', null, {scoreMethod:'bm25', bm25LengthWeight:87})
+      ).catch(error => {
+        try{
+          assert(error.body.errorResponse.message.toString().includes('Invalid option "bm25-length-weight=87'));
+          done();
+        } catch(error){
+          done(error);
+        }
+      });
+    });
+
+    it('should throw error with string values for bm25LengthWeight', function(done) {
+      try {
+        execPlan(
+            p.fromSearchDocs('Armstrong', null, {scoreMethod:'bm25', bm25LengthWeight: 'abc'})
+        );
+      } catch(error){
+        assert(error.message.toString().includes('bm25LengthWeight must be a number'));
+        done();
+      }
+    });
+
+    it('should search documents with zero scoring method', function(done) {
+      execPlan(
+          p.fromSearchDocs('Armstrong', null, { scoreMethod: 'zero'})
+      ).then(function(response) {
+        assert(response.columns != null)
+        assert(response.rows != null)
+        for(let i=0; i<response.rows.length; i++){
+          assert(response.rows[i].score.value == 0)
+        }
+        done();
+      }).catch(error => done(error));
+    });
+
+    it('should search documents with random scoring method', function(done) {
+      execPlan(
+          p.fromSearchDocs('Armstrong', null, { scoreMethod: 'random'})
+      ).then(function(response) {
+        assert(response.columns != null)
+        assert(response.rows != null)
+        done();
+      }).catch(error => done(error));
+    });
+  });
 });