Class Cluster

Inheritance
Object
Cluster
Implements
IDisposable
IAsyncDisposable
Namespace: Couchbase
Assembly: Couchbase.NetClient.dll
Syntax
public class Cluster : object, ICluster, IDisposable, IAsyncDisposable, IBootstrappable

Properties

| Improve this Doc View Source

AnalyticsIndexes

Allows a user to manage analytics indexes.

Declaration
public IAnalyticsIndexManager AnalyticsIndexes { get; }
Property Value
Type Description
IAnalyticsIndexManager
| Improve this Doc View Source

Buckets

Allows a user to manage a couchbase buckets resources.

Declaration
public IBucketManager Buckets { get; }
Property Value
Type Description
IBucketManager
| Improve this Doc View Source

ClusterServices

An which provides access to cluster services, such as ITypeSerializer.

Declaration
public IServiceProvider ClusterServices { get; }
Property Value
Type Description
IServiceProvider
| Improve this Doc View Source

EventingFunctions

Allows a user to read eventing functions, modify them and change their deployment state.

Declaration
public IEventingFunctionManager EventingFunctions { get; }
Property Value
Type Description
IEventingFunctionManager
| Improve this Doc View Source

QueryIndexes

Allows a user to manage query indexes.

Declaration
public IQueryIndexManager QueryIndexes { get; }
Property Value
Type Description
IQueryIndexManager
| Improve this Doc View Source

SearchIndexes

Allows a user to manage search indexes.

Declaration
public ISearchIndexManager SearchIndexes { get; }
Property Value
Type Description
ISearchIndexManager
| Improve this Doc View Source

Users

Allows a user to manage the users for a couchbase server.

Declaration
public IUserManager Users { get; }
Property Value
Type Description
IUserManager

Methods

| Improve this Doc View Source

AnalyticsQueryAsync<T>(String, AnalyticsOptions)

Declaration
public async Task<IAnalyticsResult<T>> AnalyticsQueryAsync<T>(string statement, AnalyticsOptions options = null)
Parameters
Type Name Description
String statement
AnalyticsOptions options
Returns
Type Description
Task<IAnalyticsResult<T>>
Type Parameters
Name Description
T
| Improve this Doc View Source

BucketAsync(String)

Declaration
public ValueTask<IBucket> BucketAsync(string name)
Parameters
Type Name Description
String name
Returns
Type Description
ValueTask<IBucket>
| Improve this Doc View Source

ConnectAsync(ClusterOptions)

Declaration
public static async Task<ICluster> ConnectAsync(ClusterOptions options)
Parameters
Type Name Description
ClusterOptions options
Returns
Type Description
Task<ICluster>
| Improve this Doc View Source

ConnectAsync(String, Action<ClusterOptions>)

Declaration
public static Task<ICluster> ConnectAsync(string connectionString, Action<ClusterOptions> configureOptions)
Parameters
Type Name Description
String connectionString
Action<ClusterOptions> configureOptions
Returns
Type Description
Task<ICluster>
| Improve this Doc View Source

ConnectAsync(String, ClusterOptions)

Declaration
public static Task<ICluster> ConnectAsync(string connectionString, ClusterOptions options = null)
Parameters
Type Name Description
String connectionString
ClusterOptions options
Returns
Type Description
Task<ICluster>
| Improve this Doc View Source

ConnectAsync(String, String, String)

Declaration
public static Task<ICluster> ConnectAsync(string connectionString, string username, string password)
Parameters
Type Name Description
String connectionString
String username
String password
Returns
Type Description
Task<ICluster>
| Improve this Doc View Source

DiagnosticsAsync(DiagnosticsOptions)

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.

Declaration
public async Task<IDiagnosticsReport> DiagnosticsAsync(DiagnosticsOptions options = null)
Parameters
Type Name Description
DiagnosticsOptions options

Optional arguments.
Returns
Type Description
Task<IDiagnosticsReport>
| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

DisposeAsync()

Declaration
public ValueTask DisposeAsync()
Returns
Type Description
ValueTask
| Improve this Doc View Source

EnsureBootstrapped()

Seam for unit tests and for supporting non-GC3P servers (prior to v6.5).

Declaration
protected virtual async Task EnsureBootstrapped()
Returns
Type Description
Task
| Improve this Doc View Source

PingAsync(PingOptions)

Declaration
public async Task<IPingReport> PingAsync(PingOptions options = null)
Parameters
Type Name Description
PingOptions options
Returns
Type Description
Task<IPingReport>
| Improve this Doc View Source

QueryAsync<T>(String, QueryOptions)

Declaration
public async Task<IQueryResult<T>> QueryAsync<T>(string statement, QueryOptions options = null)
Parameters
Type Name Description
String statement
QueryOptions options
Returns
Type Description
Task<IQueryResult<T>>
Type Parameters
Name Description
T
| Improve this Doc View Source

SearchQueryAsync(String, ISearchQuery, SearchOptions)

Declaration
public async Task<ISearchResult> SearchQueryAsync(string indexName, ISearchQuery query, SearchOptions options = null)
Parameters
Type Name Description
String indexName
ISearchQuery query
SearchOptions options
Returns
Type Description
Task<ISearchResult>
| Improve this Doc View Source

WaitUntilReadyAsync(TimeSpan, WaitUntilReadyOptions)

Waits until bootstrapping has completed and all services have been initialized.

Declaration
public async Task WaitUntilReadyAsync(TimeSpan timeout, WaitUntilReadyOptions options = null)
Parameters
Type Name Description
TimeSpan timeout

The amount of time to wait for the desired ClusterState.
WaitUntilReadyOptions options

The optional arguments.
Returns
Type Description
Task

Implements

IDisposable
IAsyncDisposable