/** *
AnalyticsIndexManager provides an interface for performing management * operations against the analytics indexes for the cluster.
*/ declare class AnalyticsIndexManager { createDataverse(dataverseName: string, options?: { ignoreIfExists?: boolean; timeout?: number; }, callback?: CreateDataverseCallback): PromiseBinaryCollection provides various binary operations which * are available to be performed against a collection.
*/ declare class BinaryCollection { increment(key: string, value: number, options?: { timeout?: number; }, callback?: IncrementCallback): PromiseBucket represents a storage grouping of data within a Couchbase Server cluster.
*/ declare class Bucket { /** *Ping returns information from pinging the connections for this bucket.
*/ ping(options?: { reportId?: string; serviceTypes?: ServiceType[]; timeout?: number; }, callback?: PingCallback): PromiseThe design document containing the view to query
* @param viewName -The name of the view to query
*/ viewQuery(designDoc: string, viewName: string, options?: { scanConsistency?: ViewScanConsistency; skip?: number; limit?: number; order?: ViewOrdering; reduce?: string; group?: boolean; groupLevel?: number; key?: string; keys?: string[]; range?: { start?: string | string[]; end?: string | string[]; inclusiveEnd?: boolean; }; idRange?: { start?: string; end?: string; }; fullSet?: boolean; onError?: ViewErrorMode; timeout?: number; }, callback?: ViewQueryCallback): PromiseGets a reference to a specific scope.
*/ scope(scopeName: string): Scope; /** *Gets a reference to the default scope.
*/ defaultScope(): Scope; /** *Gets a reference to a specific collection.
*/ collection(collectionName: string): Collection; /** *Gets a reference to the default collection.
*/ defaultCollection(): Collection; /** *Gets a view index manager for this bucket
*/ viewIndexes(): ViewIndexManager; /** *Gets a collection manager for this bucket
*/ collections(): CollectionManager; /** *Returns the name of this bucket.
*/ name: string; } declare type ViewQueryResult = { rows: object[]; meta: any; }; declare type ViewQueryCallback = (err: Error, res: ViewQueryResult) => void; /** *BucketManager provides an interface for adding/removing/updating * buckets within the cluster.
*/ declare class BucketManager { createBucket(settings: CreateBucketSettings, options?: { timeout?: number; }, callback?: CreateBucketCallback): PromiseBucketSettings provides information about a specific bucket.
*/ declare type BucketSettings = { name: string; flushEnabled: boolean; ramQuotaMB: number; numReplicas: number; replicaIndexes: boolean; bucketType: BucketType; ejectionMethod: EvictionPolicy; maxTTL: number; compressionMode: CompressionMode; minimumDurabilityLevel: DurabilityLevel; }; /** *CreateBucketSettings provides information for creating a bucket.
*/ declare type CreateBucketSettings = { conflictResolutionType: ConflictResolutionType; }; declare type CreateBucketCallback = (err: Error, res: boolean) => void; declare type UpdateBucketCallback = (err: Error, res: boolean) => void; declare type DropBucketCallback = (err: Error, res: boolean) => void; declare type GetBucketCallback = (err: Error, res: BucketSettings) => void; declare type GetAllBucketsCallback = (err: Error, res: BucketSettings[]) => void; declare type FlushBucketCallback = (err: Error, res: boolean) => void; /** *CertificateAuthenticator provides an authenticator implementation * which uses TLS Certificate Authentication.
*/ declare class CertificateAuthenticator { constructor(certificatePath: string, keyPath: string); } /** *Cluster represents an entire Couchbase Server cluster.
*/ declare class Cluster { /** *Connect establishes a connection to the cluster and is the entry * point for all SDK operations.
*/ static connect(connStr: string, options?: { username?: string; password?: string; authenticator?: string; trustStorePath?: string; kvTimeout?: number; kvDurableTimeout?: number; viewTimeout?: number; queryTimeout?: number; analyticsTimeout?: number; searchTimeout?: number; managementTimeout?: number; transcoder?: Transcoder; logFunc?: LoggingCallback; }, callback?: ConnectCallback): PromiseDiagnostics returns stateful data about the current SDK connections.
*/ diagnostics(options?: { reportId?: string; }, callback?: DiagnosticsCallback): PromisePing returns information from pinging the connections for this cluster.
*/ ping(options?: { reportId?: string; serviceTypes?: ServiceType[]; timeout?: number; }, callback?: PingCallback): PromiseThe query string to execute.
* @param [options.parameters] -parameters specifies a list of values to substitute within the query * statement during execution.
* @param [options.scanConsistency] -scanConsistency specifies the level of consistency that is required for * the results of the query.
* @param [options.consistentWith] -consistentWith specifies a MutationState object to use when determining * the level of consistency needed for the results of the query.
* @param [options.adhoc] -adhoc specifies that the query is an adhoc query and should not be * prepared and cached within the SDK.
* @param [options.flexIndex] -flexIndex specifies to enable the use of FTS indexes when selecting * indexes to use for the query.
* @param [options.clientContextId] -clientContextId specifies a unique identifier for the execution of this * query to enable various tools to correlate the query.
* @param [options.readOnly] -readOnly specifies that query should not be permitted to mutate any data. * This option also enables a few minor performance improvements and the * ability to automatically retry the query on failure.
* @param [options.profile] -profile enables the return of profiling data from the server.
* @param [options.metrics] -metrics enables the return of metrics data from the server
* @param [options.raw] -raw specifies an object represent raw key value pairs that should be * included with the query.
* @param [options.timeout] -timeout specifies the number of ms to wait for completion before * cancelling the operation and returning control to the application.
*/ query(query: string, options?: { parameters?: any | any[]; scanConsistency?: QueryScanConsistency; consistentWith?: MutationState; adhoc?: boolean; flexIndex?: boolean; clientContextId?: string; maxParallelism?: number; pipelineBatch?: number; pipelineCap?: number; scanWait?: number; scanCap?: number; readOnly?: boolean; profile?: QueryProfileMode; metrics?: boolean; raw?: any; timeout?: number; }, callback?: QueryCallback): PromiseThe query string to execute.
* @param [options.parameters] -parameters specifies a list of values to substitute within the query * statement during execution.
* @param [options.scanConsistency] -scanConsistency specifies the level of consistency that is required for * the results of the query.
* @param [options.clientContextId] -clientContextId specifies a unique identifier for the execution of this * query to enable various tools to correlate the query.
* @param [options.priority] -priority specifies that this query should be executed with a higher * priority than others, causing it to receive extra resources.
* @param [options.readOnly] -readOnly specifies that query should not be permitted to mutate any data. * This option also enables a few minor performance improvements and the * ability to automatically retry the query on failure.
* @param [options.raw] -raw specifies an object represent raw key value pairs that should be * included with the query.
* @param [options.timeout] -timeout specifies the number of ms to wait for completion before * cancelling the operation and returning control to the application.
*/ analyticsQuery(query: string, options?: { parameters?: any | any[]; scanConsistency?: AnalyticsScanConsistency; clientContextId?: string; priority?: boolean; readOnly?: boolean; raw?: any; timeout?: number; }, callback?: AnalyticsQueryCallback): PromiseThe name of the index to execute the query against.
* @param query -The search query object describing the requested search.
*/ searchQuery(indexName: string, query: SearchQuery, options?: { skip?: number; limit?: number; explain?: boolean; highlight?: { style?: HighlightStyle; fields?: string[]; }; fields?: string[]; facets?: SearchFacet[]; sort?: SearchSort; disableScoring?: boolean; consistency?: SearchScanConsistency; consistentWith?: MutationState; timeout?: number; }, callback?: SearchQueryCallback): PromiseGets a reference to a bucket.
*/ bucket(bucketName: string): Bucket; /** *Closes all connections associated with this cluster. Any * running operations will be cancelled. Further operations * will cause new connections to be established.
*/ close(): void; /** *Gets a user manager for this cluster
*/ users(): UserManager; /** *Gets a bucket manager for this cluster
*/ buckets(): BucketManager; /** *Gets a query index manager for this cluster
*/ queryIndexes(): QueryIndexManager; /** *Gets an analytics index manager for this cluster
*/ analyticsIndexes(): AnalyticsIndexManager; /** *Gets a search index manager for this cluster
*/ searchIndexes(): SearchIndexManager; } declare type ConnectCallback = (err: Error, cluster: Cluster) => void; /** *Contains the results from a previously executed Diagnostics operation.
*/ declare type DiagnosticsResult = { id: string; version: number; sdk: string; services: any; }; declare type DiagnosticsCallback = (err: Error, res: DiagnosticsResult) => void; /** *Contains the results from a previously executed Diagnostics operation.
*/ declare type PingResult = { id: string; version: number; sdk: string; services: any; }; declare type PingCallback = (err: Error, res: PingResult) => void; declare type QueryResult = { rows: object[]; meta: any; }; declare type QueryCallback = (err: Error, res: QueryResult) => void; declare type AnalyticsResult = { rows: object[]; meta: any; }; declare type AnalyticsQueryCallback = (err: Error, res: AnalyticsResult) => void; declare type SearchQueryResult = { rows: object[]; meta: any; }; declare type SearchQueryCallback = (err: Error, res: SearchQueryResult) => void; /** *Collection provides an interface for performing operations against * a collection within the cluster.
*/ declare class Collection { get(key: string, options?: { project?: string[]; withExpiry?: boolean; transcoder?: Transcoder; timeout?: number; }, callback?: GetCallback): PromiseContains the results from a previously execute Get operation.
*/ declare type GetResult = { content: any; cas: Cas; expiry?: number; }; declare type GetCallback = (err: Error, res: GetResult) => void; /** *Contains the results from a previously execute Get operation.
*/ declare type ExistsResult = { exists: boolean; cas: Cas; }; declare type ExistsCallback = (err: Error, res: ExistsResult) => void; /** *Contains the results from a previously executed replica get operation.
*/ declare type GetReplicaResult = { value: any; cas: Cas; isReplica: boolean; }; declare type GetAnyReplicaCallback = (err: Error, res: GetReplicaResult) => void; declare type GetAllReplicasCallback = (err: Error, res: GetReplicaResult[]) => void; /** *Contains the results from a previously executed mutation operation.
*/ declare type MutationResult = { cas: Cas; mutationToken?: MutationToken; }; declare type MutateCallback = (err: Error, res: MutationResult) => void; declare type RemoveResult = { cas: Cas; mutationToken?: MutationToken; }; declare type RemoveCallback = (err: Error, res: RemoveResult) => void; declare type GetAndTouchResult = { content: any; cas: Cas; mutationToken?: MutationToken; }; declare type GetAndTouchCallback = (err: Error, res: GetAndTouchResult) => void; declare type TouchResult = { cas: Cas; mutationToken?: MutationToken; }; declare type TouchCallback = (err: Error, res: TouchResult) => void; declare type GetAndLockResult = { content: any; cas: Cas; mutationToken?: MutationToken; }; declare type GetAndLockCallback = (err: Error, res: GetAndLockResult[]) => void; declare type UnlockResult = { content: any; cas: Cas; mutationToken?: MutationToken; }; declare type UnlockCallback = (err: Error, res: UnlockResult) => void; declare type LookupInResult = { content: any; cas: Cas; }; declare type LookupInCallback = (err: Error, res: LookupInResult) => void; declare type MutateInResult = { content: any; }; declare type MutateInCallback = (err: Error, res: MutateInResult) => void; /** *CollectionManager allows the management of collections within a Bucket.
*/ declare class CollectionManager { /** *createCollection creates a collection within a scope in a bucket.
* @param collectionSpec -The details of the collection to create.
* @param [options.timeout] -Timeout for the operation in milliseconds.
*/ createCollection(collectionSpec: CollectionSpec, options?: { timeout?: number; }, callback?: CreateCollectionCallback): PromisedropCollection drops a collection from a scope in a bucket.
* @param collectionName -The name of the collection to drop.
* @param scopeName -The name of the scope containing the collection to drop.
* @param [options.timeout] -Timeout for the operation in milliseconds.
*/ dropCollection(collectionName: string, scopeName: string, options?: { timeout?: number; }, callback?: DropCollectionCallback): PromisecreateScope creates a scope within a bucket.
* @param scopeName -The name of the scope to create.
* @param [options.timeout] -Timeout for the operation in milliseconds.
*/ createScope(scopeName: string, options?: { timeout?: number; }, callback?: CreateScopeCallback): PromisedropScope drops a scope from a bucket.
* @param scopeName -The name of the scope to drop.
* @param [options.timeout] -Timeout for the operation in milliseconds.
*/ dropScope(scopeName: string, options?: { timeout?: number; }, callback?: DropScopeCallback): PromiseThe name of the collection to create.
* @property scopeName -The name of the scope to create the collection in.
* @property maxExpiry -The maximum expiry for documents in this bucket.
*/ declare type CollectionSpec = { name: string; scopeName: string; maxExpiry: number; }; declare type CreateCollectionCallback = (err: Error, res: boolean) => void; declare type DropCollectionCallback = (err: Error, res: boolean) => void; declare type CreateScopeCallback = (err: Error, res: boolean) => void; declare type DropScopeCallback = (err: Error, res: boolean) => void; declare type LoggingEntry = { severity: number; srcFile: string; srcLine: number; subsys: string; message: string; }; declare type LoggingCallback = (entry: LoggingEntry) => void; declare module "@corbinu/couchbase" { /** *Creates a new Cluster object for interacting with a Couchbase * cluster and performing operations.
* @param connStr -The connection string of your cluster
* @param [options.username] -The RBAC username to use when connecting to the cluster.
* @param [options.password] -The RBAC password to use when connecting to the cluster
* @param [options.clientCertificate] -A client certificate to use for authentication with the server. Specifying * this certificate along with any other authentication method (such as username * and password) is an error.
* @param [options.certificateChain] -A certificate chain to use for validating the clusters certificates.
*/ function connect(connStr: string, options?: { username?: string; password?: string; clientCertificate?: string; certificateChain?: string; }, callback?: ConnectCallback): PromiseExpose the LCB version that is in use.
*/ var lcbVersion: string; } /** *CouchbaseList provides a simplified interface * for storing lists within a Couchbase document.
*/ declare class CouchbaseList { getAll(callback: (...params: any[]) => any): void; getAt(index: any, callback: (...params: any[]) => any): void; removeAt(index: any, callback: (...params: any[]) => any): void; indexOf(value: any, callback: (...params: any[]) => any): void; size(callback: (...params: any[]) => any): void; push(value: any, callback: (...params: any[]) => any): void; unshift(value: any, callback: (...params: any[]) => any): void; } /** *CouchbaseMap provides a simplified interface * for storing a map within a Couchbase document.
*/ declare class CouchbaseMap { getAll(callback: (...params: any[]) => any): void; forEach(rowCallback: (...params: any[]) => any, callback: (...params: any[]) => any): void; set(item: any, value: any, callback: (...params: any[]) => any): void; get(item: any, callback: (...params: any[]) => any): void; remove(item: any, callback: (...params: any[]) => any): void; exists(item: any, callback: (...params: any[]) => any): void; keys(callback: (...params: any[]) => any): void; values(callback: (...params: any[]) => any): void; size(callback: (...params: any[]) => any): void; } /** *CouchbaseQueue provides a simplified interface * for storing a queue within a Couchbase document.
*/ declare class CouchbaseQueue { size(callback: (...params: any[]) => any): void; push(value: any, callback: (...params: any[]) => any): void; pop(callback: (...params: any[]) => any): void; } /** *CouchbaseSet provides a simplified interface * for storing a set within a Couchbase document.
*/ declare class CouchbaseSet { add(item: any, callback: (...params: any[]) => any): void; contains(item: any, callback: (...params: any[]) => any): void; remove(item: any, callback: (...params: any[]) => any): void; values(callback: (...params: any[]) => any): void; size(callback: (...params: any[]) => any): void; } /** *Transcoder provides an interface for performing custom transcoding * of document contents being retrieved and stored to the cluster.
*/ declare interface Transcoder { /** *Encodes a value. Must return an array of two values, containing * a {@link Buffer} and {@link number}.
*/ encode(value: any): any[]; decode(bytes: Buffer, flags: number): any; } declare class DesignDocumentView { map: string; reduce: string; } declare class DesignDocument { constructor(name: string, views: { [key: string]: DesignDocumentView; }); /** *Returns the View class ({@link DesignDocumentView}).
*/ static View: (...params: any[]) => any; name: string; views: { [key: string]: DesignDocumentView; }; } declare const enum DurabilityLevel { None = 0, Majority = 1, MajorityAndPersistOnMaster = 2, PersistToMajority = 3 } declare const enum BucketType { Couchbase = "membase", Memcached = "memcached", Ephemeral = "ephemeral" } declare const enum EvictionPolicy { FullEviction = "fullEviction", ValueOnly = "valueOnly", NotRecentlyUsed = "nruEviction", NoEviction = "noEviction" } declare const enum CompressionMode { Off = "off", Passive = "passive", Active = "active" } declare const enum ConflictResolutionType { Timestamp = "lww", SequenceNumber = "seqno" } declare const enum QueryProfileMode { Off = "off", Phases = "phases", Timings = "timings" } declare const enum QueryScanConsistency { NotBounded = "not_bounded", RequestPlus = "request_plus" } declare const enum QueryStatus { Running = "running", Success = "success", Errors = "errors", Completed = "completed", Stopped = "stopped", Timeout = "timeout", Closed = "closed", Fatal = "fatal", Aborted = "aborted", Unknown = "unknown" } declare const enum AnalyticsScanConsistency { NotBounded = "not_bounded", RequestPlus = "request_plus" } declare const enum AnalyticsStatus { Running = "running", Success = "success", Errors = "errors", Completed = "completed", Stopped = "stopped", Timeout = "timeout", Closed = "closed", Fatal = "fatal", Aborted = "aborted", Unknown = "unknown" } declare const enum IndexType { Gsi = "gsi", View = "view", Unknown = "" } declare const enum HighlightStyle { HTML = "html", ANSI = "ansi" } declare const enum ViewScanConsistency { RequestPlus = "false", UpdateAfter = "update_after", NotBounded = "ok" } declare const enum ViewOrdering { Ascending = "false", Descending = "true" } declare const enum ViewErrorMode { Continue = "continue", Stop = "stop" } declare const enum SearchScanConsistency { NotBounded = "" } declare const enum LookupInMacro { Document = "{}", Expiry = "{}", Cas = "{}", SeqNo = "{}", LastModified = "{}", IsDeleted = "{}", ValueSizeBytes = "{}", RevId = "{}" } declare const enum MutateInMacro { Cas = "{}", SeqNo = "{}", ValueCrc32c = "{}" } declare const enum ServiceType { KeyValue = "kv", Management = "mgmt", Views = "views", Query = "query", Search = "search", Analytics = "analytics" } declare class CouchbaseError { } declare class TimeoutError { } declare class RequestCanceledError { } declare class InvalidArgumentError { } declare class ServiceNotAvailableError { } declare class InternalServerFailureError { } declare class AuthenticationFailureError { } declare class TemporaryFailureError { } declare class ParsingFailureError { } declare class CasMismatchError { } declare class BucketNotFoundError { } declare class CollectionNotFoundError { } declare class EncodingFailureError { } declare class DecodingFailureError { } declare class UnsupportedOperationError { } declare class AmbiguousTimeoutError { } declare class UnambiguousTimeoutError { } declare class FeatureNotAvailableError { } declare class ScopeNotFoundError { } declare class IndexNotFoundError { } declare class IndexExistsError { } declare class DocumentNotFoundError { } declare class DocumentUnretrievableError { } declare class DocumentLockedError { } declare class ValueTooLargeError { } declare class DocumentExistsError { } declare class ValueNotJsonError { } declare class DurabilityLevelNotAvailableError { } declare class DurabilityImpossibleError { } declare class DurabilityAmbiguousError { } declare class DurableWriteInProgressError { } declare class DurableWriteReCommitInProgressError { } declare class MutationLostError { } declare class PathNotFoundError { } declare class PathMismatchError { } declare class PathInvalidError { } declare class PathTooBigError { } declare class PathTooDeepError { } declare class ValueTooDeepError { } declare class ValueInvalidError { } declare class DocumentNotJsonError { } declare class NumberTooBigError { } declare class DeltaInvalidError { } declare class PathExistsError { } declare class PlanningFailureError { } declare class IndexFailureError { } declare class PreparedStatementFailure { } declare class CompilationFailureError { } declare class JobQueueFullError { } declare class DatasetNotFoundError { } declare class DataverseNotFoundError { } declare class DatasetExistsError { } declare class DataverseExistsError { } declare class LinkNotFoundError { } declare class ViewNotFoundError { } declare class DesignDocumentNotFoundError { } declare class CollectionExistsError { } declare class ScopeExistsError { } declare class UserNotFoundError { } declare class GroupNotFoundError { } declare class BucketExistsError { } declare class UserExistsError { } declare class BucketNotFlushableError { } declare class ErrorContext { } declare class KeyValueErrorContext { } declare class ViewErrorContext { } declare class QueryErrorContext { } declare class SearchErrorContext { } declare class AnalyticsErrorContext { } declare class LookupInSpec { static get(path: string, options?: any): LookupInSpec; static exists(path: string, options?: any): LookupInSpec; static count(path: string, options?: any): LookupInSpec; } declare class MutateInSpec { static insert(path: string, value: any, options?: { createPath?: boolean; }): MutateInSpec; static upsert(path: string, value: any, options?: { createPath?: boolean; }): MutateInSpec; static replace(path: string, value: any, options?: { createPath?: boolean; }): MutateInSpec; static remove(path: string, options?: any): MutateInSpec; static arrayAppend(path: string, value: any, options?: { createPath?: boolean; multi?: boolean; }): MutateInSpec; static arrayPrepend(path: string, value: any, options?: { createPath?: boolean; multi?: boolean; }): MutateInSpec; static arrayInsert(path: string, value: any, options?: { createPath?: boolean; multi?: boolean; }): MutateInSpec; static arrayAddUnique(path: string, value: any, options?: { createPath?: boolean; }): MutateInSpec; static increment(path: string, value: number, options?: { createPath?: boolean; }): MutateInSpec; static decrement(path: string, value: number, options?: { createPath?: boolean; }): MutateInSpec; } /** *Implements mutation token aggregation for performing consistentWith * on queries. Accepts any number of arguments (one per document/tokens).
*/ declare class MutationState { constructor(); /** *Adds an additional token to this MutationState * Accepts any number of arguments (one per document/tokens).
*/ add(): void; } /** *PasswordAuthenticator provides an authenticator implementation * which uses a Role Based Access Control Username and Password.
*/ declare class PasswordAuthenticator { constructor(username: string, password: string); } /** *QueryIndex represents a single query index.
*/ declare class QueryIndex { name: string; isPrimary: boolean; type: string; state: string; keyspace: string; indexKey: string[]; condition: string; partition: string; } /** *QueryIndexManager provides an interface for managing the * query indexes on the cluster.
*/ declare class QueryIndexManager { createIndex(bucketName: string, indexName: string, fields: string[], options?: { ignoreIfExists?: boolean; deferred?: boolean; timeout?: number; }, callback?: CreateQueryIndexCallback): PromiseGets a reference to a specific collection.
*/ collection(collectionName: string): Collection; /** * @param query -The query string to execute.
* @param [options.parameters] -parameters specifies a list of values to substitute within the query * statement during execution.
* @param [options.scanConsistency] -scanConsistency specifies the level of consistency that is required for * the results of the query.
* @param [options.consistentWith] -consistentWith specifies a MutationState object to use when determining * the level of consistency needed for the results of the query.
* @param [options.adhoc] -adhoc specifies that the query is an adhoc query and should not be * prepared and cached within the SDK.
* @param [options.flexIndex] -flexIndex specifies to enable the use of FTS indexes when selecting * indexes to use for the query.
* @param [options.clientContextId] -clientContextId specifies a unique identifier for the execution of this * query to enable various tools to correlate the query.
* @param [options.readOnly] -readOnly specifies that query should not be permitted to mutate any data. * This option also enables a few minor performance improvements and the * ability to automatically retry the query on failure.
* @param [options.profile] -profile enables the return of profiling data from the server.
* @param [options.metrics] -metrics enables the return of metrics data from the server
* @param [options.raw] -raw specifies an object represent raw key value pairs that should be * included with the query.
* @param [options.timeout] -timeout specifies the number of ms to wait for completion before * cancelling the operation and returning control to the application.
*/ query(query: string, options?: { parameters?: any | any[]; scanConsistency?: QueryScanConsistency; consistentWith?: MutationState; adhoc?: boolean; flexIndex?: boolean; clientContextId?: string; maxParallelism?: number; pipelineBatch?: number; pipelineCap?: number; scanWait?: number; scanCap?: number; readOnly?: boolean; profile?: QueryProfileMode; metrics?: boolean; raw?: any; timeout?: number; }, callback?: QueryCallback): PromiseThe query string to execute.
* @param [options.parameters] -parameters specifies a list of values to substitute within the query * statement during execution.
* @param [options.scanConsistency] -scanConsistency specifies the level of consistency that is required for * the results of the query.
* @param [options.clientContextId] -clientContextId specifies a unique identifier for the execution of this * query to enable various tools to correlate the query.
* @param [options.priority] -priority specifies that this query should be executed with a higher * priority than others, causing it to receive extra resources.
* @param [options.readOnly] -readOnly specifies that query should not be permitted to mutate any data. * This option also enables a few minor performance improvements and the * ability to automatically retry the query on failure.
* @param [options.raw] -raw specifies an object represent raw key value pairs that should be * included with the query.
* @param [options.timeout] -timeout specifies the number of ms to wait for completion before * cancelling the operation and returning control to the application.
*/ analyticsQuery(query: string, options?: { parameters?: any | any[]; scanConsistency?: AnalyticsScanConsistency; clientContextId?: string; priority?: boolean; readOnly?: boolean; raw?: any; timeout?: number; }, callback?: AnalyticsQueryCallback): PromiseSearchIndexManager provides an interface for managing the * search indexes on the cluster.
*/ declare class SearchIndexManager { getIndex(indexName: string, options?: { timeout?: number; }, callback?: GetSearchIndexCallback): Promise