couchbase 4.2.11-rc.1 → 4.3.0

package/dist/bucketmanager.d.ts

@@ -163,8 +163,6 @@ export interface IBucketSettings {
      */
     minimumDurabilityLevel?: DurabilityLevel | string;
     /**
-     * Uncommitted: This API is subject to change in the future.
-     *
      * Specifies the default history retention on all collections in this bucket.
      * Only available on Magma Buckets.
      *
@@ -172,14 +170,10 @@ export interface IBucketSettings {
      */
     historyRetentionCollectionDefault?: boolean;
     /**
-     * Uncommitted: This API is subject to change in the future.
-     *
      * Specifies the maximum history retention in bytes on all collections in this bucket.
      */
     historyRetentionBytes?: number;
     /**
-     * Uncommitted: This API is subject to change in the future.
-     *
      * Specifies the maximum duration in seconds to be covered by the change history that is written
      * to disk for all collections in this bucket.
      */
@@ -261,8 +255,6 @@ export declare class BucketSettings implements IBucketSettings {
      */
     minimumDurabilityLevel?: DurabilityLevel;
     /**
-     * Uncommitted: This API is subject to change in the future.
-     *
      * Specifies the default history retention on all collections in this bucket.
      * Only available on Magma Buckets.
      *
@@ -270,14 +262,10 @@ export declare class BucketSettings implements IBucketSettings {
      */
     historyRetentionCollectionDefault?: boolean;
     /**
-     * Uncommitted: This API is subject to change in the future.
-     *
      * Specifies the maximum history retention in bytes on all collections in this bucket.
      */
     historyRetentionBytes?: number;
     /**
-     * Uncommitted: This API is subject to change in the future.
-     *
      * Specifies the maximum duration in seconds to be covered by the change history that is written
      * to disk for all collections in this bucket.
      */

package/dist/cluster.d.ts

@@ -303,8 +303,6 @@ export declare class Cluster {
     /**
      * Executes a search query against the cluster.
      *
-     * Volatile: This API is subject to change at any time.
-     *
      * @param indexName The name of the index to query.
      * @param request The SearchRequest describing the search to execute.
      * @param options Optional parameters for this operation.

package/dist/cluster.js

@@ -320,8 +320,6 @@ class Cluster {
     /**
      * Executes a search query against the cluster.
      *
-     * Volatile: This API is subject to change at any time.
-     *
      * @param indexName The name of the index to query.
      * @param request The SearchRequest describing the search to execute.
      * @param options Optional parameters for this operation.

package/dist/collection.d.ts

@@ -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 {
@@ -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

@@ -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.

package/dist/querytypes.d.ts

@@ -281,8 +281,6 @@ export interface QueryOptions {
      */
     readOnly?: boolean;
     /**
-     * Uncommitted: This API is subject to change in the future.
-     *
      * Specifies whether the query engine should use replica nodes for kv fetches,
      * if the active node is down.
      */

package/dist/rangeScan.d.ts

@@ -1,8 +1,6 @@
 /**
  * Represents a search term for a RangeScan.
  *
- * Volatile: This API is subject to change at any time.
- *
  * @see {@link RangeScan}
  * @category Key-Value
  */
@@ -36,8 +34,6 @@ export interface ScanType {
  * A RangeScan performs a scan on a range of keys with the range specified through
  * a start and end ScanTerm.
  *
- * Volatile: This API is subject to change at any time.
- *
  * @category Key-Value
  */
 export declare class RangeScan implements ScanType {
@@ -62,8 +58,6 @@ export declare class RangeScan implements ScanType {
  * A SamplingScan performs a scan on a random sampling of keys with the sampling bounded by
  * a limit.
  *
- * Volatile: This API is subject to change at any time.
- *
  * @category Key-Value
  */
 export declare class SamplingScan implements ScanType {
@@ -87,8 +81,6 @@ export declare class SamplingScan implements ScanType {
 /**
  * A PrefixScan scan type selects every document whose ID starts with a certain prefix.
  *
- * Volatile: This API is subject to change at any time.
- *
  * @category key-value
  */
 export declare class PrefixScan implements ScanType {

package/dist/rangeScan.js

@@ -4,8 +4,6 @@ exports.PrefixScan = exports.SamplingScan = exports.RangeScan = exports.ScanTerm
 /**
  * Represents a search term for a RangeScan.
  *
- * Volatile: This API is subject to change at any time.
- *
  * @see {@link RangeScan}
  * @category Key-Value
  */
@@ -23,8 +21,6 @@ exports.ScanTerm = ScanTerm;
  * A RangeScan performs a scan on a range of keys with the range specified through
  * a start and end ScanTerm.
  *
- * Volatile: This API is subject to change at any time.
- *
  * @category Key-Value
  */
 class RangeScan {
@@ -47,8 +43,6 @@ exports.RangeScan = RangeScan;
  * A SamplingScan performs a scan on a random sampling of keys with the sampling bounded by
  * a limit.
  *
- * Volatile: This API is subject to change at any time.
- *
  * @category Key-Value
  */
 class SamplingScan {
@@ -70,8 +64,6 @@ exports.SamplingScan = SamplingScan;
 /**
  * A PrefixScan scan type selects every document whose ID starts with a certain prefix.
  *
- * Volatile: This API is subject to change at any time.
- *
  * @category key-value
  */
 class PrefixScan {

package/dist/scope.d.ts

@@ -56,9 +56,6 @@ export declare class Scope {
     /**
      * Returns a SearchIndexManager which can be used to manage the search
      * indexes of this scope.
-     *
-     * Volatile: This API is subject to change at any time.
-     *
      */
     searchIndexes(): ScopeSearchIndexManager;
     /**
@@ -80,8 +77,6 @@ export declare class Scope {
     /**
      * Executes a search query against the scope.
      *
-     * Volatile: This API is subject to change at any time.
-     *
      * @param indexName The name of the index to query.
      * @param request The SearchRequest describing the search to execute.
      * @param options Optional parameters for this operation.

package/dist/scope.js

@@ -69,9 +69,6 @@ class Scope {
     /**
      * Returns a SearchIndexManager which can be used to manage the search
      * indexes of this scope.
-     *
-     * Volatile: This API is subject to change at any time.
-     *
      */
     searchIndexes() {
         return new scopesearchindexmanager_1.ScopeSearchIndexManager(this.cluster, this.bucket.name, this._name);
@@ -125,8 +122,6 @@ class Scope {
     /**
      * Executes a search query against the scope.
      *
-     * Volatile: This API is subject to change at any time.
-     *
      * @param indexName The name of the index to query.
      * @param request The SearchRequest describing the search to execute.
      * @param options Optional parameters for this operation.

package/dist/scopesearchindexmanager.d.ts

@@ -5,8 +5,6 @@ import { GetSearchIndexOptions, GetAllSearchIndexesOptions, UpsertSearchIndexOpt
  * SearchIndexManager provides an interface for managing the
  * search indexes on the cluster.
  *
- * Volatile: This API is subject to change at any time.
- *
  * @category Management
  */
 export declare class ScopeSearchIndexManager {

package/dist/scopesearchindexmanager.js

@@ -8,8 +8,6 @@ const searchindexmanager_1 = require("./searchindexmanager");
  * SearchIndexManager provides an interface for managing the
  * search indexes on the cluster.
  *
- * Volatile: This API is subject to change at any time.
- *
  * @category Management
  */
 class ScopeSearchIndexManager {

package/dist/searchexecutor.js

@@ -67,9 +67,11 @@ class SearchExecutor {
                     .map(([k, v]) => [k, JSON.stringify(v)]))
                 : {},
             body_str: '',
+            show_request: options.showRequest || false,
+            log_request: options.logRequest || false,
+            log_response: options.logResponse || false,
         };
         if (query instanceof searchtypes_1.SearchRequest) {
-            request.show_request = false;
             if (query.vectorSearch) {
                 request.vector_search = JSON.stringify(query.vectorSearch.queries);
                 if (query.vectorSearch.options &&

package/dist/searchtypes.d.ts

@@ -146,12 +146,24 @@ export interface SearchQueryOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies that the search response should include the request JSON.
+     */
+    showRequest?: boolean;
+    /**
+     * Uncommitted: This API is subject to change in the future.
+     * Specifies that the search request should appear in the log.
+     */
+    logRequest?: boolean;
+    /**
+     * Uncommitted: This API is subject to change in the future.
+     * Specifies that the search response should appear in the log.
+     */
+    logResponse?: boolean;
 }
 /**
  *  Represents a search query and/or vector search to execute via the Couchbase Full Text Search (FTS) service.
  *
- *  Volatile: This API is subject to change at any time.
- *
  * @category Full Text Search
  */
 export declare class SearchRequest {
@@ -169,7 +181,7 @@ export declare class SearchRequest {
     /**
      * Adds a search query to the request if the request does not already have a search query.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param query A SearchQuery to add to the request.
      */
@@ -177,7 +189,7 @@ export declare class SearchRequest {
     /**
      * Adds a vector search to the request if the request does not already have a vector search.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param search A VectorSearch to add to the request.
      */
@@ -185,8 +197,6 @@ export declare class SearchRequest {
     /**
      * Creates a search request.
      *
-     * Volatile: This API is subject to change at any time.
-     *
      * @param query Either a SearchQuery or VectorSearch to add to the search request.
      */
     static create(query: SearchQuery | VectorSearch): SearchRequest;

package/dist/searchtypes.js

@@ -73,8 +73,6 @@ var SearchScanConsistency;
 /**
  *  Represents a search query and/or vector search to execute via the Couchbase Full Text Search (FTS) service.
  *
- *  Volatile: This API is subject to change at any time.
- *
  * @category Full Text Search
  */
 class SearchRequest {
@@ -104,7 +102,7 @@ class SearchRequest {
     /**
      * Adds a search query to the request if the request does not already have a search query.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param query A SearchQuery to add to the request.
      */
@@ -121,7 +119,7 @@ class SearchRequest {
     /**
      * Adds a vector search to the request if the request does not already have a vector search.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param search A VectorSearch to add to the request.
      */
@@ -138,8 +136,6 @@ class SearchRequest {
     /**
      * Creates a search request.
      *
-     * Volatile: This API is subject to change at any time.
-     *
      * @param query Either a SearchQuery or VectorSearch to add to the search request.
      */
     static create(query) {

package/dist/transactions.d.ts

@@ -29,6 +29,25 @@ export declare class DocumentId {
      */
     key: string;
 }
+/**
+ * Specifies the configuration options for a Transaction Keyspace.
+ *
+ * @category Transactions
+ */
+export interface TransactionKeyspace {
+    /**
+     * The name of the bucket for the Keyspace.
+     */
+    bucket: string;
+    /**
+     * The name of the scope for the Keyspace.
+     */
+    scope?: string;
+    /**
+     * The name of the collection for the Keyspace.
+     */
+    collection?: string;
+}
 /**
  * Specifies the configuration options for Transactions cleanup.
  *
@@ -87,6 +106,10 @@ export interface TransactionsConfig {
      * Specifies the configuration for the cleanup system.
      */
     cleanupConfig?: TransactionsCleanupConfig;
+    /**
+     * Specifies the Keyspace (bucket, scope & collection) for the transaction metadata.
+     */
+    metadataCollection?: TransactionKeyspace;
 }
 /**
  * Specifies the configuration options for a Transaction.

package/dist/transactions.js

@@ -311,16 +311,22 @@ class Transactions {
             config.queryConfig = {};
         }
         const connImpl = cluster.conn;
-        const txnsImpl = new binding_1.default.Transactions(connImpl, {
-            durability_level: (0, bindingutilities_1.durabilityToCpp)(config.durabilityLevel),
-            timeout: config.timeout,
-            query_scan_consistency: (0, bindingutilities_1.queryScanConsistencyToCpp)(config.queryConfig.scanConsistency),
-            cleanup_window: config.cleanupConfig.cleanupWindow,
-            cleanup_lost_attempts: !config.cleanupConfig.disableLostAttemptCleanup,
-            cleanup_client_attempts: !config.cleanupConfig.disableClientAttemptCleanup,
-        });
-        this._cluster = cluster;
-        this._impl = txnsImpl;
+        try {
+            const txnsImpl = new binding_1.default.Transactions(connImpl, {
+                durability_level: (0, bindingutilities_1.durabilityToCpp)(config.durabilityLevel),
+                timeout: config.timeout,
+                query_scan_consistency: (0, bindingutilities_1.queryScanConsistencyToCpp)(config.queryConfig.scanConsistency),
+                cleanup_window: config.cleanupConfig.cleanupWindow,
+                cleanup_lost_attempts: !config.cleanupConfig.disableLostAttemptCleanup,
+                cleanup_client_attempts: !config.cleanupConfig.disableClientAttemptCleanup,
+                metadata_collection: (0, bindingutilities_1.transactionKeyspaceToCpp)(config.metadataCollection),
+            });
+            this._cluster = cluster;
+            this._impl = txnsImpl;
+        }
+        catch (err) {
+            throw (0, bindingutilities_1.errorFromCpp)(err);
+        }
     }
     /**
     @internal

package/dist/vectorsearch.d.ts

@@ -1,7 +1,7 @@
 /**
  * Specifies how multiple vector searches are combined.
  *
- * Volatile: This API is subject to change at any time.
+ * Uncommitted: This API is subject to change in the future.
  *
  * @category Full Text Search
  */
@@ -16,7 +16,7 @@ export declare enum VectorQueryCombination {
     OR = "or"
 }
 /**
- * Volatile: This API is subject to change at any time.
+ * Uncommitted: This API is subject to change in the future.
  *
  * @category Full Text Search
  */
@@ -29,7 +29,7 @@ export interface VectorSearchOptions {
 /**
  * Represents a vector query.
  *
- * Volatile: This API is subject to change at any time.
+ * Uncommitted: This API is subject to change in the future.
  *
  * @category Full Text Search
  */
@@ -46,7 +46,7 @@ export declare class VectorQuery {
     /**
      * Adds boost option to vector query.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param boost A floating point value.
      */
@@ -54,7 +54,7 @@ export declare class VectorQuery {
     /**
      * Adds numCandidates option to vector query. Value must be >= 1.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param numCandidates An integer value.
      */
@@ -62,7 +62,7 @@ export declare class VectorQuery {
     /**
      * Creates a vector query.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param fieldName The name of the field in the JSON document that holds the vector.
      * @param vector List of floating point values that represent the vector.
@@ -72,7 +72,7 @@ export declare class VectorQuery {
 /**
  * Represents a vector search.
  *
- * Volatile: This API is subject to change at any time.
+ * Uncommitted: This API is subject to change in the future.
  *
  * @category Full Text Search
  */
@@ -91,7 +91,7 @@ export declare class VectorSearch {
     /**
      * Creates a vector search.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param query A vectory query that should be a part of the vector search.
      */

package/dist/vectorsearch.js

@@ -5,7 +5,7 @@ const errors_1 = require("./errors");
 /**
  * Specifies how multiple vector searches are combined.
  *
- * Volatile: This API is subject to change at any time.
+ * Uncommitted: This API is subject to change in the future.
  *
  * @category Full Text Search
  */
@@ -23,7 +23,7 @@ var VectorQueryCombination;
 /**
  * Represents a vector query.
  *
- * Volatile: This API is subject to change at any time.
+ * Uncommitted: This API is subject to change in the future.
  *
  * @category Full Text Search
  */
@@ -53,7 +53,7 @@ class VectorQuery {
     /**
      * Adds boost option to vector query.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param boost A floating point value.
      */
@@ -64,7 +64,7 @@ class VectorQuery {
     /**
      * Adds numCandidates option to vector query. Value must be >= 1.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param numCandidates An integer value.
      */
@@ -78,7 +78,7 @@ class VectorQuery {
     /**
      * Creates a vector query.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param fieldName The name of the field in the JSON document that holds the vector.
      * @param vector List of floating point values that represent the vector.
@@ -91,7 +91,7 @@ exports.VectorQuery = VectorQuery;
 /**
  * Represents a vector search.
  *
- * Volatile: This API is subject to change at any time.
+ * Uncommitted: This API is subject to change in the future.
  *
  * @category Full Text Search
  */
@@ -121,7 +121,7 @@ class VectorSearch {
     /**
      * Creates a vector search.
      *
-     * Volatile: This API is subject to change at any time.
+     * Uncommitted: This API is subject to change in the future.
      *
      * @param query A vectory query that should be a part of the vector search.
      */

package/package.json

@@ -54,7 +54,7 @@
     "type": "git",
     "url": "http://github.com/couchbase/couchnode.git"
   },
-  "version": "4.2.11-rc.1",
+  "version": "4.3.0",
   "config": {
     "native": false
   },
@@ -79,12 +79,12 @@
     ]
   },
   "optionalDependencies": {
-    "@couchbase/couchbase-darwin-arm64-napi": "4.2.11-rc.1",
-    "@couchbase/couchbase-darwin-x64-napi": "4.2.11-rc.1",
-    "@couchbase/couchbase-linux-arm64-napi": "4.2.11-rc.1",
-    "@couchbase/couchbase-linuxmusl-x64-napi": "4.2.11-rc.1",
-    "@couchbase/couchbase-linux-x64-napi": "4.2.11-rc.1",
-    "@couchbase/couchbase-win32-x64-napi": "4.2.11-rc.1"
+    "@couchbase/couchbase-darwin-arm64-napi": "4.3.0",
+    "@couchbase/couchbase-darwin-x64-napi": "4.3.0",
+    "@couchbase/couchbase-linux-arm64-napi": "4.3.0",
+    "@couchbase/couchbase-linuxmusl-x64-napi": "4.3.0",
+    "@couchbase/couchbase-linux-x64-napi": "4.3.0",
+    "@couchbase/couchbase-win32-x64-napi": "4.3.0"
   },
   "files": [
     "LICENSE",

package/src/instance.cpp

@@ -6,7 +6,17 @@ namespace couchnode
 Instance::Instance()
     : _cluster(couchbase::core::cluster(_io))
 {
-    _ioThread = std::thread([this]() { _io.run(); });
+    _ioThread = std::thread([this]() {
+        try {
+            _io.run();
+        } catch (const std::exception &e) {
+            CB_LOG_ERROR(e.what());
+            throw;
+        } catch (...) {
+            CB_LOG_ERROR("Unknown exception");
+            throw;
+        }
+    });
 }
 
 Instance::~Instance()

package/src/instance.hpp

@@ -1,6 +1,7 @@
 #pragma once
 #include <asio/io_context.hpp>
 #include <core/cluster.hxx>
+#include <core/logger/logger.hxx>
 #include <memory>
 #include <thread>
 

package/src/jstocbpp_autogen.hpp

@@ -19,7 +19,6 @@
 #include <core/operations/management/user.hxx>
 #include <core/operations/management/view.hxx>
 #include <core/range_scan_orchestrator_options.hxx>
-#include <core/scan_options.hxx>
 
 namespace couchnode
 {
@@ -3917,6 +3916,10 @@ struct js_to_cbpp_t<couchbase::core::operations::search_request> {
                                                jsObj.Get("client_context_id"));
         js_to_cbpp<std::optional<std::chrono::milliseconds>>(
             cppObj.timeout, jsObj.Get("timeout"));
+        js_to_cbpp<std::optional<bool>>(cppObj.log_request,
+                                        jsObj.Get("log_request"));
+        js_to_cbpp<std::optional<bool>>(cppObj.log_response,
+                                        jsObj.Get("log_response"));
         js_to_cbpp<std::string>(cppObj.body_str, jsObj.Get("body_str"));
         // parent_span
         return cppObj;
@@ -3985,6 +3988,10 @@ struct js_to_cbpp_t<couchbase::core::operations::search_request> {
         resObj.Set("timeout",
                    cbpp_to_js<std::optional<std::chrono::milliseconds>>(
                        env, cppObj.timeout));
+        resObj.Set("log_request",
+                   cbpp_to_js<std::optional<bool>>(env, cppObj.log_request));
+        resObj.Set("log_response",
+                   cbpp_to_js<std::optional<bool>>(env, cppObj.log_response));
         resObj.Set("body_str", cbpp_to_js<std::string>(env, cppObj.body_str));
         // parent_span
         return resObj;