Class Cluster

Exposes the operations which are available to be performed against a cluster. Namely the ability to access to Buckets as well as performing management operations against the cluster.

Index

Methods

analyticsIndexes analyticsQuery bucket buckets close diagnostics eventingFunctions ping query queryIndexes search searchIndexes searchQuery transactions updateCredentials users waitUntilReady

Methods

analyticsIndexes

analyticsIndexes(): AnalyticsIndexManager
Returns a AnalyticsIndexManager which can be used to manage the analytics indexes of this cluster.

Returns AnalyticsIndexManager
- Defined in lib/cluster.ts:787

analyticsQuery

analyticsQuery<TRow = any>(
    statement: string,
    options?: AnalyticsQueryOptions,
    callback?: NodeCallback<AnalyticsResult<TRow>>,
): StreamableRowPromise<AnalyticsResult<TRow>, TRow, AnalyticsMetaData>
Executes an analytics query against the cluster.
Type Parameters
- TRow = any
Parameters
- statement: string
  The analytics statement to execute.
- Optionaloptions: AnalyticsQueryOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<AnalyticsResult<TRow>>
  A node-style callback to be invoked after execution.
Returns StreamableRowPromise<AnalyticsResult<TRow>, TRow, AnalyticsMetaData>
- Defined in lib/cluster.ts:855

bucket

bucket(bucketName: string): Bucket
Creates a Bucket object reference to a specific bucket.
Parameters
- bucketName: string
  The name of the bucket to reference.
Returns Bucket
- Defined in lib/cluster.ts:745

buckets

buckets(): BucketManager
Returns a BucketManager which can be used to manage the buckets of this cluster.

Returns BucketManager
- Defined in lib/cluster.ts:771

close

close(callback?: NodeCallback<void>): Promise<void>
Shuts down this cluster object. Cleaning up all resources associated with it.
Parameters
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/cluster.ts:1027

diagnostics

diagnostics(
options?: DiagnosticsOptions,
callback?: NodeCallback<DiagnosticsResult>,
): Promise<DiagnosticsResult>
Returns a diagnostics report about the currently active connections with the cluster. Includes information about remote and local addresses, last activity, and other diagnostics information.
Parameters
- Optionaloptions: DiagnosticsOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<DiagnosticsResult>
  A node-style callback to be invoked after execution.
Returns Promise<DiagnosticsResult>
- Defined in lib/cluster.ts:947

eventingFunctions

eventingFunctions(): EventingFunctionManager
Returns a EventingFunctionManager which can be used to manage the eventing functions of this cluster. Uncommitted: This API is subject to change in the future.

Returns EventingFunctionManager
- Defined in lib/cluster.ts:804

ping

ping(
options?: PingOptions,
callback?: NodeCallback<PingResult>,
): Promise<PingResult>
Performs a ping operation against the cluster. Pinging the services which are specified (or all services if none are specified). Returns a report which describes the outcome of the ping operations which were performed.
Parameters
- Optionaloptions: PingOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<PingResult>
  A node-style callback to be invoked after execution.
Returns Promise<PingResult>
- Defined in lib/cluster.ts:973

query

query<TRow = any>(
    statement: string,
    options?: QueryOptions,
    callback?: NodeCallback<QueryResult<TRow>>,
): StreamableRowPromise<QueryResult<TRow>, TRow, QueryMetaData>
Executes a N1QL query against the cluster.
Type Parameters
- TRow = any
Parameters
- statement: string
  The N1QL statement to execute.
- Optionaloptions: QueryOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<QueryResult<TRow>>
  A node-style callback to be invoked after execution.
Returns StreamableRowPromise<QueryResult<TRow>, TRow, QueryMetaData>
- Defined in lib/cluster.ts:826

queryIndexes

queryIndexes(): QueryIndexManager
Returns a QueryIndexManager which can be used to manage the query indexes of this cluster.

Returns QueryIndexManager
- Defined in lib/cluster.ts:779

search

search(
    indexName: string,
    request: SearchRequest,
    options?: SearchQueryOptions,
    callback?: NodeCallback<SearchResult>,
): StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>
Executes a search query against the cluster.
Parameters
- indexName: string
  The name of the index to query.
- request: SearchRequest
  The SearchRequest describing the search to execute.
- Optionaloptions: SearchQueryOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<SearchResult>
  A node-style callback to be invoked after execution.
Returns StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>
- Defined in lib/cluster.ts:916

searchIndexes

searchIndexes(): SearchIndexManager
Returns a SearchIndexManager which can be used to manage the search indexes of this cluster.

Returns SearchIndexManager
- Defined in lib/cluster.ts:795

searchQuery

searchQuery(
    indexName: string,
    query: SearchQuery,
    options?: SearchQueryOptions,
    callback?: NodeCallback<SearchResult>,
): StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>
Executes a search query against the cluster.
Parameters
- indexName: string
  The name of the index to query.
- query: SearchQuery
  The SearchQuery describing the query to execute.
- Optionaloptions: SearchQueryOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<SearchResult>
  A node-style callback to be invoked after execution.
Returns StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>
- Defined in lib/cluster.ts:885

transactions

transactions(): Transactions
Returns a Transactions object which can be used to perform transactions on this cluster.

Returns Transactions
- Defined in lib/cluster.ts:812

updateCredentials

updateCredentials(auth: Authenticator): void
Update the credentials used by this cluster.
Parameters
- auth: Authenticator
  The new credentials to use.
Returns void
- Defined in lib/cluster.ts:1053

users

users(): UserManager
Returns a UserManager which can be used to manage the users of this cluster.

Returns UserManager
- Defined in lib/cluster.ts:763

waitUntilReady

waitUntilReady(
    timeout: number,
    options?: WaitUntilReadyOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Waits until the cluster reaches the desired state or the timeout elapses. The default desired state is ClusterState.Online.
Parameters
- timeout: number
  The time in milliseconds to wait for the cluster to become ready.
- Optionaloptions: WaitUntilReadyOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/cluster.ts:999

Class Cluster

Index

Methods

Methods

analyticsIndexes

Returns AnalyticsIndexManager

analyticsQuery

Type Parameters

Parameters

Returns StreamableRowPromise<AnalyticsResult<TRow>, TRow, AnalyticsMetaData>

bucket

Parameters

Returns Bucket

buckets

Returns BucketManager

close

Parameters

Returns Promise<void>

diagnostics

Parameters

Returns Promise<DiagnosticsResult>

eventingFunctions

Returns EventingFunctionManager

ping

Parameters

Returns Promise<PingResult>

query

Type Parameters

Parameters

Returns StreamableRowPromise<QueryResult<TRow>, TRow, QueryMetaData>

queryIndexes

Returns QueryIndexManager

search

Parameters

Returns StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>

searchIndexes

Returns SearchIndexManager

searchQuery

Parameters

Returns StreamableRowPromise<SearchResult, SearchRow, SearchMetaData>

transactions

Returns Transactions

updateCredentials

Parameters

Returns void

users

Returns UserManager

waitUntilReady

Parameters

Returns Promise<void>

Settings

On This Page