Interface ICluster

Inherited Members
Namespace: Couchbase
Assembly: Couchbase.NetClient.dll
Syntax
public interface ICluster : ISearchRequester, IDisposable, IAsyncDisposable, IClusterAuthenticator

Properties

View Source

AnalyticsIndexes

Allows a user to manage analytics indexes.

Declaration
IAnalyticsIndexManager AnalyticsIndexes { get; }
Property Value
Type Description
IAnalyticsIndexManager
View Source

Buckets

Allows a user to manage a couchbase buckets resources.

Declaration
IBucketManager Buckets { get; }
Property Value
Type Description
IBucketManager
View Source

ClusterServices

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

Declaration
IServiceProvider ClusterServices { get; }
Property Value
Type Description
IServiceProvider
View Source

EventingFunctions

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

Declaration
IEventingFunctionManager EventingFunctions { get; }
Property Value
Type Description
IEventingFunctionManager
View Source

QueryIndexes

Allows a user to manage query indexes.

Declaration
IQueryIndexManager QueryIndexes { get; }
Property Value
Type Description
IQueryIndexManager
View Source

SearchIndexes

Allows a user to manage search indexes.

Declaration
ISearchIndexManager SearchIndexes { get; }
Property Value
Type Description
ISearchIndexManager
View Source

Transactions

Declaration
[InterfaceStability(Level.Volatile)]
Transactions Transactions { get; }
Property Value
Type Description
Transactions
View Source

Users

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

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

Methods

View Source

AnalyticsQueryAsync<T>(string, AnalyticsOptions?)

Declaration
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
View Source

BucketAsync(string)

Declaration
ValueTask<IBucket> BucketAsync(string name)
Parameters
Type Name Description
string name
Returns
Type Description
ValueTask<IBucket>
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
Task<IDiagnosticsReport> DiagnosticsAsync(DiagnosticsOptions? options = null)
Parameters
Type Name Description
DiagnosticsOptions options

Optional arguments.
Returns
Type Description
Task<IDiagnosticsReport>
View Source

PingAsync(PingOptions?)

Actively performs I/O by application-level pinging services and returning their pinged status.

Declaration
Task<IPingReport> PingAsync(PingOptions? options = null)
Parameters
Type Name Description
PingOptions options

Optional arguments.
Returns
Type Description
Task<IPingReport>
View Source

QueryAsync<T>(string, QueryOptions?)

Declaration
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
View Source

SearchQueryAsync(string, ISearchQuery, SearchOptions?)

Declaration
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>
View Source

WaitUntilReadyAsync(TimeSpan, WaitUntilReadyOptions?)

Waits until a desired cluster state by default (“online”) is reached or times out.

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

The TimeSpan duration to wait before throwing an exception.
WaitUntilReadyOptions options

Optional arguments.
Returns
Type Description
Task

Extension Methods