Interface IScope

Namespace: Couchbase.KeyValue
Assembly: Couchbase.NetClient.dll
Syntax
public interface IScope
Remarks

Volatile

Properties

| Improve this Doc View Source

Bucket

The bucket that owns this scope.

Declaration
IBucket Bucket { get; }
Property Value
Type Description
IBucket
| Improve this Doc View Source

IsDefaultScope

Returns true if this is the default scope.

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

Item[String]

Declaration
ICouchbaseCollection this[string name] { get; }
Parameters
Type Name Description
String name
Property Value
Type Description
ICouchbaseCollection
| Improve this Doc View Source

Name

Declaration
string Name { get; }
Property Value
Type Description
String

Methods

| Improve this Doc View Source

AnalyticsQueryAsync<T>(String, AnalyticsOptions)

Scope level analytics querying of collections.

Declaration
Task<IAnalyticsResult<T>> AnalyticsQueryAsync<T>(string statement, AnalyticsOptions options = null)
Parameters
Type Name Description
String statement

The N1QL statement to be executed.
AnalyticsOptions options

Any optional parameters to pass with the query.
Returns
Type Description
Task<IAnalyticsResult<T>>
Type Parameters
Name Description
T

The record type returned by the query.
| 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)

Declaration
ValueTask<ICouchbaseCollection> CollectionAsync(string collectionName)
Parameters
Type Name Description
String collectionName
Returns
Type Description
ValueTask<ICouchbaseCollection>
| Improve this Doc View Source

QueryAsync<T>(String, QueryOptions)

Scope level querying of collections.

Declaration
Task<IQueryResult<T>> QueryAsync<T>(string statement, QueryOptions options = null)
Parameters
Type Name Description
String statement

The N1QL statement to be executed.
QueryOptions options

Any optional parameters to pass with the query.
Returns
Type Description
Task<IQueryResult<T>>
Type Parameters
Name Description
T

The record type returned by the query.

Extension Methods