couchbase 4.2.11 → 4.3.1

package/dist/collection.d.ts

@@ -12,7 +12,7 @@ import { Scope } from './scope';
 import { LookupInSpec, MutateInSpec } from './sdspecs';
 import { StreamableReplicasPromise, StreamableScanPromise } from './streamablepromises';
 import { Transcoder } from './transcoders';
-import { NodeCallback, Cas } from './utilities';
+import { NodeCallback, CasInput } from './utilities';
 /**
  * @category Key-Value
  */
@@ -132,7 +132,7 @@ export interface ReplaceOptions {
      * If specified, indicates that operation should be failed if the CAS
      * has changed from this value, indicating that the document has changed.
      */
-    cas?: Cas;
+    cas?: CasInput;
     /**
      * Specifies the level of synchronous durability for this operation.
      */
@@ -166,7 +166,7 @@ export interface RemoveOptions {
      * If specified, indicates that operation should be failed if the CAS
      * has changed from this value, indicating that the document has changed.
      */
-    cas?: Cas;
+    cas?: CasInput;
     /**
      * Specifies the level of synchronous durability for this operation.
      */
@@ -311,7 +311,7 @@ export interface MutateInOptions {
      * If specified, indicates that operation should be failed if the CAS
      * has changed from this value, indicating that the document has changed.
      */
-    cas?: Cas;
+    cas?: CasInput;
     /**
      * Specifies the level of synchronous durability for this operation.
      */
@@ -345,8 +345,6 @@ export interface MutateInOptions {
     upsertDocument?: boolean;
 }
 /**
- * Volatile: This API is subject to change at any time.
- *
  * @category Key-Value
  */
 export interface ScanOptions {
@@ -562,7 +560,7 @@ export declare class Collection {
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
      */
-    unlock(key: string, cas: Cas, options?: UnlockOptions, callback?: NodeCallback<void>): Promise<void>;
+    unlock(key: string, cas: CasInput, options?: UnlockOptions, callback?: NodeCallback<void>): Promise<void>;
     /**
      * @internal
      */
@@ -574,7 +572,9 @@ export declare class Collection {
     /**
      * Performs a key-value scan operation.
      *
-     * Volatile: This API is subject to change at any time.
+     * Use this API for low concurrency batch queries where latency is not a critical as the system
+     * may have to scan a lot of documents to find the matching documents.
+     * For low latency range queries, it is recommended that you use SQL++ with the necessary indexes.
      *
      * @param scanType The type of scan to execute.
      * @param options Optional parameters for the scan operation.

package/dist/collection.js

@@ -427,7 +427,7 @@ class Collection {
         if (!options) {
             options = {};
         }
-        const expiry = options.expiry;
+        const expiry = options.expiry ? (0, utilities_1.expiryToTimestamp)(options.expiry) : 0;
         const transcoder = options.transcoder || this.transcoder;
         const durabilityLevel = options.durabilityLevel;
         const persistTo = options.durabilityPersistTo;
@@ -442,7 +442,7 @@ class Collection {
                     id: this._cppDocId(key),
                     value: bytes,
                     flags,
-                    expiry: expiry || 0,
+                    expiry: expiry,
                     timeout,
                     partition: 0,
                     opaque: 0,
@@ -490,7 +490,7 @@ class Collection {
         if (!options) {
             options = {};
         }
-        const expiry = options.expiry;
+        const expiry = options.expiry ? (0, utilities_1.expiryToTimestamp)(options.expiry) : 0;
         const preserve_expiry = options.preserveExpiry;
         const transcoder = options.transcoder || this.transcoder;
         const durabilityLevel = options.durabilityLevel;
@@ -506,7 +506,7 @@ class Collection {
                     id: this._cppDocId(key),
                     value: bytes,
                     flags,
-                    expiry: expiry || 0,
+                    expiry: expiry,
                     preserve_expiry: preserve_expiry || false,
                     timeout,
                     partition: 0,
@@ -554,7 +554,7 @@ class Collection {
         if (!options) {
             options = {};
         }
-        const expiry = options.expiry || 0;
+        const expiry = options.expiry ? (0, utilities_1.expiryToTimestamp)(options.expiry) : 0;
         const cas = options.cas;
         const preserve_expiry = options.preserveExpiry;
         const transcoder = options.transcoder || this.transcoder;
@@ -679,7 +679,7 @@ class Collection {
         return utilities_1.PromiseHelper.wrap((wrapCallback) => {
             this._conn.getAndTouch({
                 id: this._cppDocId(key),
-                expiry,
+                expiry: (0, utilities_1.expiryToTimestamp)(expiry),
                 timeout,
                 partition: 0,
                 opaque: 0,
@@ -720,7 +720,7 @@ class Collection {
         return utilities_1.PromiseHelper.wrap((wrapCallback) => {
             this._conn.touch({
                 id: this._cppDocId(key),
-                expiry,
+                expiry: (0, utilities_1.expiryToTimestamp)(expiry),
                 timeout,
                 partition: 0,
                 opaque: 0,
@@ -876,7 +876,9 @@ class Collection {
     /**
      * Performs a key-value scan operation.
      *
-     * Volatile: This API is subject to change at any time.
+     * Use this API for low concurrency batch queries where latency is not a critical as the system
+     * may have to scan a lot of documents to find the matching documents.
+     * For low latency range queries, it is recommended that you use SQL++ with the necessary indexes.
      *
      * @param scanType The type of scan to execute.
      * @param options Optional parameters for the scan operation.
@@ -1142,7 +1144,9 @@ class Collection {
         const storeSemantics = options.upsertDocument
             ? generaltypes_1.StoreSemantics.Upsert
             : options.storeSemantics;
-        const expiry = options.expiry;
+        const expiry = options.expiry
+            ? (0, utilities_1.expiryToTimestamp)(options.expiry)
+            : undefined;
         const preserveExpiry = options.preserveExpiry;
         const cas = options.cas;
         const durabilityLevel = options.durabilityLevel;
@@ -1252,7 +1256,7 @@ class Collection {
             options = {};
         }
         const initial_value = options.initial;
-        const expiry = options.expiry;
+        const expiry = options.expiry ? (0, utilities_1.expiryToTimestamp)(options.expiry) : 0;
         const durabilityLevel = options.durabilityLevel;
         const persistTo = options.durabilityPersistTo;
         const replicateTo = options.durabilityReplicateTo;
@@ -1262,7 +1266,7 @@ class Collection {
                 id: this._cppDocId(key),
                 delta,
                 initial_value,
-                expiry: expiry || 0,
+                expiry: expiry,
                 timeout,
                 partition: 0,
                 opaque: 0,
@@ -1305,7 +1309,7 @@ class Collection {
             options = {};
         }
         const initial_value = options.initial;
-        const expiry = options.expiry;
+        const expiry = options.expiry ? (0, utilities_1.expiryToTimestamp)(options.expiry) : 0;
         const durabilityLevel = options.durabilityLevel;
         const persistTo = options.durabilityPersistTo;
         const replicateTo = options.durabilityReplicateTo;
@@ -1315,7 +1319,7 @@ class Collection {
                 id: this._cppDocId(key),
                 delta,
                 initial_value,
-                expiry: expiry || 0,
+                expiry: expiry,
                 timeout,
                 partition: 0,
                 opaque: 0,

package/dist/eventingfunctionmanager.d.ts

@@ -1,6 +1,7 @@
 import { Cluster } from './cluster';
 import { QueryScanConsistency } from './querytypes';
 import { NodeCallback } from './utilities';
+import { CppManagementEventingFunction, CppManagementEventingFunctionBucketBinding, CppManagementEventingFunctionConstantBinding, CppManagementEventingFunctionSettings, CppManagementEventingFunctionUrlBinding, CppManagementEventingStatus, CppManagementEventingFunctionState } from './binding';
 /**
  * Represents the various dcp boundary options for eventing functions.
  *
@@ -98,7 +99,12 @@ export declare enum EventingFunctionLanguageCompatibility {
      * Indicates that the function should run with compatibility with
      * Couchbase Server 6.6.2.
      */
-    Version_6_6_2 = "6.6.2"
+    Version_6_6_2 = "6.6.2",
+    /**
+     * Indicates that the function should run with compatibility with
+     * Couchbase Server 7.2.0.
+     */
+    Version_7_2_0 = "7.2.0"
 }
 /**
  * Represents the various log levels for an eventing function.
@@ -207,11 +213,11 @@ export declare class EventingFunctionBucketBinding {
     /**
      * @internal
      */
-    static _fromEvtData(data: any): EventingFunctionBucketBinding;
+    static _fromCppData(data: CppManagementEventingFunctionBucketBinding): EventingFunctionBucketBinding;
     /**
      * @internal
      */
-    static _toEvtData(data: EventingFunctionBucketBinding): any;
+    static _toCppData(data: EventingFunctionBucketBinding): CppManagementEventingFunctionBucketBinding;
 }
 /**
  * Specifies a type of url authentication to use.
@@ -310,11 +316,11 @@ export declare class EventingFunctionUrlBinding {
     /**
      * @internal
      */
-    static _fromEvtData(data: any): EventingFunctionUrlBinding;
+    static _fromCppData(data: CppManagementEventingFunctionUrlBinding): EventingFunctionUrlBinding;
     /**
      * @internal
      */
-    static _toEvtData(data: EventingFunctionUrlBinding): any;
+    static _toCppData(data: EventingFunctionUrlBinding): CppManagementEventingFunctionUrlBinding;
 }
 /**
  * Specifies a constant binding for an eventing function.
@@ -334,11 +340,11 @@ export declare class EventingFunctionConstantBinding {
     /**
      * @internal
      */
-    static _fromEvtData(data: any): EventingFunctionConstantBinding;
+    static _fromCppData(data: CppManagementEventingFunctionConstantBinding): EventingFunctionConstantBinding;
     /**
      * @internal
      */
-    static _toEvtData(data: EventingFunctionConstantBinding): any;
+    static _toCppData(data: EventingFunctionConstantBinding): CppManagementEventingFunctionConstantBinding;
 }
 /**
  * Specifies a number of options which can be used when updating or creating
@@ -351,133 +357,133 @@ export declare class EventingFunctionSettings {
     /**
      * The number of worker threads to use for the function.
      */
-    cppWorkerThreadCount: number;
+    cppWorkerThreadCount?: number;
     /**
      * The DCP stream boundary to use.
      */
-    dcpStreamBoundary: EventingFunctionDcpBoundary;
+    dcpStreamBoundary?: EventingFunctionDcpBoundary;
     /**
      * A description of this eventing function.
      */
-    description: string;
+    description?: string;
     /**
      * The current deployment status of the function.
      */
-    deploymentStatus: EventingFunctionDeploymentStatus;
+    deploymentStatus?: EventingFunctionDeploymentStatus;
     /**
      * The current processing status of the function.
      */
-    processingStatus: EventingFunctionProcessingStatus;
+    processingStatus?: EventingFunctionProcessingStatus;
     /**
      * The active compatibility mode for the function.
      */
-    languageCompatibility: EventingFunctionLanguageCompatibility;
+    languageCompatibility?: EventingFunctionLanguageCompatibility;
     /**
      * The level of logging that should be captured for the function.
      */
-    logLevel: EventingFunctionLogLevel;
+    logLevel?: EventingFunctionLogLevel;
     /**
      * The maximum period of time the function can execute on a document
      * before timing out.
      */
-    executionTimeout: number;
+    executionTimeout?: number;
     /**
      * The maximum number of internal clients that the function should
      * maintain for KV operations.
      */
-    lcbInstCapacity: number;
+    lcbInstCapacity?: number;
     /**
      * The maximum number of times to retry a KV operation before failing
      * the function.
      */
-    lcbRetryCount: number;
+    lcbRetryCount?: number;
     /**
      * The maximum period of time a KV operation within the function can
      * operate before timing out.
      */
-    lcbTimeout: number;
+    lcbTimeout?: number;
     /**
      * The level of consistency to use when performing queries in the function.
      */
-    queryConsistency: QueryScanConsistency;
+    queryConsistency?: QueryScanConsistency;
     /**
      * The number of partitions that should be used for timer tracking.
      */
-    numTimerPartitions: number;
+    numTimerPartitions?: number;
     /**
      * The batch size for messages from producer to consumer.
      */
-    sockBatchSize: number;
+    sockBatchSize?: number;
     /**
      * The duration to log stats from this handler, in milliseconds.
      */
-    tickDuration: number;
+    tickDuration?: number;
     /**
      * The size limit of timer context object.
      */
-    timerContextSize: number;
+    timerContextSize?: number;
     /**
      * The key prefix for all data stored in metadata by this handler.
      */
-    userPrefix: string;
+    userPrefix?: string;
     /**
      * The maximum size in bytes the bucket cache can grow to.
      */
-    bucketCacheSize: number;
+    bucketCacheSize?: number;
     /**
      * The time in milliseconds after which a cached bucket object is considered stale.
      */
-    bucketCacheAge: number;
+    bucketCacheAge?: number;
     /**
      * The maximum allowable curl call response in 'MegaBytes'. Setting the value to 0
      * lifts the upper limit off. This parameters affects v8 engine stability since it
      * defines the maximum amount of heap space acquired by a curl call.
      */
-    curlMaxAllowedRespSize: number;
+    curlMaxAllowedRespSize?: number;
     /**
      * Whether to automatically prepare all query statements in the handler.
      */
-    queryPrepareAll: boolean;
+    queryPrepareAll?: boolean;
     /**
      * The number of worker processes handler utilizes on each eventing node.
      */
-    workerCount: number;
+    workerCount?: number;
     /**
      * The code to automatically prepend to top of handler code.
      */
-    handlerHeaders: string[];
+    handlerHeaders?: string[];
     /**
      * The code to automatically append to bottom of handler code.
      */
-    handlerFooters: string[];
+    handlerFooters?: string[];
     /**
      * Whether to enable rotating this handlers log() message files.
      */
-    enableAppLogRotation: boolean;
+    enableAppLogRotation?: boolean;
     /**
      * The directory to write content of log() message files.
      */
-    appLogDir: string;
+    appLogDir?: string;
     /**
      * The size in bytes of the log file when the file should be rotated.
      */
-    appLogMaxSize: number;
+    appLogMaxSize?: number;
     /**
      * The number of log() message files to retain when rotating.
      */
-    appLogMaxFiles: number;
+    appLogMaxFiles?: number;
     /**
      * The number of seconds before writing a progress checkpoint.
      */
-    checkpointInterval: number;
+    checkpointInterval?: number;
     /**
      * @internal
      */
-    static _fromEvtData(data: any): EventingFunctionSettings;
+    static _fromCppData(data: CppManagementEventingFunctionSettings): EventingFunctionSettings;
     /**
      * @internal
      */
-    static _toEvtData(data: EventingFunctionSettings): any;
+    static _toCppData(data: EventingFunctionSettings): CppManagementEventingFunctionSettings;
 }
 /**
  * Describes an eventing function.
@@ -497,19 +503,19 @@ export declare class EventingFunction {
     /**
      * The authoring version of this eventing function.
      */
-    version: string;
+    version?: string;
     /**
      * Whether to enable stricter validation of settings and configuration.
      */
-    enforceSchema: boolean;
+    enforceSchema?: boolean;
     /**
      * The unique ID for this eventing function.
      */
-    handlerUuid: number;
+    handlerUuid?: number;
     /**
      * The unique id for the deployment of the handler.
      */
-    functionInstanceId: string;
+    functionInstanceId?: string;
     /**
      * The keyspace to store the functions metadata.
      */
@@ -537,11 +543,11 @@ export declare class EventingFunction {
     /**
      * @internal
      */
-    static _fromEvtData(data: any): EventingFunction;
+    static _fromCppData(data: CppManagementEventingFunction): EventingFunction;
     /**
      * @internal
      */
-    static _toEvtData(data: EventingFunction): any;
+    static _toCppData(data: EventingFunction): CppManagementEventingFunction;
 }
 /**
  * Describes the current state of an eventing function.
@@ -577,7 +583,7 @@ export declare class EventingFunctionState {
     /**
      * @internal
      */
-    static _fromEvtData(data: any): EventingFunctionState;
+    static _fromCppData(data: CppManagementEventingFunctionState): EventingFunctionState;
 }
 /**
  * Describes the current state of all eventing function.
@@ -597,7 +603,7 @@ export declare class EventingState {
     /**
      * @internal
      */
-    static _fromEvtData(data: any): EventingState;
+    static _fromCppData(data: CppManagementEventingStatus): EventingState;
 }
 /**
  * @category Management
@@ -683,7 +689,7 @@ export interface FunctionsStatusOptions {
 /**
  * EventingFunctionManager provides an interface for managing the
  * eventing functions on the cluster.
- * Volatile: This API is subject to change at any time.
+ * Uncommitted: This API is subject to change in the future.
  *
  * @category Management
  */
@@ -693,7 +699,6 @@ export declare class EventingFunctionManager {
      * @internal
      */
     constructor(cluster: Cluster);
-    private get _http();
     /**
      * Creates or updates an eventing function.
      *