couchbase 4.2.9 → 4.2.11-rc.1

package/deps/couchbase-cxx-client/couchbase/vector_search.hxx

@@ -0,0 +1,85 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+#include <couchbase/vector_query.hxx>
+#include <couchbase/vector_search_options.hxx>
+
+namespace couchbase
+{
+/**
+ * A vector_search allows one or more @ref vector_query to be executed.
+ *
+ * @since 1.0.0
+ * @volatile
+ */
+class vector_search
+{
+  public:
+    /**
+     * Will execute all of the provided vector_queries, using the specified options
+     *
+     * @param vector_queries vector queries to be run
+     * @param options options to use on the vector queries
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    explicit vector_search(std::vector<vector_query> vector_queries, vector_search_options options = {})
+      : vector_queries_{ std::move(vector_queries) }
+      , options_{ options.build() }
+    {
+    }
+
+    /**
+     * Will execute a singe vector_query, using default options
+     *
+     * @param query the query to be run
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    explicit vector_search(vector_query query)
+      : vector_queries_{ std::vector<vector_query>{ std::move(query) } }
+    {
+    }
+
+    /**
+     * Fetches the vector_search_options
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] vector_search_options::built options() const
+    {
+        return options_;
+    }
+
+    /**
+     * @return encoded representation of the vector_search.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_query;
+
+  private:
+    std::vector<vector_query> vector_queries_;
+    vector_search_options::built options_{};
+};
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/vector_search_options.hxx

@@ -0,0 +1,76 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+namespace couchbase
+{
+enum class vector_query_combination { combination_and, combination_or };
+
+/**
+ * Options related to executing a @ref vector_search
+ *
+ * @since 1.0.0
+ * @volatile
+ */
+struct vector_search_options {
+
+    /**
+     * Immutable value object representing consistent options
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    struct built {
+        std::optional<vector_query_combination> combination;
+    };
+
+    /**
+     * Validates options and returns them as an immutable value.
+     *
+     * @return consistent options as an immutable value
+     *
+     * @exception std::system_error with code errc::common::invalid_argument if the options are not valid
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto build() const -> built
+    {
+        return { combination_ };
+    }
+
+    /**
+     * Sets how the vector query results are combined.
+     *
+     * @param combination @ref vector_query_combination
+     * @return this for chaining purposes
+     *
+     * @since 1.0.0
+     * @volatile
+     *
+     */
+    auto query_combination(vector_query_combination combination) -> vector_search_options&
+    {
+        combination_ = combination;
+        return *this;
+    }
+
+  private:
+    std::optional<vector_query_combination> combination_{};
+};
+} // namespace couchbase

package/dist/binding.d.ts

@@ -131,6 +131,8 @@ export declare enum CppPersistTo {
 }
 export declare enum CppReplicateTo {
 }
+export declare enum CppVectorQueryCombination {
+}
 export interface CppManagementAnalyticsDataset {
     name: string;
     dataverse_name: string;
@@ -206,7 +208,7 @@ export interface CppManagementClusterBucketSettingsNode {
     };
 }
 export interface CppManagementViewsDesignDocument {
-    rev: string;
+    rev?: string;
     name: string;
     ns: CppDesignDocumentNamespace;
     views: {
@@ -858,6 +860,11 @@ export interface CppSearchResponseSearchFacetNumericRangeFacet {
 export interface CppSearchRequest {
     index_name: string;
     query: CppJsonString;
+    bucket_name?: string;
+    scope_name?: string;
+    show_request?: boolean;
+    vector_search?: CppJsonString;
+    vector_query_combination?: CppVectorQueryCombination;
     limit?: number;
     skip?: number;
     explain?: boolean;
@@ -952,6 +959,7 @@ export interface CppDocumentViewRequest {
     raw: {
         [key: string]: string;
     };
+    full_set?: boolean;
     order?: CppViewSortOrder;
     on_error?: CppViewOnError;
     query_string: string[];
@@ -1196,6 +1204,8 @@ export interface CppManagementSearchIndexGetAllResponse {
     indexes: CppManagementSearchIndex[];
 }
 export interface CppManagementSearchIndexGetAllRequest {
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1207,6 +1217,8 @@ export interface CppManagementSearchIndexAnalyzeDocumentResponse {
 export interface CppManagementSearchIndexAnalyzeDocumentRequest {
     index_name: string;
     encoded_document: string;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1274,7 +1286,7 @@ export interface CppManagementQueryIndexCreateRequest {
     scope_name: string;
     collection_name: string;
     index_name: string;
-    fields: string[];
+    keys: string[];
     query_ctx: CppQueryContext;
     is_primary: boolean;
     ignore_if_exists: boolean;
@@ -1292,6 +1304,8 @@ export interface CppManagementSearchIndexUpsertResponse {
 }
 export interface CppManagementSearchIndexUpsertRequest {
     index: CppManagementSearchIndex;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1614,6 +1628,8 @@ export interface CppManagementSearchIndexDropResponse {
 }
 export interface CppManagementSearchIndexDropRequest {
     index_name: string;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1624,6 +1640,8 @@ export interface CppManagementSearchIndexControlPlanFreezeResponse {
 export interface CppManagementSearchIndexControlPlanFreezeRequest {
     index_name: string;
     freeze: boolean;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1659,6 +1677,8 @@ export interface CppManagementSearchIndexControlQueryResponse {
 export interface CppManagementSearchIndexControlQueryRequest {
     index_name: string;
     allow: boolean;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1713,6 +1733,8 @@ export interface CppManagementSearchIndexControlIngestResponse {
 export interface CppManagementSearchIndexControlIngestRequest {
     index_name: string;
     pause: boolean;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1775,6 +1797,8 @@ export interface CppManagementSearchIndexGetResponse {
 }
 export interface CppManagementSearchIndexGetRequest {
     index_name: string;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1822,6 +1846,8 @@ export interface CppManagementSearchIndexGetDocumentsCountResponse {
 }
 export interface CppManagementSearchIndexGetDocumentsCountRequest {
     index_name: string;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -2362,6 +2388,7 @@ export interface CppBindingAutogen {
         opaque_no_match: CppKeyValueStatusCode;
         locked: CppKeyValueStatusCode;
         not_locked: CppKeyValueStatusCode;
+        config_only: CppKeyValueStatusCode;
         auth_stale: CppKeyValueStatusCode;
         auth_error: CppKeyValueStatusCode;
         auth_continue: CppKeyValueStatusCode;
@@ -2461,6 +2488,10 @@ export interface CppBindingAutogen {
         two: CppReplicateTo;
         three: CppReplicateTo;
     };
+    vector_query_combination: {
+        combination_and: CppVectorQueryCombination;
+        combination_or: CppVectorQueryCombination;
+    };
 }
 export type CppErrc = CppErrcCommon | CppErrcKeyValue | CppErrcQuery | CppErrcAnalytics | CppErrcSearch | CppErrcView | CppErrcManagement | CppErrcFieldLevelEncryption | CppErrcNetwork;
 export declare enum CppTxnFailureType {

package/dist/binding.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CppTxnExternalException = exports.CppTxnFailureType = exports.CppReplicateTo = exports.CppPersistTo = exports.CppStoreSemantics = exports.CppImplSubdocOpcode = exports.CppKeyValueStatusCode = exports.CppErrcNetwork = exports.CppErrcFieldLevelEncryption = exports.CppErrcManagement = exports.CppErrcView = exports.CppErrcSearch = exports.CppErrcAnalytics = exports.CppErrcQuery = exports.CppErrcKeyValue = exports.CppErrcCommon = exports.CppDurabilityLevel = exports.CppAnalyticsResponseAnalyticsStatus = exports.CppViewSortOrder = exports.CppViewScanConsistency = exports.CppViewOnError = exports.CppServiceType = exports.CppSearchScanConsistency = exports.CppSearchHighlightStyle = exports.CppQueryScanConsistency = exports.CppQueryProfile = exports.CppDiagPingState = exports.CppDiagEndpointState = exports.CppDiagClusterState = exports.CppDesignDocumentNamespace = exports.CppAnalyticsScanConsistency = exports.CppProtocolSubdocOpcode = exports.CppRetryReason = exports.CppManagementRbacAuthDomain = exports.CppManagementEventingFunctionProcessingStatus = exports.CppManagementEventingFunctionDeploymentStatus = exports.CppManagementEventingFunctionStatus = exports.CppManagementEventingFunctionBucketAccess = exports.CppManagementEventingFunctionLogLevel = exports.CppManagementEventingFunctionLanguageCompatibility = exports.CppManagementEventingFunctionDcpBoundary = exports.CppManagementClusterBucketStorageBackend = exports.CppManagementClusterBucketConflictResolution = exports.CppManagementClusterBucketEvictionPolicy = exports.CppManagementClusterBucketCompression = exports.CppManagementClusterBucketType = exports.CppManagementAnalyticsCouchbaseLinkEncryptionLevel = exports.zeroCas = void 0;
+exports.CppTxnExternalException = exports.CppTxnFailureType = exports.CppVectorQueryCombination = exports.CppReplicateTo = exports.CppPersistTo = exports.CppStoreSemantics = exports.CppImplSubdocOpcode = exports.CppKeyValueStatusCode = exports.CppErrcNetwork = exports.CppErrcFieldLevelEncryption = exports.CppErrcManagement = exports.CppErrcView = exports.CppErrcSearch = exports.CppErrcAnalytics = exports.CppErrcQuery = exports.CppErrcKeyValue = exports.CppErrcCommon = exports.CppDurabilityLevel = exports.CppAnalyticsResponseAnalyticsStatus = exports.CppViewSortOrder = exports.CppViewScanConsistency = exports.CppViewOnError = exports.CppServiceType = exports.CppSearchScanConsistency = exports.CppSearchHighlightStyle = exports.CppQueryScanConsistency = exports.CppQueryProfile = exports.CppDiagPingState = exports.CppDiagEndpointState = exports.CppDiagClusterState = exports.CppDesignDocumentNamespace = exports.CppAnalyticsScanConsistency = exports.CppProtocolSubdocOpcode = exports.CppRetryReason = exports.CppManagementRbacAuthDomain = exports.CppManagementEventingFunctionProcessingStatus = exports.CppManagementEventingFunctionDeploymentStatus = exports.CppManagementEventingFunctionStatus = exports.CppManagementEventingFunctionBucketAccess = exports.CppManagementEventingFunctionLogLevel = exports.CppManagementEventingFunctionLanguageCompatibility = exports.CppManagementEventingFunctionDcpBoundary = exports.CppManagementClusterBucketStorageBackend = exports.CppManagementClusterBucketConflictResolution = exports.CppManagementClusterBucketEvictionPolicy = exports.CppManagementClusterBucketCompression = exports.CppManagementClusterBucketType = exports.CppManagementAnalyticsCouchbaseLinkEncryptionLevel = exports.zeroCas = void 0;
 /*
 eslint
 jsdoc/require-jsdoc: off,
@@ -147,6 +147,9 @@ var CppPersistTo;
 var CppReplicateTo;
 (function (CppReplicateTo) {
 })(CppReplicateTo || (exports.CppReplicateTo = CppReplicateTo = {}));
+var CppVectorQueryCombination;
+(function (CppVectorQueryCombination) {
+})(CppVectorQueryCombination || (exports.CppVectorQueryCombination = CppVectorQueryCombination = {}));
 var CppTxnFailureType;
 (function (CppTxnFailureType) {
 })(CppTxnFailureType || (exports.CppTxnFailureType = CppTxnFailureType = {}));

package/dist/bindingutilities.d.ts

@@ -1,5 +1,5 @@
 import { AnalyticsScanConsistency, AnalyticsStatus } from './analyticstypes';
-import { CppAnalyticsResponseAnalyticsStatus, CppAnalyticsScanConsistency, CppDiagEndpointState, CppDiagPingState, CppDurabilityLevel, CppError, CppManagementClusterBucketCompression, CppManagementClusterBucketConflictResolution, CppManagementClusterBucketEvictionPolicy, CppManagementClusterBucketStorageBackend, CppManagementClusterBucketType, CppMutationState, CppPersistTo, CppPrefixScan, CppQueryProfile, CppQueryScanConsistency, CppRangeScan, CppReplicateTo, CppSamplingScan, CppSearchHighlightStyle, CppSearchScanConsistency, CppServiceType, CppStoreSemantics, CppTxnExternalException, CppTxnOpException, CppViewScanConsistency, CppViewSortOrder } from './binding';
+import { CppAnalyticsResponseAnalyticsStatus, CppAnalyticsScanConsistency, CppDesignDocumentNamespace, CppDiagEndpointState, CppDiagPingState, CppDurabilityLevel, CppError, CppManagementClusterBucketCompression, CppManagementClusterBucketConflictResolution, CppManagementClusterBucketEvictionPolicy, CppManagementClusterBucketStorageBackend, CppManagementClusterBucketType, CppMutationState, CppPersistTo, CppPrefixScan, CppQueryProfile, CppQueryScanConsistency, CppRangeScan, CppReplicateTo, CppSamplingScan, CppSearchHighlightStyle, CppSearchScanConsistency, CppServiceType, CppStoreSemantics, CppTxnExternalException, CppTxnOpException, CppVectorQueryCombination, CppViewScanConsistency, CppViewSortOrder } from './binding';
 import { BucketType, CompressionMode, ConflictResolutionType, EvictionPolicy, StorageBackend } from './bucketmanager';
 import { EndpointState, PingState } from './diagnosticstypes';
 import { ErrorContext } from './errorcontexts';
@@ -8,7 +8,8 @@ import { MutationState } from './mutationstate';
 import { QueryProfileMode, QueryScanConsistency } from './querytypes';
 import { PrefixScan, RangeScan, SamplingScan } from './rangeScan';
 import { HighlightStyle, SearchScanConsistency } from './searchtypes';
-import { ViewOrdering, ViewScanConsistency } from './viewtypes';
+import { VectorQueryCombination } from './vectorsearch';
+import { DesignDocumentNamespace, ViewOrdering, ViewScanConsistency } from './viewtypes';
 /**
  * @internal
  */
@@ -36,7 +37,7 @@ export declare function viewScanConsistencyToCpp(mode: ViewScanConsistency | und
 /**
  * @internal
  */
-export declare function viewOrderingToCpp(mode: ViewOrdering | undefined): CppViewSortOrder | undefined;
+export declare function viewOrderingToCpp(ordering: ViewOrdering | undefined): CppViewSortOrder | undefined;
 /**
  * @internal
  */
@@ -141,3 +142,15 @@ export declare function bucketConflictResolutionTypeToCpp(type: ConflictResoluti
  * @internal
  */
 export declare function bucketConflictResolutionTypeFromCpp(type: CppManagementClusterBucketConflictResolution): ConflictResolutionType | undefined;
+/**
+ * @internal
+ */
+export declare function vectorQueryCombinationToCpp(combination: VectorQueryCombination | undefined): CppVectorQueryCombination;
+/**
+ * @internal
+ */
+export declare function designDocumentNamespaceFromCpp(namespace: CppDesignDocumentNamespace): DesignDocumentNamespace;
+/**
+ * @internal
+ */
+export declare function designDocumentNamespaceToCpp(namespace: DesignDocumentNamespace): CppDesignDocumentNamespace;

package/dist/bindingutilities.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bucketConflictResolutionTypeFromCpp = exports.bucketConflictResolutionTypeToCpp = exports.bucketStorageBackendFromCpp = exports.bucketStorageBackendToCpp = exports.bucketEvictionPolicyFromCpp = exports.bucketEvictionPolicyToCpp = exports.bucketCompressionModeFromCpp = exports.bucketCompressionModeToCpp = exports.bucketTypeFromCpp = exports.bucketTypeToCpp = exports.scanTypeToCpp = exports.errorFromCpp = exports.contextFromCpp = exports.pingStateFromCpp = exports.txnOpExeptionFromCpp = exports.txnExternalExceptionStringFromCpp = exports.endpointStateFromCpp = exports.serviceTypeFromCpp = exports.serviceTypeToCpp = exports.mutationStateToCpp = exports.searchHighlightStyleToCpp = exports.searchScanConsistencyToCpp = exports.analyticsStatusFromCpp = exports.analyticsScanConsistencyToCpp = exports.queryProfileToCpp = exports.queryScanConsistencyToCpp = exports.viewOrderingToCpp = exports.viewScanConsistencyToCpp = exports.storeSemanticToCpp = exports.replicateToToCpp = exports.persistToToCpp = exports.durabilityFromCpp = exports.durabilityToCpp = void 0;
+exports.designDocumentNamespaceToCpp = exports.designDocumentNamespaceFromCpp = exports.vectorQueryCombinationToCpp = exports.bucketConflictResolutionTypeFromCpp = exports.bucketConflictResolutionTypeToCpp = exports.bucketStorageBackendFromCpp = exports.bucketStorageBackendToCpp = exports.bucketEvictionPolicyFromCpp = exports.bucketEvictionPolicyToCpp = exports.bucketCompressionModeFromCpp = exports.bucketCompressionModeToCpp = exports.bucketTypeFromCpp = exports.bucketTypeToCpp = exports.scanTypeToCpp = exports.errorFromCpp = exports.contextFromCpp = exports.pingStateFromCpp = exports.txnOpExeptionFromCpp = exports.txnExternalExceptionStringFromCpp = exports.endpointStateFromCpp = exports.serviceTypeFromCpp = exports.serviceTypeToCpp = exports.mutationStateToCpp = exports.searchHighlightStyleToCpp = exports.searchScanConsistencyToCpp = exports.analyticsStatusFromCpp = exports.analyticsScanConsistencyToCpp = exports.queryProfileToCpp = exports.queryScanConsistencyToCpp = exports.viewOrderingToCpp = exports.viewScanConsistencyToCpp = exports.storeSemanticToCpp = exports.replicateToToCpp = exports.persistToToCpp = exports.durabilityFromCpp = exports.durabilityToCpp = void 0;
 const analyticstypes_1 = require("./analyticstypes");
 const binding_1 = __importDefault(require("./binding"));
 const bucketmanager_1 = require("./bucketmanager");
@@ -38,6 +38,7 @@ const querytypes_1 = require("./querytypes");
 const rangeScan_1 = require("./rangeScan");
 const searchtypes_1 = require("./searchtypes");
 const utilities_1 = require("./utilities");
+const vectorsearch_1 = require("./vectorsearch");
 const viewtypes_1 = require("./viewtypes");
 /**
  * @internal
@@ -181,18 +182,18 @@ exports.viewScanConsistencyToCpp = viewScanConsistencyToCpp;
 /**
  * @internal
  */
-function viewOrderingToCpp(mode) {
-    // Unspecified is allowed, and means no sync durability.
-    if (mode === null || mode === undefined) {
+function viewOrderingToCpp(ordering) {
+    // Unspecified is allowed, and means default ordering.
+    if (ordering === null || ordering === undefined) {
         return undefined;
     }
-    if (mode === viewtypes_1.ViewOrdering.Ascending) {
+    if (ordering === viewtypes_1.ViewOrdering.Ascending) {
         return binding_1.default.view_sort_order.ascending;
     }
-    else if (mode === viewtypes_1.ViewOrdering.Descending) {
+    else if (ordering === viewtypes_1.ViewOrdering.Descending) {
         return binding_1.default.view_sort_order.descending;
     }
-    throw new errs.InvalidArgumentError();
+    throw new errs.InvalidArgumentError(new Error('Unrecognized view ordering.'));
 }
 exports.viewOrderingToCpp = viewOrderingToCpp;
 /**
@@ -1011,3 +1012,42 @@ function bucketConflictResolutionTypeFromCpp(type) {
     throw new errs.InvalidArgumentError();
 }
 exports.bucketConflictResolutionTypeFromCpp = bucketConflictResolutionTypeFromCpp;
+/**
+ * @internal
+ */
+function vectorQueryCombinationToCpp(combination) {
+    if (combination === vectorsearch_1.VectorQueryCombination.AND) {
+        return binding_1.default.vector_query_combination.combination_and;
+    }
+    else if (combination === vectorsearch_1.VectorQueryCombination.OR) {
+        return binding_1.default.vector_query_combination.combination_or;
+    }
+    throw new errs.InvalidArgumentError(new Error('Unrecognized VectorQueryCombination.'));
+}
+exports.vectorQueryCombinationToCpp = vectorQueryCombinationToCpp;
+/**
+ * @internal
+ */
+function designDocumentNamespaceFromCpp(namespace) {
+    if (namespace === binding_1.default.design_document_namespace.production) {
+        return viewtypes_1.DesignDocumentNamespace.Production;
+    }
+    else if (namespace === binding_1.default.design_document_namespace.development) {
+        return viewtypes_1.DesignDocumentNamespace.Development;
+    }
+    throw new errs.InvalidArgumentError(new Error('Unrecognized DesignDocumentNamespace.'));
+}
+exports.designDocumentNamespaceFromCpp = designDocumentNamespaceFromCpp;
+/**
+ * @internal
+ */
+function designDocumentNamespaceToCpp(namespace) {
+    if (namespace === viewtypes_1.DesignDocumentNamespace.Production) {
+        return binding_1.default.design_document_namespace.production;
+    }
+    else if (namespace === viewtypes_1.DesignDocumentNamespace.Development) {
+        return binding_1.default.design_document_namespace.development;
+    }
+    throw new errs.InvalidArgumentError(new Error('Unrecognized DesignDocumentNamespace.'));
+}
+exports.designDocumentNamespaceToCpp = designDocumentNamespaceToCpp;

package/dist/cluster.d.ts

@@ -10,7 +10,7 @@ import { QueryIndexManager } from './queryindexmanager';
 import { QueryMetaData, QueryOptions, QueryResult } from './querytypes';
 import { SearchIndexManager } from './searchindexmanager';
 import { SearchQuery } from './searchquery';
-import { SearchMetaData, SearchQueryOptions, SearchResult, SearchRow } from './searchtypes';
+import { SearchMetaData, SearchQueryOptions, SearchRequest, SearchResult, SearchRow } from './searchtypes';
 import { StreamableRowPromise } from './streamablepromises';
 import { Transactions, TransactionsConfig } from './transactions';
 import { Transcoder } from './transcoders';
@@ -300,6 +300,17 @@ export declare class Cluster {
      * @param callback A node-style callback to be invoked after execution.
      */
     searchQuery(indexName: string, query: SearchQuery, options?: SearchQueryOptions, callback?: NodeCallback<SearchResult>): StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>;
+    /**
+     * 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.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    search(indexName: string, request: SearchRequest, options?: SearchQueryOptions, callback?: NodeCallback<SearchResult>): StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>;
     /**
      * Returns a diagnostics report about the currently active connections with the
      * cluster.  Includes information about remote and local addresses, last activity,

package/dist/cluster.js

@@ -317,6 +317,28 @@ class Cluster {
         const options_ = options;
         return utilities_1.PromiseHelper.wrapAsync(() => exec.query(indexName, query, options_), callback);
     }
+    /**
+     * 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.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    search(indexName, request, options, callback) {
+        if (options instanceof Function) {
+            callback = arguments[2];
+            options = undefined;
+        }
+        if (!options) {
+            options = {};
+        }
+        const exec = new searchexecutor_1.SearchExecutor(this);
+        const options_ = options;
+        return utilities_1.PromiseHelper.wrapAsync(() => exec.query(indexName, request, options_), callback);
+    }
     /**
      * Returns a diagnostics report about the currently active connections with the
      * cluster.  Includes information about remote and local addresses, last activity,

package/dist/couchbase.d.ts

@@ -60,6 +60,7 @@ export * from './mutationstate';
 export * from './queryindexmanager';
 export * from './querytypes';
 export * from './scope';
+export * from './scopesearchindexmanager';
 export * from './sdspecs';
 export * from './searchfacet';
 export * from './searchindexmanager';
@@ -70,6 +71,7 @@ export * from './streamablepromises';
 export * from './transactions';
 export * from './transcoders';
 export * from './usermanager';
+export * from './vectorsearch';
 export * from './viewexecutor';
 export * from './viewindexmanager';
 export * from './viewtypes';

package/dist/couchbase.js

@@ -89,6 +89,7 @@ __exportStar(require("./mutationstate"), exports);
 __exportStar(require("./queryindexmanager"), exports);
 __exportStar(require("./querytypes"), exports);
 __exportStar(require("./scope"), exports);
+__exportStar(require("./scopesearchindexmanager"), exports);
 __exportStar(require("./sdspecs"), exports);
 __exportStar(require("./searchfacet"), exports);
 __exportStar(require("./searchindexmanager"), exports);
@@ -99,6 +100,7 @@ __exportStar(require("./streamablepromises"), exports);
 __exportStar(require("./transactions"), exports);
 __exportStar(require("./transcoders"), exports);
 __exportStar(require("./usermanager"), exports);
+__exportStar(require("./vectorsearch"), exports);
 __exportStar(require("./viewexecutor"), exports);
 __exportStar(require("./viewindexmanager"), exports);
 __exportStar(require("./viewtypes"), exports);

package/dist/queryindexmanager.d.ts

@@ -264,11 +264,11 @@ export declare class CollectionQueryIndexManager {
      * Creates a new query index.
      *
      * @param indexName The name of the new index.
-     * @param fields The fields which this index should cover.
+     * @param keys The keys which this index should cover.
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
      */
-    createIndex(indexName: string, fields: string[], options?: CreateQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>;
+    createIndex(indexName: string, keys: string[], options?: CreateQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>;
     /**
      * Creates a new primary query index.
      *
@@ -332,11 +332,11 @@ export declare class QueryIndexManager {
      *
      * @param bucketName The name of the bucket this index is for.
      * @param indexName The name of the new index.
-     * @param fields The fields which this index should cover.
+     * @param keys The keys which this index should cover.
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
      */
-    createIndex(bucketName: string, indexName: string, fields: string[], options?: CreateQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>;
+    createIndex(bucketName: string, indexName: string, keys: string[], options?: CreateQueryIndexOptions, callback?: NodeCallback<void>): Promise<void>;
     /**
      * Creates a new primary query index.
      *

package/dist/queryindexmanager.js

@@ -52,7 +52,7 @@ class InternalQueryIndexManager {
                 scope_name: options.scopeName || '',
                 collection_name: options.collectionName || '',
                 index_name: options.name || '',
-                fields: options.fields || [],
+                keys: options.keys || [],
                 query_ctx: options.queryContext || this._queryContext,
                 is_primary: isPrimary,
                 ignore_if_exists: options.ignoreIfExists || false,
@@ -217,11 +217,11 @@ class CollectionQueryIndexManager {
      * Creates a new query index.
      *
      * @param indexName The name of the new index.
-     * @param fields The fields which this index should cover.
+     * @param keys The keys which this index should cover.
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
      */
-    async createIndex(indexName, fields, options, callback) {
+    async createIndex(indexName, keys, options, callback) {
         if (options instanceof Function) {
             callback = arguments[2];
             options = undefined;
@@ -233,7 +233,7 @@ class CollectionQueryIndexManager {
             collectionName: this._collectionName,
             scopeName: this._scopeName,
             name: indexName,
-            fields: fields,
+            keys: keys,
             ignoreIfExists: options.ignoreIfExists,
             numReplicas: options.numReplicas,
             deferred: options.deferred,
@@ -390,11 +390,11 @@ class QueryIndexManager {
      *
      * @param bucketName The name of the bucket this index is for.
      * @param indexName The name of the new index.
-     * @param fields The fields which this index should cover.
+     * @param keys The keys which this index should cover.
      * @param options Optional parameters for this operation.
      * @param callback A node-style callback to be invoked after execution.
      */
-    async createIndex(bucketName, indexName, fields, options, callback) {
+    async createIndex(bucketName, indexName, keys, options, callback) {
         if (options instanceof Function) {
             callback = arguments[3];
             options = undefined;
@@ -406,7 +406,7 @@ class QueryIndexManager {
             collectionName: options.collectionName,
             scopeName: options.scopeName,
             name: indexName,
-            fields: fields,
+            keys: keys,
             ignoreIfExists: options.ignoreIfExists,
             numReplicas: options.numReplicas,
             deferred: options.deferred,

package/dist/scope.d.ts

@@ -4,6 +4,8 @@ import { Bucket } from './bucket';
 import { Cluster } from './cluster';
 import { Collection } from './collection';
 import { QueryMetaData, QueryOptions, QueryResult } from './querytypes';
+import { ScopeSearchIndexManager } from './scopesearchindexmanager';
+import { SearchMetaData, SearchQueryOptions, SearchRequest, SearchResult, SearchRow } from './searchtypes';
 import { StreamableRowPromise } from './streamablepromises';
 import { Transcoder } from './transcoders';
 import { NodeCallback } from './utilities';
@@ -51,6 +53,14 @@ export declare class Scope {
      * @param collectionName The name of the collection to reference.
      */
     collection(collectionName: string): Collection;
+    /**
+     * 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;
     /**
      * Executes a N1QL query against the cluster scoped to this scope.
      *
@@ -67,4 +77,15 @@ export declare class Scope {
      * @param callback A node-style callback to be invoked after execution.
      */
     analyticsQuery<TRow = any>(statement: string, options?: AnalyticsQueryOptions, callback?: NodeCallback<AnalyticsResult<TRow>>): StreamableRowPromise<AnalyticsResult<TRow>, TRow, AnalyticsMetaData>;
+    /**
+     * 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.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    search(indexName: string, request: SearchRequest, options?: SearchQueryOptions, callback?: NodeCallback<SearchResult>): StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>;
 }