Class BucketExtensions

Inheritance

Object

BucketExtensions

Namespace: Couchbase

Assembly: Couchbase.NetClient.dll

Syntax

public static class BucketExtensions : object

Methods

PingAsync(IBucket, Action<PingOptions>)

Declaration

public static Task<IPingReport> PingAsync(this IBucket bucket, Action<PingOptions> configureOptions)

Parameters

Type	Name	Description
IBucket	bucket
Action<PingOptions>	configureOptions

Returns

Type	Description
Task<IPingReport>

PingAsync(IBucket, ServiceType[])

Declaration

public static Task<IPingReport> PingAsync(this IBucket bucket, params ServiceType[] serviceTypes)

Parameters

Type	Name	Description
IBucket	bucket
ServiceType[]	serviceTypes

Returns

Type	Description
Task<IPingReport>

PingAsync(IBucket, String, ServiceType[])

Declaration

public static Task<IPingReport> PingAsync(this IBucket bucket, string reportId, params ServiceType[] serviceTypes)

Parameters

Type	Name	Description
IBucket	bucket
String	reportId
ServiceType[]	serviceTypes

Returns

Type	Description
Task<IPingReport>

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

Execute a view query.

Declaration

public static Task<IViewResult<TKey, TValue>> ViewQueryAsync<TKey, TValue>(this IBucket bucket, string designDocument, string viewName)

Parameters

Type	Name	Description
IBucket	bucket	IBucket to execute the query against.
String	designDocument	Design document name.
String	viewName	View name.

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.

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

Execute a view query.

Declaration

public static Task<IViewResult<TKey, TValue>> ViewQueryAsync<TKey, TValue>(this IBucket bucket, string designDocument, string viewName, Action<ViewOptions> configureOptions)

Parameters

Type	Name	Description
IBucket	bucket	IBucket to execute the query against.
String	designDocument	Design document name.
String	viewName	View name.
Action<ViewOptions>	configureOptions	Action to configure the 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.