Click or drag to resize

Cluster Class

Inheritance Hierarchy
SystemObject
  CouchbaseCluster

Namespace:  Couchbase
Assembly:  Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 3.0.0-local-202104090431+2cf4ef0907be195d64bd19df1f6b0c6539e1f8a5
Syntax
C#
public class Cluster : ICluster, IDisposable, 
	IAsyncDisposable

The Cluster type exposes the following members.

Properties
  NameDescription
Public propertyAnalyticsIndexes
Public propertyBuckets
Public propertyClusterServices
An IServiceProvider which provides access to cluster services, such as ITypeSerializer.
Public propertyQueryIndexes
Public propertySearchIndexes
Public propertyUsers
Top
Methods
  NameDescription
Public methodAnalyticsQueryAsyncT
Public methodBucketAsync
Public methodStatic memberConnectAsync(ClusterOptions)
Public methodStatic memberConnectAsync(String, ClusterOptions)
Public methodStatic memberConnectAsync(String, String, String)
Public methodDiagnosticsAsync
Creates diagnostic report that can be used to determine the healthfulness of the cluster. It does not proactively perform any I/O against the network.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodDisposeAsync
Protected methodEnsureBootstrapped
Seam for unit tests and for supporting non-GC3P servers (prior to v6.5).
Public methodPingAsync
Public methodQueryAsyncT
Public methodSearchQueryAsync
Public methodWaitUntilReadyAsync
Waits until bootstrapping has completed and all services have been initialized.
Top
Extension Methods
  NameDescription
Public Extension MethodAnalyticsQueryT(String, ActionAnalyticsOptions)Overloaded. (Defined by ClusterExtensions.)
Public Extension MethodAnalyticsQueryT(String, AnalyticsOptions)Overloaded. (Defined by ClusterExtensions.)
Public Extension MethodAnalyticsQueryAsyncT (Defined by ClusterExtensions.)
Public Extension MethodDiagnosticsAsync (Defined by ClusterExtensions.)
Public Extension MethodIngestAsyncT(String, ICouchbaseCollection, ActionIngestOptions)Overloaded.
Executes a query and ingests the results as documents into Couchbase server for further analytics.

NOTE: This is an experimental API and may change in the future.

(Defined by AnalyticsExtensions.)
Public Extension MethodIngestAsyncT(String, ICouchbaseCollection, IngestOptions)Overloaded.
Executes a query and ingests the results as documents into Couchbase server for further analytics.

NOTE: This is an experimental API and may change in the future.

(Defined by AnalyticsExtensions.)
Public Extension MethodQueryAsyncT(String)Overloaded. (Defined by ClusterExtensions.)
Public Extension MethodQueryAsyncT(String, ActionQueryOptions)Overloaded. (Defined by ClusterExtensions.)
Public Extension MethodSearchQueryAsync (Defined by ClusterExtensions.)
Top
See Also