couchbase 3.2.0 → 3.2.4

package/dist/binding.d.ts

@@ -184,6 +184,8 @@ export interface CppBinding {
     LCB_ERR_SCOPE_NOT_FOUND: CppErrType;
     LCB_ERR_INDEX_NOT_FOUND: CppErrType;
     LCB_ERR_INDEX_EXISTS: CppErrType;
+    LCB_ERR_RATE_LIMITED: CppErrType;
+    LCB_ERR_QUOTA_LIMITED: CppErrType;
     LCB_ERR_DOCUMENT_NOT_FOUND: CppErrType;
     LCB_ERR_DOCUMENT_UNRETRIEVABLE: CppErrType;
     LCB_ERR_DOCUMENT_LOCKED: CppErrType;
@@ -298,6 +300,7 @@ export interface CppBinding {
     LCB_HTTP_TYPE_QUERY: CppHttpType;
     LCB_HTTP_TYPE_SEARCH: CppHttpType;
     LCB_HTTP_TYPE_ANALYTICS: CppHttpType;
+    LCB_HTTP_TYPE_EVENTING: CppHttpType;
     LCB_HTTP_METHOD_GET: CppHttpMethod;
     LCB_HTTP_METHOD_POST: CppHttpMethod;
     LCB_HTTP_METHOD_PUT: CppHttpMethod;

package/dist/bindingutilities.js

@@ -214,6 +214,10 @@ function translateCppError(err) {
             return new errs.IndexNotFoundError(codeErr, context);
         case binding_1.default.LCB_ERR_INDEX_EXISTS:
             return new errs.IndexExistsError(codeErr, context);
+        case binding_1.default.LCB_ERR_RATE_LIMITED:
+            return new errs.RateLimitedError(codeErr, context);
+        case binding_1.default.LCB_ERR_QUOTA_LIMITED:
+            return new errs.QuotaLimitedError(codeErr, context);
         /* KeyValue Error Definitions */
         case binding_1.default.LCB_ERR_DOCUMENT_NOT_FOUND:
             return new errs.DocumentNotFoundError(codeErr, context);

package/dist/bucket.js

@@ -103,7 +103,7 @@ class Bucket {
      */
     viewQuery(designDoc, viewName, options, callback) {
         if (options instanceof Function) {
-            callback = arguments[0];
+            callback = arguments[2];
             options = undefined;
         }
         if (!options) {

package/dist/bucketmanager.d.ts

@@ -18,7 +18,14 @@ export declare enum ConflictResolutionType {
     /**
      * Indicates that the seqno of the document should be used for conflict resolution.
      */
-    SequenceNumber = "seqno"
+    SequenceNumber = "seqno",
+    /**
+     * Indicates that custom conflict resolution should be used.
+     *
+     * @experimental This mode is only available in Couchbase Server 7.1 with the
+     * "developer-preview" mode enabled.
+     */
+    Custom = "custom"
 }
 /**
  * Represents the type of a bucket.
@@ -39,6 +46,21 @@ export declare enum BucketType {
      */
     Ephemeral = "ephemeral"
 }
+/**
+ * Represents the storage backend to use for a bucket.
+ *
+ * @category Management
+ */
+export declare enum StorageBackend {
+    /**
+     * Indicates the bucket should use the Couchstore storage engine.
+     */
+    Couchstore = "couchstore",
+    /**
+     * Indicates the bucket should use the Magma storage engine.
+     */
+    Magma = "magma"
+}
 /**
  * Represents the eviction policy that should be used for a bucket.
  *
@@ -117,6 +139,10 @@ export interface IBucketSettings {
      * Specifies the type of bucket that should be used.
      */
     bucketType: BucketType | string;
+    /**
+     * Specifies the storage backend to use for the bucket.
+     */
+    storageBackend: StorageBackend | string;
     /**
      * Specifies the ejection method that should be used.
      */
@@ -189,6 +215,10 @@ export declare class BucketSettings implements IBucketSettings {
      * Specifies the type of bucket that should be used.
      */
     bucketType: BucketType;
+    /**
+     * Specifies the storage backend to use for the bucket.
+     */
+    storageBackend: StorageBackend | string;
     /**
      * Specifies the ejection method that should be used.
      */

package/dist/bucketmanager.js

@@ -1,15 +1,6 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BucketManager = exports.BucketSettings = exports.CompressionMode = exports.EvictionPolicy = exports.BucketType = exports.ConflictResolutionType = void 0;
+exports.BucketManager = exports.BucketSettings = exports.CompressionMode = exports.EvictionPolicy = exports.StorageBackend = exports.BucketType = exports.ConflictResolutionType = void 0;
 const errors_1 = require("./errors");
 const httpexecutor_1 = require("./httpexecutor");
 const utilities_1 = require("./utilities");
@@ -31,6 +22,13 @@ var ConflictResolutionType;
      * Indicates that the seqno of the document should be used for conflict resolution.
      */
     ConflictResolutionType["SequenceNumber"] = "seqno";
+    /**
+     * Indicates that custom conflict resolution should be used.
+     *
+     * @experimental This mode is only available in Couchbase Server 7.1 with the
+     * "developer-preview" mode enabled.
+     */
+    ConflictResolutionType["Custom"] = "custom";
 })(ConflictResolutionType = exports.ConflictResolutionType || (exports.ConflictResolutionType = {}));
 /**
  * Represents the type of a bucket.
@@ -52,6 +50,22 @@ var BucketType;
      */
     BucketType["Ephemeral"] = "ephemeral";
 })(BucketType = exports.BucketType || (exports.BucketType = {}));
+/**
+ * Represents the storage backend to use for a bucket.
+ *
+ * @category Management
+ */
+var StorageBackend;
+(function (StorageBackend) {
+    /**
+     * Indicates the bucket should use the Couchstore storage engine.
+     */
+    StorageBackend["Couchstore"] = "couchstore";
+    /**
+     * Indicates the bucket should use the Magma storage engine.
+     */
+    StorageBackend["Magma"] = "magma";
+})(StorageBackend = exports.StorageBackend || (exports.StorageBackend = {}));
 /**
  * Represents the eviction policy that should be used for a bucket.
  *
@@ -115,6 +129,7 @@ class BucketSettings {
         this.numReplicas = data.numReplicas;
         this.replicaIndexes = data.replicaIndexes;
         this.bucketType = data.bucketType;
+        this.storageBackend = data.storageBackend;
         this.evictionPolicy = data.evictionPolicy;
         this.maxExpiry = data.maxExpiry;
         this.compressionMode = data.compressionMode;
@@ -162,6 +177,7 @@ class BucketSettings {
             replicaNumber: data.numReplicas,
             replicaIndexes: data.replicaIndexes,
             bucketType: data.bucketType,
+            storageBackend: data.storageBackend,
             evictionPolicy: data.evictionPolicy,
             maxTTL: data.maxTTL || data.maxExpiry,
             compressionMode: data.compressionMode,
@@ -180,6 +196,7 @@ class BucketSettings {
             numReplicas: data.replicaNumber,
             replicaIndexes: data.replicaIndexes,
             bucketType: data.bucketType,
+            storageBackend: data.storageBackend,
             evictionPolicy: data.evictionPolicy,
             maxExpiry: data.maxTTL,
             compressionMode: data.compressionMode,
@@ -209,7 +226,10 @@ class CreateBucketSettings extends BucketSettings {
      * @internal
      */
     static _toNsData(data) {
-        return Object.assign(Object.assign({}, BucketSettings._toNsData(data)), { conflictResolutionType: data.conflictResolutionType });
+        return {
+            ...BucketSettings._toNsData(data),
+            conflictResolutionType: data.conflictResolutionType,
+        };
     }
 }
 /**
@@ -235,38 +255,36 @@ class BucketManager {
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
      */
-    createBucket(settings, options, callback) {
-        return __awaiter(this, arguments, void 0, function* () {
-            if (options instanceof Function) {
-                callback = arguments[1];
-                options = undefined;
-            }
-            if (!options) {
-                options = {};
-            }
-            const parentSpan = options.parentSpan;
-            const timeout = options.timeout;
-            return utilities_1.PromiseHelper.wrapAsync(() => __awaiter(this, void 0, void 0, function* () {
-                const bucketData = CreateBucketSettings._toNsData(settings);
-                const res = yield this._http.request({
-                    type: httpexecutor_1.HttpServiceType.Management,
-                    method: httpexecutor_1.HttpMethod.Post,
-                    path: `/pools/default/buckets`,
-                    contentType: 'application/x-www-form-urlencoded',
-                    body: utilities_1.cbQsStringify(bucketData),
-                    parentSpan: parentSpan,
-                    timeout: timeout,
-                });
-                if (res.statusCode !== 202) {
-                    const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
-                    const errText = res.body.toString().toLowerCase();
-                    if (errText.includes('already exists')) {
-                        throw new errors_1.BucketExistsError(undefined, errCtx);
-                    }
-                    throw new errors_1.CouchbaseError('failed to create bucket', undefined, errCtx);
+    async createBucket(settings, options, callback) {
+        if (options instanceof Function) {
+            callback = arguments[1];
+            options = undefined;
+        }
+        if (!options) {
+            options = {};
+        }
+        const parentSpan = options.parentSpan;
+        const timeout = options.timeout;
+        return utilities_1.PromiseHelper.wrapAsync(async () => {
+            const bucketData = CreateBucketSettings._toNsData(settings);
+            const res = await this._http.request({
+                type: httpexecutor_1.HttpServiceType.Management,
+                method: httpexecutor_1.HttpMethod.Post,
+                path: `/pools/default/buckets`,
+                contentType: 'application/x-www-form-urlencoded',
+                body: utilities_1.cbQsStringify(bucketData),
+                parentSpan: parentSpan,
+                timeout: timeout,
+            });
+            if (res.statusCode !== 202) {
+                const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
+                const errText = res.body.toString().toLowerCase();
+                if (errText.includes('already exists')) {
+                    throw new errors_1.BucketExistsError(undefined, errCtx);
                 }
-            }), callback);
-        });
+                throw new errors_1.CouchbaseError('failed to create bucket', undefined, errCtx);
+            }
+        }, callback);
     }
     /**
      * Updates the settings for an existing bucket.
@@ -275,38 +293,36 @@ class BucketManager {
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
      */
-    updateBucket(settings, options, callback) {
-        return __awaiter(this, arguments, void 0, function* () {
-            if (options instanceof Function) {
-                callback = arguments[1];
-                options = undefined;
-            }
-            if (!options) {
-                options = {};
-            }
-            const parentSpan = options.parentSpan;
-            const timeout = options.timeout;
-            return utilities_1.PromiseHelper.wrapAsync(() => __awaiter(this, void 0, void 0, function* () {
-                const bucketData = BucketSettings._toNsData(settings);
-                const res = yield this._http.request({
-                    type: httpexecutor_1.HttpServiceType.Management,
-                    method: httpexecutor_1.HttpMethod.Post,
-                    path: `/pools/default/buckets/${settings.name}`,
-                    contentType: 'application/x-www-form-urlencoded',
-                    body: utilities_1.cbQsStringify(bucketData),
-                    parentSpan: parentSpan,
-                    timeout: timeout,
-                });
-                if (res.statusCode !== 200) {
-                    const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
-                    const errText = res.body.toString().toLowerCase();
-                    if (errText.includes('not found')) {
-                        throw new errors_1.BucketNotFoundError(undefined, errCtx);
-                    }
-                    throw new errors_1.CouchbaseError('failed to update bucket', undefined, errCtx);
+    async updateBucket(settings, options, callback) {
+        if (options instanceof Function) {
+            callback = arguments[1];
+            options = undefined;
+        }
+        if (!options) {
+            options = {};
+        }
+        const parentSpan = options.parentSpan;
+        const timeout = options.timeout;
+        return utilities_1.PromiseHelper.wrapAsync(async () => {
+            const bucketData = BucketSettings._toNsData(settings);
+            const res = await this._http.request({
+                type: httpexecutor_1.HttpServiceType.Management,
+                method: httpexecutor_1.HttpMethod.Post,
+                path: `/pools/default/buckets/${settings.name}`,
+                contentType: 'application/x-www-form-urlencoded',
+                body: utilities_1.cbQsStringify(bucketData),
+                parentSpan: parentSpan,
+                timeout: timeout,
+            });
+            if (res.statusCode !== 200) {
+                const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
+                const errText = res.body.toString().toLowerCase();
+                if (errText.includes('not found')) {
+                    throw new errors_1.BucketNotFoundError(undefined, errCtx);
                 }
-            }), callback);
-        });
+                throw new errors_1.CouchbaseError('failed to update bucket', undefined, errCtx);
+            }
+        }, callback);
     }
     /**
      * Drops an existing bucket.
@@ -315,35 +331,33 @@ class BucketManager {
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
      */
-    dropBucket(bucketName, options, callback) {
-        return __awaiter(this, arguments, void 0, function* () {
-            if (options instanceof Function) {
-                callback = arguments[1];
-                options = undefined;
-            }
-            if (!options) {
-                options = {};
-            }
-            const parentSpan = options.parentSpan;
-            const timeout = options.timeout;
-            return utilities_1.PromiseHelper.wrapAsync(() => __awaiter(this, void 0, void 0, function* () {
-                const res = yield this._http.request({
-                    type: httpexecutor_1.HttpServiceType.Management,
-                    method: httpexecutor_1.HttpMethod.Delete,
-                    path: `/pools/default/buckets/${bucketName}`,
-                    parentSpan: parentSpan,
-                    timeout: timeout,
-                });
-                if (res.statusCode !== 200) {
-                    const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
-                    const errText = res.body.toString().toLowerCase();
-                    if (errText.includes('not found')) {
-                        throw new errors_1.BucketNotFoundError(undefined, errCtx);
-                    }
-                    throw new errors_1.CouchbaseError('failed to drop bucket', undefined, errCtx);
+    async dropBucket(bucketName, options, callback) {
+        if (options instanceof Function) {
+            callback = arguments[1];
+            options = undefined;
+        }
+        if (!options) {
+            options = {};
+        }
+        const parentSpan = options.parentSpan;
+        const timeout = options.timeout;
+        return utilities_1.PromiseHelper.wrapAsync(async () => {
+            const res = await this._http.request({
+                type: httpexecutor_1.HttpServiceType.Management,
+                method: httpexecutor_1.HttpMethod.Delete,
+                path: `/pools/default/buckets/${bucketName}`,
+                parentSpan: parentSpan,
+                timeout: timeout,
+            });
+            if (res.statusCode !== 200) {
+                const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
+                const errText = res.body.toString().toLowerCase();
+                if (errText.includes('not found')) {
+                    throw new errors_1.BucketNotFoundError(undefined, errCtx);
                 }
-            }), callback);
-        });
+                throw new errors_1.CouchbaseError('failed to drop bucket', undefined, errCtx);
+            }
+        }, callback);
     }
     /**
      * Fetches the settings in use for a specified bucket.
@@ -352,37 +366,35 @@ class BucketManager {
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
      */
-    getBucket(bucketName, options, callback) {
-        return __awaiter(this, arguments, void 0, function* () {
-            if (options instanceof Function) {
-                callback = arguments[1];
-                options = undefined;
-            }
-            if (!options) {
-                options = {};
-            }
-            const parentSpan = options.parentSpan;
-            const timeout = options.timeout;
-            return utilities_1.PromiseHelper.wrapAsync(() => __awaiter(this, void 0, void 0, function* () {
-                const res = yield this._http.request({
-                    type: httpexecutor_1.HttpServiceType.Management,
-                    method: httpexecutor_1.HttpMethod.Get,
-                    path: `/pools/default/buckets/${bucketName}`,
-                    parentSpan: parentSpan,
-                    timeout: timeout,
-                });
-                if (res.statusCode !== 200) {
-                    const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
-                    const errText = res.body.toString().toLowerCase();
-                    if (errText.includes('not found')) {
-                        throw new errors_1.BucketNotFoundError(undefined, errCtx);
-                    }
-                    throw new errors_1.CouchbaseError('failed to get bucket', undefined, errCtx);
+    async getBucket(bucketName, options, callback) {
+        if (options instanceof Function) {
+            callback = arguments[1];
+            options = undefined;
+        }
+        if (!options) {
+            options = {};
+        }
+        const parentSpan = options.parentSpan;
+        const timeout = options.timeout;
+        return utilities_1.PromiseHelper.wrapAsync(async () => {
+            const res = await this._http.request({
+                type: httpexecutor_1.HttpServiceType.Management,
+                method: httpexecutor_1.HttpMethod.Get,
+                path: `/pools/default/buckets/${bucketName}`,
+                parentSpan: parentSpan,
+                timeout: timeout,
+            });
+            if (res.statusCode !== 200) {
+                const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
+                const errText = res.body.toString().toLowerCase();
+                if (errText.includes('not found')) {
+                    throw new errors_1.BucketNotFoundError(undefined, errCtx);
                 }
-                const bucketData = JSON.parse(res.body.toString());
-                return BucketSettings._fromNsData(bucketData);
-            }), callback);
-        });
+                throw new errors_1.CouchbaseError('failed to get bucket', undefined, errCtx);
+            }
+            const bucketData = JSON.parse(res.body.toString());
+            return BucketSettings._fromNsData(bucketData);
+        }, callback);
     }
     /**
      * Returns a list of existing buckets in the cluster.
@@ -390,34 +402,32 @@ class BucketManager {
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
      */
-    getAllBuckets(options, callback) {
-        return __awaiter(this, arguments, void 0, function* () {
-            if (options instanceof Function) {
-                callback = arguments[1];
-                options = undefined;
-            }
-            if (!options) {
-                options = {};
+    async getAllBuckets(options, callback) {
+        if (options instanceof Function) {
+            callback = arguments[0];
+            options = undefined;
+        }
+        if (!options) {
+            options = {};
+        }
+        const parentSpan = options.parentSpan;
+        const timeout = options.timeout;
+        return utilities_1.PromiseHelper.wrapAsync(async () => {
+            const res = await this._http.request({
+                type: httpexecutor_1.HttpServiceType.Management,
+                method: httpexecutor_1.HttpMethod.Get,
+                path: `/pools/default/buckets`,
+                parentSpan: parentSpan,
+                timeout: timeout,
+            });
+            if (res.statusCode !== 200) {
+                const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
+                throw new errors_1.CouchbaseError('failed to get buckets', undefined, errCtx);
             }
-            const parentSpan = options.parentSpan;
-            const timeout = options.timeout;
-            return utilities_1.PromiseHelper.wrapAsync(() => __awaiter(this, void 0, void 0, function* () {
-                const res = yield this._http.request({
-                    type: httpexecutor_1.HttpServiceType.Management,
-                    method: httpexecutor_1.HttpMethod.Get,
-                    path: `/pools/default/buckets`,
-                    parentSpan: parentSpan,
-                    timeout: timeout,
-                });
-                if (res.statusCode !== 200) {
-                    const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
-                    throw new errors_1.CouchbaseError('failed to get buckets', undefined, errCtx);
-                }
-                const bucketsData = JSON.parse(res.body.toString());
-                const buckets = bucketsData.map((bucketData) => BucketSettings._fromNsData(bucketData));
-                return buckets;
-            }), callback);
-        });
+            const bucketsData = JSON.parse(res.body.toString());
+            const buckets = bucketsData.map((bucketData) => BucketSettings._fromNsData(bucketData));
+            return buckets;
+        }, callback);
     }
     /**
      * Flushes the bucket, deleting all the existing data that is stored in it.
@@ -426,35 +436,33 @@ class BucketManager {
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
      */
-    flushBucket(bucketName, options, callback) {
-        return __awaiter(this, arguments, void 0, function* () {
-            if (options instanceof Function) {
-                callback = arguments[1];
-                options = undefined;
-            }
-            if (!options) {
-                options = {};
-            }
-            const parentSpan = options.parentSpan;
-            const timeout = options.timeout;
-            return utilities_1.PromiseHelper.wrapAsync(() => __awaiter(this, void 0, void 0, function* () {
-                const res = yield this._http.request({
-                    type: httpexecutor_1.HttpServiceType.Management,
-                    method: httpexecutor_1.HttpMethod.Post,
-                    path: `/pools/default/buckets/${bucketName}/controller/doFlush`,
-                    parentSpan: parentSpan,
-                    timeout: timeout,
-                });
-                if (res.statusCode !== 200) {
-                    const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
-                    const errText = res.body.toString().toLowerCase();
-                    if (errText.includes('not found')) {
-                        throw new errors_1.BucketNotFoundError(undefined, errCtx);
-                    }
-                    throw new errors_1.CouchbaseError('failed to get bucket', undefined, errCtx);
+    async flushBucket(bucketName, options, callback) {
+        if (options instanceof Function) {
+            callback = arguments[1];
+            options = undefined;
+        }
+        if (!options) {
+            options = {};
+        }
+        const parentSpan = options.parentSpan;
+        const timeout = options.timeout;
+        return utilities_1.PromiseHelper.wrapAsync(async () => {
+            const res = await this._http.request({
+                type: httpexecutor_1.HttpServiceType.Management,
+                method: httpexecutor_1.HttpMethod.Post,
+                path: `/pools/default/buckets/${bucketName}/controller/doFlush`,
+                parentSpan: parentSpan,
+                timeout: timeout,
+            });
+            if (res.statusCode !== 200) {
+                const errCtx = httpexecutor_1.HttpExecutor.errorContextFromResponse(res);
+                const errText = res.body.toString().toLowerCase();
+                if (errText.includes('not found')) {
+                    throw new errors_1.BucketNotFoundError(undefined, errCtx);
                 }
-            }), callback);
-        });
+                throw new errors_1.CouchbaseError('failed to get bucket', undefined, errCtx);
+            }
+        }, callback);
     }
 }
 exports.BucketManager = BucketManager;

package/dist/cluster.d.ts

@@ -5,6 +5,7 @@ import { Bucket } from './bucket';
 import { BucketManager } from './bucketmanager';
 import { Connection } from './connection';
 import { DiagnosticsOptions, DiagnosticsResult, PingOptions, PingResult } from './diagnosticstypes';
+import { EventingFunctionManager } from './eventingfunctionmanager';
 import { LogFunc } from './logging';
 import { Meter } from './metrics';
 import { QueryIndexManager } from './queryindexmanager';
@@ -158,6 +159,12 @@ export declare class Cluster {
      * indexes of this cluster.
      */
     searchIndexes(): SearchIndexManager;
+    /**
+     * Returns a EventingFunctionManager which can be used to manage the eventing
+     * functions of this cluster.
+     * Volatile: This API is subject to change at any time.
+     */
+    eventingFunctions(): EventingFunctionManager;
     /**
      * Executes a N1QL query against the cluster.
      *