Interface IBucket
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
|
Improve this Doc
View Source
Collections
Declaration
ICouchbaseCollectionManager Collections { get; }
Property Value
|
Improve this Doc
View Source
Name
Declaration
Property Value
|
Improve this Doc
View Source
SupportsCollections
Declaration
bool SupportsCollections { get; }
Property Value
|
Improve this Doc
View Source
ViewIndexes
Declaration
IViewIndexManager ViewIndexes { get; }
Property Value
Methods
|
Improve this Doc
View Source
Collection(String)
Declaration
ICouchbaseCollection Collection(string collectionName)
Parameters
Type |
Name |
Description |
String |
collectionName |
|
Returns
|
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
|
Improve this Doc
View Source
DefaultCollectionAsync()
Gets the default collection for the bucket.
Declaration
ValueTask<ICouchbaseCollection> DefaultCollectionAsync()
Returns
|
Improve this Doc
View Source
DefaultScope()
Declaration
Returns
|
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
|
Improve this Doc
View Source
Scope(String)
Declaration
IScope Scope(string scopeName)
Parameters
Type |
Name |
Description |
String |
scopeName |
|
Returns
|
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)
Declaration
Task<IViewResult<TKey, TValue>> ViewQueryAsync<TKey, TValue>(string designDocument, string viewName, ViewOptions options = null)
Parameters
Returns
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
Extension Methods