Couchbase .NET SDK | 3.7.2
Search Results for

    Show / Hide Table of Contents

    Class Cluster

    Inheritance
    object
    Cluster
    Implements
    ICluster
    ISearchRequester
    IDisposable
    IAsyncDisposable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Couchbase
    Assembly: Couchbase.NetClient.dll
    Syntax
    public class Cluster : ICluster, ISearchRequester, IDisposable, IAsyncDisposable

    Properties

    | Edit this page View Source

    AnalyticsIndexes

    Allows a user to manage analytics indexes.

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

    Buckets

    Allows a user to manage a couchbase buckets resources.

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

    ClusterServices

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

    Declaration
    public IServiceProvider ClusterServices { get; }
    Property Value
    Type Description
    IServiceProvider
    | Edit this page 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
    | Edit this page View Source

    QueryIndexes

    Allows a user to manage query indexes.

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

    SearchIndexes

    Allows a user to manage search indexes.

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

    Transactions

    Declaration
    public Transactions Transactions { get; }
    Property Value
    Type Description
    Transactions
    | Edit this page 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

    | Edit this page View Source

    AnalyticsQueryAsync<T>(string, AnalyticsOptions?)

    Declaration
    public 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
    | Edit this page View Source

    BucketAsync(string)

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

    ConnectAsync(ClusterOptions)

    Declaration
    public static Task<ICluster> ConnectAsync(ClusterOptions options)
    Parameters
    Type Name Description
    ClusterOptions options
    Returns
    Type Description
    Task<ICluster>
    | Edit this page 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>
    | Edit this page 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>
    | Edit this page 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>
    | Edit this page 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 Task<IDiagnosticsReport> DiagnosticsAsync(DiagnosticsOptions? options = null)
    Parameters
    Type Name Description
    DiagnosticsOptions options

    Optional arguments.

    Returns
    Type Description
    Task<IDiagnosticsReport>
    | Edit this page View Source

    Dispose()

    Declaration
    public void Dispose()
    | Edit this page View Source

    DisposeAsync()

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

    Declaration
    public ValueTask DisposeAsync()
    Returns
    Type Description
    ValueTask
    | Edit this page View Source

    EnsureBootstrapped()

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

    Declaration
    protected virtual Task EnsureBootstrapped()
    Returns
    Type Description
    Task
    | Edit this page View Source

    PingAsync(PingOptions?)

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

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

    Optional arguments.

    Returns
    Type Description
    Task<IPingReport>
    | Edit this page View Source

    QueryAsync<T>(string, QueryOptions?)

    Declaration
    public 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
    | Edit this page View Source

    SearchAsync(string, SearchRequest, SearchOptions?)

    Declaration
    public Task<ISearchResult> SearchAsync(string indexName, SearchRequest searchRequest, SearchOptions? options = null)
    Parameters
    Type Name Description
    string indexName
    SearchRequest searchRequest
    SearchOptions options
    Returns
    Type Description
    Task<ISearchResult>
    | Edit this page View Source

    SearchQueryAsync(string, ISearchQuery, SearchOptions?)

    Declaration
    public 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>
    | Edit this page View Source

    WaitUntilReadyAsync(TimeSpan, WaitUntilReadyOptions?)

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

    Declaration
    public 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

    ICluster
    ISearchRequester
    IDisposable
    IAsyncDisposable

    Extension Methods

    AnalyticsExtensions.IngestAsync<T>(ICluster, string, ICouchbaseCollection, IngestOptions)
    AnalyticsExtensions.IngestAsync<T>(ICluster, string, ICouchbaseCollection, Action<IngestOptions>)
    ClusterExtensions.AnalyticsQuery<T>(ICluster, string, AnalyticsOptions)
    ClusterExtensions.AnalyticsQuery<T>(ICluster, string, Action<AnalyticsOptions>)
    ClusterExtensions.AnalyticsQueryAsync<T>(ICluster, string, Action<AnalyticsOptions>)
    ClusterExtensions.DiagnosticsAsync(ICluster, Action<DiagnosticsOptions>)
    ClusterExtensions.QueryAsync<T>(ICluster, string)
    ClusterExtensions.QueryAsync<T>(ICluster, string, Action<QueryOptions>)
    ClusterExtensions.SearchQueryAsync(ICluster, string, ISearchQuery, Action<SearchOptions>)
    • Edit this page
    • View Source
    In this article
    Back to top © 2025 Couchbase, Inc.