Interface ICluster
Assembly: Couchbase.NetClient.dll
Syntax
public interface ICluster : ISearchRequester, IDisposable, IAsyncDisposable
Properties
|
Improve this Doc
View Source
AnalyticsIndexes
Allows a user to manage analytics indexes.
Declaration
IAnalyticsIndexManager AnalyticsIndexes { get; }
Property Value
|
Improve this Doc
View Source
Buckets
Allows a user to manage a couchbase buckets resources.
Declaration
IBucketManager Buckets { get; }
Property Value
|
Improve this Doc
View Source
ClusterServices
Declaration
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
IEventingFunctionManager EventingFunctions { get; }
Property Value
|
Improve this Doc
View Source
QueryIndexes
Allows a user to manage query indexes.
Declaration
IQueryIndexManager QueryIndexes { get; }
Property Value
|
Improve this Doc
View Source
SearchIndexes
Allows a user to manage search indexes.
Declaration
ISearchIndexManager SearchIndexes { get; }
Property Value
|
Improve this Doc
View Source
Users
Allows a user to manage the users for a couchbase server.
Declaration
IUserManager Users { get; }
Property Value
Methods
|
Improve this Doc
View Source
AnalyticsQueryAsync<T>(String, AnalyticsOptions)
Declaration
Task<IAnalyticsResult<T>> AnalyticsQueryAsync<T>(string statement, AnalyticsOptions options = null)
Parameters
Returns
Type Parameters
|
Improve this Doc
View Source
BucketAsync(String)
Declaration
ValueTask<IBucket> BucketAsync(string name)
Parameters
Type |
Name |
Description |
String |
name |
|
Returns
Type |
Description |
ValueTask<IBucket> |
|
|
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
Task<IDiagnosticsReport> DiagnosticsAsync(DiagnosticsOptions options = null)
Parameters
Returns
|
Improve this Doc
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
|
Improve this Doc
View Source
QueryAsync<T>(String, QueryOptions)
Declaration
Task<IQueryResult<T>> QueryAsync<T>(string statement, QueryOptions options = null)
Parameters
Returns
Type Parameters
|
Improve this Doc
View Source
SearchQueryAsync(String, ISearchQuery, SearchOptions)
Declaration
Task<ISearchResult> SearchQueryAsync(string indexName, ISearchQuery query, SearchOptions options = null)
Parameters
Returns
|
Improve this Doc
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 duration to wait before throwing an exception.
|
WaitUntilReadyOptions |
options |
Optional arguments.
|
Returns
Extension Methods