couchbase 4.2.10 → 4.2.11

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

@@ -51,7 +51,6 @@ class query_index_manager
     /**
      * Get all indexes within a bucket.
      *
-     *
      * @param bucket_name specifies the bucket in which we look for the indexes
      * @param options optional parameters
      * @param handler the handler that implements @ref get_all_query_indexes_handler
@@ -66,7 +65,6 @@ class query_index_manager
     /**
      * Get all indexes within a bucket.
      *
-     *
      * @param bucket_name specifies the bucket in which we look for the indexes
      * @param options optional parameters
      * @return future object that carries result of the operation
@@ -82,7 +80,7 @@ class query_index_manager
      *
      * @param bucket_name specifies the bucket in which to create the index
      * @param index_name name of the index
-     * @param fields the fields to create the index over
+     * @param keys the keys to create the index over
      * @param options optional parameters
      * @param handler the handler that implements @ref create_query_index_handler
      *
@@ -91,7 +89,7 @@ class query_index_manager
      */
     void create_index(std::string bucket_name,
                       std::string index_name,
-                      std::vector<std::string> fields,
+                      std::vector<std::string> keys,
                       const create_query_index_options& options,
                       create_query_index_handler&& handler) const;
 
@@ -100,7 +98,7 @@ class query_index_manager
      *
      * @param bucket_name specifies the bucket in which to create the index
      * @param index_name name of the index
-     * @param fields the fields to create the index over
+     * @param keys the keys to create the index over
      * @param options optional parameters
      * @return future object that carries result of the operation
      *
@@ -109,7 +107,7 @@ class query_index_manager
      */
     [[nodiscard]] auto create_index(std::string bucket_name,
                                     std::string index_name,
-                                    std::vector<std::string> fields,
+                                    std::vector<std::string> keys,
                                     const create_query_index_options& options) const -> std::future<manager_error_context>;
 
     /**
@@ -202,7 +200,7 @@ class query_index_manager
      * By default, this method will build the indexes on the bucket.
      *
      * @param bucket_name name of the bucket
-     * @param options the custom options
+     * @param options optional parameters
      * @param handler the handler that implements @ref build_deferred_query_indexes_handler
      *
      * @since 1.0.0
@@ -218,7 +216,7 @@ class query_index_manager
      * By default, this method will build the indexes on the bucket.
      *
      * @param bucket_name name of the bucket
-     * @param options the custom options
+     * @param options optional parameters
      * @return future object that carries result of the operation
      *
      * @since 1.0.0

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

@@ -151,7 +151,7 @@ class scope
      * @since 1.0.0
      * @volatile
      */
-    [[nodiscard]] auto search(std::string index_name, search_request request, const search_options& = {}) const
+    [[nodiscard]] auto search(std::string index_name, search_request request, const search_options& options = {}) const
       -> std::future<std::pair<search_error_context, search_result>>;
 
     /**

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

@@ -35,7 +35,7 @@
 namespace couchbase
 {
 /**
- * Options for cluster#search_query() and scope#search_query().
+ * Options for @ref cluster#search_query(), @ref cluster#search() and @ref scope#search().
  *
  * @since 1.0.0
  * @committed
@@ -500,7 +500,7 @@ struct search_options : public common_options<search_options> {
 };
 
 /**
- * The signature for the handler of the @ref cluster#search_query() and @ref scope#search_query() operations
+ * The signature for the handler of the @ref cluster#search_query(), @ref cluster#search() and @ref scope#search() operations
  *
  * @since 1.0.0
  * @uncommitted

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

@@ -35,7 +35,7 @@ class internal_search_result;
 #endif
 
 /**
- * Represents result of @ref cluster#search_query() and @ref scope#search_query() calls.
+ * Represents result of @ref cluster#search_query(), @ref cluster#search() and @ref scope#search() calls.
  *
  * @since 1.0.0
  * @committed

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

@@ -41,6 +41,7 @@ class subdocument_error_context : public key_value_error_context
     /**
      * Creates and initializes error context with given parameters.
      *
+     * @param operation_id
      * @param ec
      * @param last_dispatched_to
      * @param last_dispatched_from

package/deps/couchbase-cxx-client/couchbase/transactions/transaction_options.hxx

@@ -78,7 +78,7 @@ class transaction_options
     /**
      * Set the timeout for this transaction.
      *
-     * @tparam T timeout type, e.g. @ref std::chrono::milliseconds, or similar
+     * @tparam T timeout type, e.g. std::chrono::milliseconds, or similar
      * @param timeout Desired timeout
      * @return reference to this object, convenient for chaining operations.
      */

