Merge pull request #374 from cloudant/372-add-partitioned-database-support

Add partitioned database support.

Author: smithsz

CHANGES.md

@@ -1,3 +1,6 @@
+# UNRELEASED
+- [NEW] Added partitioned database support.
+
 # 4.0.0 (2019-03-12)
 - [NEW] Added option for client to authenticate with IAM token server.
 - [FIXED] Add `vcapServiceName` configuration option to TS declarations.

cloudant.js

@@ -1,4 +1,4 @@
-// Copyright © 2015, 2018 IBM Corp. All rights reserved.
+// Copyright © 2015, 2019 IBM Corp. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -25,6 +25,18 @@ const Client = require('./lib/client.js');
 // return a URL.
 var reconfigure = require('./lib/reconfigure.js');
 
+// Helper function for optional parameter `opts`.
+function getCallback(opts, callback) {
+  if (typeof opts === 'function') {
+    callback = opts;
+    opts = {};
+  }
+  if (typeof opts === 'undefined') {
+    opts = {};
+  }
+  return {opts, callback};
+}
+
 // This IS the Cloudant API. It is mostly nano, with a few functions.
 function Cloudant(options, callback) {
   debug('Initialize', options);
@@ -150,7 +162,81 @@ function Cloudant(options, callback) {
         body: query}, callback);
     };
 
+    // Partitioned Databases
+    // ---------------------
+
+    function partitionInfo(partitionKey, callback) {
+      return nano.request(
+        {db: db, path: '_partition/' + partitionKey}, callback
+      );
+    }
+
+    function executePartitionedView(partitionKey, ddoc, viewName, meta, qs, callback) {
+      meta.viewPath = '_partition/' + partitionKey + '/_design/' + ddoc + '/_' +
+        meta.type + '/' + viewName;
+      // Note: No need to pass `ddoc` or `viewName` to the `baseView` function
+      // as they are passed in the `meta.viewPath`.
+      return nano._use(db).baseView(null, null, meta, qs, callback);
+    }
+
+    function partitionedList(partitionKey, qs0, callback0) {
+      const {opts, callback} = getCallback(qs0, callback0);
+      let path = '_partition/' + partitionKey + '/_all_docs';
+      return nano.request({db: db, path: path, qs: opts}, callback);
+    }
+
+    function partitionedListAsStream(partitionKey, qs) {
+      let path = '_partition/' + partitionKey + '/_all_docs';
+      return nano.request(
+        {db: db, path: path, qs: qs, stream: true}, callback
+      );
+    }
+
+    function partitionedFind(partitionKey, selector, callback) {
+      return nano.request({
+        db: db,
+        path: '_partition/' + partitionKey + '/_find',
+        method: 'POST',
+        body: selector
+      }, callback);
+    }
+
+    function partitionedFindAsStream(partitionKey, selector) {
+      return nano.request({
+        db: db,
+        path: '_partition/' + partitionKey + '/_find',
+        method: 'POST',
+        body: selector,
+        stream: true
+      });
+    }
+
+    function partitionedSearch(partitionKey, ddoc, viewName, qs, callback) {
+      return executePartitionedView(
+        partitionKey, ddoc, viewName, {type: 'search'}, qs, callback
+      );
+    }
+
+    function partitionedSearchAsStream(partitionKey, ddoc, viewName, qs) {
+      return executePartitionedView(
+        partitionKey, ddoc, viewName, {type: 'search', stream: true}, qs
+      );
+    }
+
+    function partitionedView(partitionKey, ddoc, viewName, qs, callback) {
+      return executePartitionedView(
+        partitionKey, ddoc, viewName, {type: 'view'}, qs, callback
+      );
+    }
+
+    function partitionedViewAsStream(partitionKey, ddoc, viewName, qs) {
+      return executePartitionedView(
+        partitionKey, ddoc, viewName, {type: 'view', stream: true}, qs
+      );
+    }
+
     var obj = nano._use(db);
+
     obj.geo = geo;
     obj.bulk_get = bulk_get; // eslint-disable-line camelcase
     obj.get_security = get_security; // eslint-disable-line camelcase
