couchbase 4.6.1 → 4.7.0-dev.1

package/dist/bindingutilities.js

@@ -987,7 +987,7 @@ exports.scanTypeToCpp = scanTypeToCpp;
  */
 function bucketTypeToCpp(type) {
     if (type === null || type === undefined) {
-        return binding_1.default.management_cluster_bucket_type.couchbase;
+        return binding_1.default.management_cluster_bucket_type.unknown;
     }
     if (type === bucketmanager_1.BucketType.Couchbase) {
         return binding_1.default.management_cluster_bucket_type.couchbase;

package/dist/bucket.d.ts

@@ -63,6 +63,10 @@ export declare class Bucket {
     /**
      * Returns a ViewIndexManager which can be used to manage the view indexes
      * of this bucket.
+     *
+     * @deprecated Since version 4.7.0. Views are deprecated in Couchbase Server 7.0+, and will be removed from a future server version.
+     *             Views are not compatible with the Magma storage engine. Instead of views, use indexes and queries using the
+     *             Index Service (GSI) and the Query Service (SQL++).
      */
     viewIndexes(): ViewIndexManager;
     /**
@@ -73,6 +77,10 @@ export declare class Bucket {
     /**
      * Executes a view query.
      *
+     * @deprecated Since version 4.7.0. Views are deprecated in Couchbase Server 7.0+, and will be removed from a future server version.
+     *             Views are not compatible with the Magma storage engine. Instead of views, use indexes and queries using the
+     *             Index Service (GSI) and the Query Service (SQL++).
+     *
      * @param designDoc The name of the design document containing the view to execute.
      * @param viewName The name of the view to execute.
      * @param options Optional parameters for this operation.

package/dist/bucket.js

@@ -80,6 +80,10 @@ class Bucket {
     /**
      * Returns a ViewIndexManager which can be used to manage the view indexes
      * of this bucket.
+     *
+     * @deprecated Since version 4.7.0. Views are deprecated in Couchbase Server 7.0+, and will be removed from a future server version.
+     *             Views are not compatible with the Magma storage engine. Instead of views, use indexes and queries using the
+     *             Index Service (GSI) and the Query Service (SQL++).
      */
     viewIndexes() {
         return new viewindexmanager_1.ViewIndexManager(this);
@@ -94,6 +98,10 @@ class Bucket {
     /**
      * Executes a view query.
      *
+     * @deprecated Since version 4.7.0. Views are deprecated in Couchbase Server 7.0+, and will be removed from a future server version.
+     *             Views are not compatible with the Magma storage engine. Instead of views, use indexes and queries using the
+     *             Index Service (GSI) and the Query Service (SQL++).
+     *
      * @param designDoc The name of the design document containing the view to execute.
      * @param viewName The name of the view to execute.
      * @param options Optional parameters for this operation.

package/dist/bucketmanager.d.ts

@@ -1,6 +1,8 @@
 import { CppManagementClusterBucketSettings } from './binding';
 import { Cluster } from './cluster';
 import { DurabilityLevel } from './generaltypes';
+import { ObservabilityInstruments } from './observabilitytypes';
+import { RequestSpan } from './tracing';
 import { NodeCallback } from './utilities';
 /**
  * Represents the various conflict resolution modes which can be used for
@@ -331,6 +333,10 @@ export interface CreateBucketOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Management
@@ -340,6 +346,10 @@ export interface UpdateBucketOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Management
@@ -349,6 +359,10 @@ export interface DropBucketOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Management
@@ -358,6 +372,10 @@ export interface GetBucketOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Management
@@ -367,6 +385,10 @@ export interface GetAllBucketsOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Management
@@ -376,6 +398,10 @@ export interface FlushBucketOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * BucketManager provides an interface for adding/removing/updating
@@ -389,6 +415,10 @@ export declare class BucketManager {
      * @internal
      */
     constructor(cluster: Cluster);
+    /**
+     * @internal
+     */
+    get observabilityInstruments(): ObservabilityInstruments;
     /**
      * Creates a new bucket.
      *

package/dist/bucketmanager.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BucketManager = exports.BucketSettings = exports.CompressionMode = exports.EvictionPolicy = exports.StorageBackend = exports.BucketType = exports.ConflictResolutionType = void 0;
 const bindingutilities_1 = require("./bindingutilities");
+const observability_1 = require("./observability");
+const observabilityhandler_1 = require("./observabilityhandler");
+const observabilitytypes_1 = require("./observabilitytypes");
 const utilities_1 = require("./utilities");
 /**
  * Represents the various conflict resolution modes which can be used for
@@ -175,14 +178,22 @@ class BucketSettings {
      * @internal
      */
     static _toCppData(data) {
+        let durabilityInput;
+        if (data.durabilityMinLevel !== undefined) {
+            durabilityInput = (0, utilities_1.nsServerStrToDuraLevel)(data.durabilityMinLevel);
+        }
+        else if (data.minimumDurabilityLevel !== undefined) {
+            durabilityInput = data.minimumDurabilityLevel;
+        }
         return {
             name: data.name,
             bucket_type: (0, bindingutilities_1.bucketTypeToCpp)(data.bucketType),
             ram_quota_mb: data.ramQuotaMB,
             max_expiry: data.maxTTL || data.maxExpiry,
             compression_mode: (0, bindingutilities_1.bucketCompressionModeToCpp)(data.compressionMode),
-            minimum_durability_level: (0, bindingutilities_1.durabilityToCpp)((0, utilities_1.nsServerStrToDuraLevel)(data.durabilityMinLevel)) ||
-                (0, bindingutilities_1.durabilityToCpp)(data.minimumDurabilityLevel),
+            minimum_durability_level: durabilityInput !== undefined
+                ? (0, bindingutilities_1.durabilityToCpp)(durabilityInput)
+                : durabilityInput,
             num_replicas: data.numReplicas,
             replica_indexes: data.replicaIndexes,
             flush_enabled: data.flushEnabled,
@@ -258,6 +269,12 @@ class BucketManager {
     constructor(cluster) {
         this._cluster = cluster;
     }
+    /**
+     * @internal
+     */
+    get observabilityInstruments() {
+        return this._cluster.observabilityInstruments;
+    }
     /**
      * Creates a new bucket.
      *
@@ -273,20 +290,27 @@ class BucketManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.BucketMgmtOp.BucketCreate, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes({ bucketName: settings.name });
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
             const bucketData = CreateBucketSettings._toCppData(settings);
-            this._cluster.conn.managementBucketCreate({
-                bucket: bucketData,
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementBucketCreate.bind(this._cluster.conn), {
+                    bucket: bucketData,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Updates the settings for an existing bucket.
@@ -303,20 +327,27 @@ class BucketManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.BucketMgmtOp.BucketUpdate, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes({ bucketName: settings.name });
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
             const bucketData = BucketSettings._toCppData(settings);
-            this._cluster.conn.managementBucketUpdate({
-                bucket: bucketData,
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementBucketUpdate.bind(this._cluster.conn), {
+                    bucket: bucketData,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Drops an existing bucket.
@@ -333,19 +364,26 @@ class BucketManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementBucketDrop({
-                name: bucketName,
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.BucketMgmtOp.BucketDrop, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes({ bucketName: bucketName });
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementBucketDrop.bind(this._cluster.conn), {
+                    name: bucketName,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Fetches the settings in use for a specified bucket.
@@ -362,20 +400,27 @@ class BucketManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementBucketGet({
-                name: bucketName,
-                timeout: timeout,
-            }, (cppErr, resp) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.BucketMgmtOp.BucketGet, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes({ bucketName: bucketName });
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, resp] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementBucketGet.bind(this._cluster.conn), {
+                    name: bucketName,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                const bucket = BucketSettings._fromCppData(resp.bucket);
-                wrapCallback(null, bucket);
-            });
-        }, callback);
+                obsReqHandler.end();
+                return BucketSettings._fromCppData(resp.bucket);
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Returns a list of existing buckets in the cluster.
@@ -391,19 +436,26 @@ class BucketManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementBucketGetAll({
-                timeout: timeout,
-            }, (cppErr, resp) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.BucketMgmtOp.BucketGetAll, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, resp] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementBucketGetAll.bind(this._cluster.conn), {
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                const buckets = resp.buckets.map((bucketData) => BucketSettings._fromCppData(bucketData));
-                wrapCallback(null, buckets);
-            });
-        }, callback);
+                obsReqHandler.end();
+                return resp.buckets.map((bucketData) => BucketSettings._fromCppData(bucketData));
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Flushes the bucket, deleting all the existing data that is stored in it.
@@ -420,19 +472,26 @@ class BucketManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementBucketFlush({
-                name: bucketName,
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.BucketMgmtOp.BucketFlush, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes({ bucketName: bucketName });
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementBucketFlush.bind(this._cluster.conn), {
+                    name: bucketName,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
 }
 exports.BucketManager = BucketManager;

package/dist/cluster.d.ts

@@ -7,12 +7,16 @@ import { Bucket } from './bucket';
 import { BucketManager } from './bucketmanager';
 import { DiagnosticsOptions, DiagnosticsResult, PingOptions, PingResult } from './diagnosticstypes';
 import { EventingFunctionManager } from './eventingfunctionmanager';
+import { CouchbaseLogger, Logger } from './logger';
+import { Meter } from './metrics';
+import { ObservabilityInstruments } from './observabilitytypes';
 import { QueryIndexManager } from './queryindexmanager';
 import { QueryMetaData, QueryOptions, QueryResult } from './querytypes';
 import { SearchIndexManager } from './searchindexmanager';
 import { SearchQuery } from './searchquery';
 import { SearchMetaData, SearchQueryOptions, SearchRequest, SearchResult, SearchRow } from './searchtypes';
 import { StreamableRowPromise } from './streamablepromises';
+import { RequestTracer } from './tracing';
 import { Transactions, TransactionsConfig } from './transactions';
 import { Transcoder } from './transcoders';
 import { UserManager } from './usermanager';
@@ -192,6 +196,11 @@ export interface TracingConfig {
  * @category Core
  */
 export interface OrphanReporterConfig {
+    /**
+     * Specifies to enable or disable orphaned response logging.
+     * Defaults to true (enabled) if not specified.
+     */
+    enableOrphanReporting?: boolean;
     /**
      * Specifies the interval after which the aggregated orphaned response information is logged, specified in millseconds.
      * Defaults to 10000 (10 seconds) if not specified.
@@ -284,6 +293,10 @@ export interface ConnectOptions {
      *
      */
     appTelemetryConfig?: AppTelemetryConfig;
+    /**
+     * Specifies the request tracer for this cluster.
+     */
+    tracer?: RequestTracer;
     /**
      * Specifies the tracing (threshold logging) config for connections of this cluster.
      */
@@ -292,10 +305,18 @@ export interface ConnectOptions {
      * Specifies the orphan report logging config for connections of this cluster.
      */
     orphanReporterConfig?: OrphanReporterConfig;
+    /**
+     * Specifies the meter for this cluster.
+     */
+    meter?: Meter;
     /**
      * Specifies the metrics config for connections of this cluster.
      */
     metricsConfig?: MetricsConfig;
+    /**
+     * Provides an implementation of the {@link Logger} interface to be used by the SDK.
+     */
+    logger?: Logger;
 }
 /**
  * Exposes the operations which are available to be performed against a cluster.
@@ -326,9 +347,13 @@ export declare class Cluster {
     private _dnsConfig;
     private _preferredServerGroup;
     private _appTelemetryConfig;
+    private _tracer;
+    private _observabilityInstruments;
     private _tracingConfig;
     private _orphanReporterConfig;
     private _metricsConfig;
+    private _meter;
+    private _logger;
     /**
      * @internal
      */
@@ -377,6 +402,14 @@ export declare class Cluster {
     @internal
     */
     get resolveTimeout(): number | undefined;
+    /**
+    @internal
+    */
+    get logger(): CouchbaseLogger;
+    /**
+     * @internal
+     */
+    get observabilityInstruments(): ObservabilityInstruments;
     /**
      * @internal
      */
@@ -494,5 +527,17 @@ export declare class Cluster {
      * @param callback A node-style callback to be invoked after execution.
      */
     close(callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Update the credentials used by this cluster.
+     *
+     * @param auth The new credentials to use.
+     */
+    updateCredentials(auth: Authenticator): void;
+    /**
+     * @internal
+     */
+    _getClusterLabels(): Record<string, string | undefined>;
+    private _getCppCredentials;
+    private _setupObservability;
     private _connect;
 }