package/deps/couchbase-cxx-client/couchbase-sdk-cxx-black-duck-manifest.yaml

@@ -1,3 +1,4 @@
+# NOTE: This file MUST be in sync with cmake/ThirdPartyDependencies.cmake
 components:
   boringssl:
     bd-id: 1e303b15-b82b-4a4d-8cd6-a2048fb2c73d

package/dist/binding.d.ts

@@ -208,7 +208,7 @@ export interface CppManagementClusterBucketSettingsNode {
     };
 }
 export interface CppManagementViewsDesignDocument {
-    rev: string;
+    rev?: string;
     name: string;
     ns: CppDesignDocumentNamespace;
     views: {
@@ -860,6 +860,8 @@ 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;
@@ -957,6 +959,7 @@ export interface CppDocumentViewRequest {
     raw: {
         [key: string]: string;
     };
+    full_set?: boolean;
     order?: CppViewSortOrder;
     on_error?: CppViewOnError;
     query_string: string[];
@@ -1201,6 +1204,8 @@ export interface CppManagementSearchIndexGetAllResponse {
     indexes: CppManagementSearchIndex[];
 }
 export interface CppManagementSearchIndexGetAllRequest {
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1212,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;
 }
@@ -1279,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;
@@ -1297,6 +1304,8 @@ export interface CppManagementSearchIndexUpsertResponse {
 }
 export interface CppManagementSearchIndexUpsertRequest {
     index: CppManagementSearchIndex;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1619,6 +1628,8 @@ export interface CppManagementSearchIndexDropResponse {
 }
 export interface CppManagementSearchIndexDropRequest {
     index_name: string;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1629,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;
 }
@@ -1664,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;
 }
@@ -1718,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;
 }
@@ -1780,6 +1797,8 @@ export interface CppManagementSearchIndexGetResponse {
 }
 export interface CppManagementSearchIndexGetRequest {
     index_name: string;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -1827,6 +1846,8 @@ export interface CppManagementSearchIndexGetDocumentsCountResponse {
 }
 export interface CppManagementSearchIndexGetDocumentsCountRequest {
     index_name: string;
+    bucket_name?: string;
+    scope_name?: string;
     client_context_id?: string;
     timeout?: CppMilliseconds;
 }
@@ -2367,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;

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, CppVectorQueryCombination, 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';
@@ -9,7 +9,7 @@ import { QueryProfileMode, QueryScanConsistency } from './querytypes';
 import { PrefixScan, RangeScan, SamplingScan } from './rangeScan';
 import { HighlightStyle, SearchScanConsistency } from './searchtypes';
 import { VectorQueryCombination } from './vectorsearch';
-import { ViewOrdering, ViewScanConsistency } from './viewtypes';
+import { DesignDocumentNamespace, ViewOrdering, ViewScanConsistency } from './viewtypes';
 /**
  * @internal
  */
@@ -37,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
  */
@@ -146,3 +146,11 @@ export declare function bucketConflictResolutionTypeFromCpp(type: CppManagementC
  * @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.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;
+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");
@@ -182,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;
 /**
@@ -1025,3 +1025,29 @@ function vectorQueryCombinationToCpp(combination) {
     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/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';

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);

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>;
 }

package/dist/scope.js

@@ -4,6 +4,8 @@ exports.Scope = void 0;
 const analyticsexecutor_1 = require("./analyticsexecutor");
 const collection_1 = require("./collection");
 const queryexecutor_1 = require("./queryexecutor");
+const searchexecutor_1 = require("./searchexecutor");
+const scopesearchindexmanager_1 = require("./scopesearchindexmanager");
 const utilities_1 = require("./utilities");
 /**
  * Exposes the operations which are available to be performed against a scope.
@@ -64,6 +66,16 @@ class Scope {
     collection(collectionName) {
         return new collection_1.Collection(this, collectionName);
     }
+    /**
+     * 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);
+    }
     /**
      * Executes a N1QL query against the cluster scoped to this scope.
      *
@@ -110,5 +122,27 @@ class Scope {
             queryContext: `${bucket.name}.${this.name}`,
         }), callback);
     }
+    /**
+     * 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, request, options, callback) {
+        if (options instanceof Function) {
+            callback = arguments[2];
+            options = undefined;
+        }
+        if (!options) {
+            options = {};
+        }
+        const exec = new searchexecutor_1.SearchExecutor(this.cluster, this._bucket.name, this._name);
+        const options_ = options;
+        return utilities_1.PromiseHelper.wrapAsync(() => exec.query(indexName, request, options_), callback);
+    }
 }
 exports.Scope = Scope;