@@ -159,6 +245,16 @@ function Cloudant(options, callback) {
     obj.index.del = index_del; // eslint-disable-line camelcase
     obj.find = find;
 
+    obj.partitionInfo = partitionInfo;
+    obj.partitionedFind = partitionedFind;
+    obj.partitionedFindAsStream = partitionedFindAsStream;
+    obj.partitionedList = partitionedList;
+    obj.partitionedListAsStream = partitionedListAsStream;
+    obj.partitionedSearch = partitionedSearch;
+    obj.partitionedSearchAsStream = partitionedSearchAsStream;
+    obj.partitionedView = partitionedView;
+    obj.partitionedViewAsStream = partitionedViewAsStream;
+
     return obj;
   };
 

package-lock.json

@@ -28,7 +28,7 @@
     "concat-stream": "^1.6.0",
     "debug": "^3.1.0",
     "lockfile": "1.0.3",
-    "nano": "^8.0.0",
+    "nano": "^8.1.0",
     "request": "^2.81.0",
     "tmp": "0.0.33"
   },

package.json

@@ -1,4 +1,4 @@
-// Copyright © 2015, 2018 IBM Corp. All rights reserved.
+// Copyright © 2015, 2019 IBM Corp. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -813,7 +813,7 @@ describe('#db Cloudant Search', function() {
 
   it('searches test data: author:charles', function(done) {
     var mocks = nock(SERVER)
-      .get('/' + dbName + '/_design/library/_search/books?q=author%3Acharles')
+      .post('/' + dbName + '/_design/library/_search/books', '{\"q\":\"author:charles\"}')
       .reply(200, { total_rows: 1, bookmark: 'g2wAAAABaANkAB1kYmNvcmVAZGI2LnNsaW5nLmNsb3VkYW50Lm5ldGwAAAACbgQAAAAAgG4EAP___79qaAJGP8iMWIAAAABhAGo', rows: [ { id: 'a_tale', order: [Object], fields: {} } ] });
 
     mydb.search('library', 'books', {q: 'author:charles'}, function(er, d) {
@@ -833,7 +833,7 @@ describe('#db Cloudant Search', function() {
 
   it('searches test data: title:two', function(done) {
     var mocks = nock(SERVER)
-      .get('/' + dbName + '/_design/library/_search/books?q=title%3Atwo')
+      .post('/' + dbName + '/_design/library/_search/books', '{\"q\":\"title:two\"}')
       .reply(200, {total_rows: 2, bookmark: 'g1AAAACIeJzLYWBgYMpgTmGQTUlKzi9KdUhJMtcrzsnMS9dLzskvTUnMK9HLSy3JASlLcgCSSfX____PymBysz_RE9EAFEhkIFJ7HguQZGgAUkAT9oONOLy4igFsRBYAPRQqlQ', rows: [{id: 'towers', order: [Object], fields: {}}, {id: 'a_tale', order: [Object], fields: {}}]});
 
     mydb.search('library', 'books', {q: 'title:two'}, function(er, d) {

test/legacy/api.js

@@ -1,4 +1,4 @@
-// Copyright © 2015, 2018 IBM Corp. All rights reserved.
+// Copyright © 2015, 2019 IBM Corp. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -406,7 +406,7 @@ describe('Cloudant Search #db', function() {
                     { id: '764de7aeca95c27fdd7fb6565dcfc727', rev: '1-86039ff130d36c08a71b3f293fd4ea7e' }])
       .post(`/${my_db}`)
       .reply(200, { ok: true, id: '_design/library', rev: '1-cdbb57f890d060055b7fb8cb07628068' })
-      .get(`/${my_db}/_design/library/_search/books`).query(true)
+      .post(`/${my_db}/_design/library/_search/books`, '{\"q\":\"author:dickens\"}')
       .reply(200, {total_rows: 2, rows: [{id: '764de7aeca95c27fdd7fb6565dcfc0fe'}, {id: '764de7aeca95c27fdd7fb6565dcfc727'}]})
       .delete(`/${my_db}`)
       .reply(200, {ok: true});