Couchbase .NET SDK | 3.3.1
Search Results for

    Show / Hide Table of Contents

    Interface IBucket

    Namespace: Couchbase
    Assembly: Couchbase.NetClient.dll
    Syntax
    public interface IBucket : IDisposable, IAsyncDisposable

    Properties

    | Improve this Doc View Source

    Cluster

    The cluster that owns this bucket.

    Declaration
    ICluster Cluster { get; }
    Property Value
    Type Description
    ICluster
    | Improve this Doc View Source

    Collections

    Declaration
    ICouchbaseCollectionManager Collections { get; }
    Property Value
    Type Description
    ICouchbaseCollectionManager
    | Improve this Doc View Source

    Name

    Declaration
    string Name { get; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    SupportsCollections

    Declaration
    bool SupportsCollections { get; }
    Property Value
    Type Description
    Boolean
    | Improve this Doc View Source

    ViewIndexes

    Declaration
    IViewIndexManager ViewIndexes { get; }
    Property Value
    Type Description
    IViewIndexManager

    Methods

    | Improve this Doc View Source

    Collection(String)

    Declaration
    ICouchbaseCollection Collection(string collectionName)
    Parameters
    Type Name Description
    String collectionName
    Returns
    Type Description
    ICouchbaseCollection
    | Improve this Doc View Source

    CollectionAsync(String)

    Gets a collection from the default scope of the bucket by name.

    Declaration
    ValueTask<ICouchbaseCollection> CollectionAsync(string collectionName)
    Parameters
    Type Name Description
    String collectionName

    The name of the collection to fetch.

    Returns
    Type Description
    ValueTask<ICouchbaseCollection>

    A collection that belongs to the default scope of the bucket.

    | Improve this Doc View Source

    DefaultCollection()

    Declaration
    ICouchbaseCollection DefaultCollection()
    Returns
    Type Description
    ICouchbaseCollection
    | Improve this Doc View Source

    DefaultCollectionAsync()

    Gets the default collection for the bucket.

    Declaration
    ValueTask<ICouchbaseCollection> DefaultCollectionAsync()
    Returns
    Type Description
    ValueTask<ICouchbaseCollection>

    The default collection.

    | Improve this Doc View Source

    DefaultScope()

    Declaration
    IScope DefaultScope()
    Returns
    Type Description
    IScope
    | Improve this Doc View Source

    DefaultScopeAsync()

    Gets the default scope for the bucket.

    Declaration
    ValueTask<IScope> DefaultScopeAsync()
    Returns
    Type Description
    ValueTask<IScope>

    The default scope.

    | 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
    Type Description
    Task<IPingReport>
    | Improve this Doc View Source

    Scope(String)

    Declaration
    IScope Scope(string scopeName)
    Parameters
    Type Name Description
    String scopeName
    Returns
    Type Description
    IScope
    | Improve this Doc View Source

    ScopeAsync(String)

    Gets a scope from the bucket by name.

    Declaration
    ValueTask<IScope> ScopeAsync(string scopeName)
    Parameters
    Type Name Description
    String scopeName

    The name of the scope to fetch.

    Returns
    Type Description
    ValueTask<IScope>

    A scope that belongs to the bucket.

    | Improve this Doc View Source

    ViewQueryAsync<TKey, TValue>(String, String, ViewOptions)

    Execute a view query.

    Declaration
    Task<IViewResult<TKey, TValue>> ViewQueryAsync<TKey, TValue>(string designDocument, string viewName, ViewOptions options = null)
    Parameters
    Type Name Description
    String designDocument

    Design document name.

    String viewName

    View name.

    ViewOptions options

    ViewOptions controlling query execution.

    Returns
    Type Description
    Task<IViewResult<TKey, TValue>>

    An IViewResult<TKey, TValue>.

    Type Parameters
    Name Description
    TKey

    Type of the key for each result row.

    TValue

    Type of the value for each result row.

    | 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
    Type Description
    Task

    Extension Methods

    BucketExtensions.ViewQueryAsync<TKey, TValue>(IBucket, String, String)
    BucketExtensions.ViewQueryAsync<TKey, TValue>(IBucket, String, String, Action<ViewOptions>)
    BucketExtensions.PingAsync(IBucket, ServiceType[])
    BucketExtensions.PingAsync(IBucket, Action<PingOptions>)
    BucketExtensions.PingAsync(IBucket, String, ServiceType[])
    • Improve this Doc
    • View Source
    In This Article
    Back to top © 2022 Couchbase, Inc.