couchbase 4.2.10 → 4.2.11-rc.1

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;

package/dist/scopesearchindexmanager.d.ts

@@ -0,0 +1,116 @@
+import { Cluster } from './cluster';
+import { NodeCallback } from './utilities';
+import { GetSearchIndexOptions, GetAllSearchIndexesOptions, UpsertSearchIndexOptions, GetSearchIndexedDocumentsCountOptions, DropSearchIndexOptions, PauseSearchIngestOptions, ResumeSearchIngestOptions, AllowSearchQueryingOptions, DisallowSearchQueryingOptions, FreezeSearchPlanOptions, UnfreezeSearchPlanOptions, AnalyzeSearchDocumentOptions, ISearchIndex, SearchIndex } from './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
+ */
+export declare class ScopeSearchIndexManager {
+    private _cluster;
+    private _bucketName;
+    private _scopeName;
+    /**
+     * @internal
+     */
+    constructor(cluster: Cluster, bucketName: string, scopeName: string);
+    /**
+     * Returns an index by it's name.
+     *
+     * @param indexName The index to retrieve.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    getIndex(indexName: string, options?: GetSearchIndexOptions, callback?: NodeCallback<SearchIndex>): Promise<SearchIndex>;
+    /**
+     * Returns a list of all existing indexes.
+     *
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    getAllIndexes(options?: GetAllSearchIndexesOptions, callback?: NodeCallback<SearchIndex[]>): Promise<SearchIndex[]>;
+    /**
+     * Creates or updates an existing index.
+     *
+     * @param indexDefinition The index to update.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    upsertIndex(indexDefinition: ISearchIndex, options?: UpsertSearchIndexOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Drops an index.
+     *
+     * @param indexName The name of the index to drop.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    dropIndex(indexName: string, options?: DropSearchIndexOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Returns the number of documents that have been indexed.
+     *
+     * @param indexName The name of the index to return the count for.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    getIndexedDocumentsCount(indexName: string, options?: GetSearchIndexedDocumentsCountOptions, callback?: NodeCallback<number>): Promise<number>;
+    /**
+     * Pauses the ingestion of documents into an index.
+     *
+     * @param indexName The name of the index to pause.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    pauseIngest(indexName: string, options?: PauseSearchIngestOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Resumes the ingestion of documents into an index.
+     *
+     * @param indexName The name of the index to resume.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    resumeIngest(indexName: string, options?: ResumeSearchIngestOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Enables querying of an index.
+     *
+     * @param indexName The name of the index to enable querying for.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    allowQuerying(indexName: string, options?: AllowSearchQueryingOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Disables querying of an index.
+     *
+     * @param indexName The name of the index to disable querying for.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    disallowQuerying(indexName: string, options?: DisallowSearchQueryingOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Freezes the indexing plan for execution of queries.
+     *
+     * @param indexName The name of the index to freeze the plan of.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    freezePlan(indexName: string, options?: FreezeSearchPlanOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Unfreezes the indexing plan for execution of queries.
+     *
+     * @param indexName The name of the index to freeze the plan of.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    unfreezePlan(indexName: string, options?: UnfreezeSearchPlanOptions, callback?: NodeCallback<void>): Promise<void>;
+    /**
+     * Performs analysis of a specific document by an index.
+     *
+     * @param indexName The name of the index to use for the analysis.
+     * @param document The document to analyze.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    analyzeDocument(indexName: string, document: any, options?: AnalyzeSearchDocumentOptions, callback?: NodeCallback<any>): Promise<any>;
+}