Couchbase .NET SDK | 3.7.2
Search Results for

    Show / Hide Table of Contents

    Interface IScope

    Inherited Members
    ISearchRequester.SearchAsync(string, SearchRequest, SearchOptions)
    Namespace: Couchbase.KeyValue
    Assembly: Couchbase.NetClient.dll
    Syntax
    public interface IScope : ISearchRequester
    Remarks

    Volatile

    Properties

    | Edit this page View Source

    Bucket

    The bucket that owns this scope.

    Declaration
    IBucket Bucket { get; }
    Property Value
    Type Description
    IBucket
    | Edit this page View Source

    EventingFunctions

    Gets a management interface for scope-level Eventing Functions.

    Declaration
    IEventingFunctionManager EventingFunctions { get; }
    Property Value
    Type Description
    IEventingFunctionManager
    | Edit this page View Source

    IsDefaultScope

    Returns true if this is the default scope.

    Declaration
    bool IsDefaultScope { get; }
    Property Value
    Type Description
    bool
    | Edit this page View Source

    this[string]

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

    Name

    Declaration
    string Name { get; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    SearchIndexes

    Gets a management interface for scope-level FTS and Vector Search indexes.

    Declaration
    ISearchIndexManager SearchIndexes { get; }
    Property Value
    Type Description
    ISearchIndexManager

    Methods

    | Edit this page 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.

    | Edit this page View Source

    Collection(string)

    Declaration
    ICouchbaseCollection Collection(string collectionName)
    Parameters
    Type Name Description
    string collectionName
    Returns
    Type Description
    ICouchbaseCollection
    | Edit this page View Source

    CollectionAsync(string)

    Declaration
    ValueTask<ICouchbaseCollection> CollectionAsync(string collectionName)
    Parameters
    Type Name Description
    string collectionName
    Returns
    Type Description
    ValueTask<ICouchbaseCollection>
    | Edit this page 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

    ScopeExtensions.AnalyticsQueryAsync<T>(IScope, string, Action<AnalyticsOptions>)
    ScopeExtensions.QueryAsync<T>(IScope, string)
    ScopeExtensions.QueryAsync<T>(IScope, string, Action<QueryOptions>)
    • Edit this page
    • View Source
    In this article
    Back to top © 2025 Couchbase, Inc.