Click or drag to resize

Cluster Class

The client interface to a Couchbase Server Cluster.
Inheritance Hierarchy
SystemObject
  CouchbaseCluster

Namespace:  Couchbase
Assembly:  Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 2.5.7-alpha1

The Cluster type exposes the following members.

Constructors
  NameDescription
Public methodCluster
Ctor for creating Cluster instance using the default settings.
Public methodCluster(String)
Ctor for creating Cluster instance using an App.Config or Web.config.
Public methodCluster(ClientConfiguration)
Ctor for creating Cluster instance with a custom ClientConfiguration configuration.
Public methodCluster(ICouchbaseClientDefinition)
Ctor for creating Cluster instance using an ICouchbaseClientDefinition.
Top
Properties
  NameDescription
Public propertyConfiguration
The current client configuration being used by the Cluster object. Set this by passing in a ClientConfiguration object into [!:Initialize(ClientConfiguration)] or by providing a CouchbaseClientSection in your App.config or Web.config and calling [!:Initialize(string)]
Public propertyInfo Obsolete.
Returns an object representing cluster status information.
Top
Methods
  NameDescription
Public methodAuthenticate(IAuthenticator)
Authenticates the specified authenticator.
Public methodAuthenticate(IClusterCredentials)
Authenticates the specified credentials.
Public methodAuthenticate(String, String)
Authenticate using a username and password.
Public methodCloseBucket
Closes and releases all resources associated with a Couchbase bucket.
Public methodCreateManager
Creates a IClusterManager object that uses the current ICluster configuration settings and IClusterCredentials for authentication.
Public methodCreateManager(String, String)
Creates a IClusterManager object that uses the current ICluster configuration settings.
Public methodDiagnostics
Creates a diagnostics report from the perspective of the client connected to each of the requeted services.
Public methodDiagnostics(String)
Creates a diagnostics report from the perspective of the client connected to each of the requeted services.
Public methodDispose
Closes and releases all internal resources.
Public methodEquals (Inherited from Object.)
Protected methodFinalize
Cleans up any non-reclaimed resources.
(Overrides ObjectFinalize.)
Public methodGetClusterVersion
Gets the cluster version using the configured credentials.
Public methodGetClusterVersionAsync
Gets the cluster version using the configured credentials.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodIsOpen
Returns a response indicating whether or not the IBucket instance has been opened and this Cluster instance is observing it.
Public methodOpenBucket
Opens the default bucket associated with a Couchbase Cluster.
Public methodOpenBucket(String)
Creates a connection to a non-SASL Couchbase bucket.
Public methodOpenBucket(String, String)
Creates a connection to a specific SASL authenticated Couchbase Bucket.
Public methodOpenBucketAsync
Opens the default bucket associated with a Couchbase Cluster.
Public methodOpenBucketAsync(String)
Creates a connection to a non-SASL Couchbase bucket.
Public methodOpenBucketAsync(String, String)
Creates a connection to a specific SASL authenticated Couchbase Bucket.
Public methodQueryT(String)
Executes a N1QL query against the Couchbase Cluster.
Public methodQueryT(IQueryRequest)
Executes a N1QL statement or prepared statement via a IQueryRequest against the Couchbase Cluster.
Public methodQueryAsyncT(String)
Asynchronously executes a N1QL query against the Couchbase Cluster.
Public methodQueryAsyncT(IQueryRequest)
Asynchronously executes a N1QL statement or prepared statement via a IQueryRequest against the Couchbase Cluster.
Public methodToString (Inherited from Object.)
Top
See Also