Couchbase .NET SDK | 3.7.2
Search Results for

    Show / Hide Table of Contents

    Interface ILookupInBuilder<TDocument>

    Exposes a "builder" API for constructing a chain of read commands on a document within Couchbase.

    Inherited Members
    ISubDocBuilder<TDocument>.Execute()
    ISubDocBuilder<TDocument>.ExecuteAsync()
    ISubDocBuilder<TDocument>.Key
    ISubDocBuilder<TDocument>.Count
    ISubDocBuilder<TDocument>.Timeout
    ITypeSerializerProvider.Serializer
    Namespace: Couchbase.Core.IO.Operations.SubDocument
    Assembly: Couchbase.NetClient.dll
    Syntax
    [Obsolete("This interface is not required and will be removed in a future release.")]
    public interface ILookupInBuilder<TDocument> : ISubDocBuilder<TDocument>, ITypeSerializerProvider
    Type Parameters
    Name Description
    TDocument

    The type of the document.

    Methods

    | Edit this page View Source

    Exists(string)

    Checks for the existence of a given N1QL path.

    Declaration
    ILookupInBuilder<TDocument> Exists(string path)
    Parameters
    Type Name Description
    string path

    The path.

    Returns
    Type Description
    ILookupInBuilder<TDocument>

    A ILookupInBuilder<TDocument> implementation reference for chaining operations.

    | Edit this page View Source

    Exists(string, SubdocPathFlags, SubdocDocFlags)

    Checks for the existence of a given N1QL path.

    Declaration
    ILookupInBuilder<TDocument> Exists(string path, SubdocPathFlags pathFlags, SubdocDocFlags docFlags = SubdocDocFlags.None)
    Parameters
    Type Name Description
    string path

    The path.

    SubdocPathFlags pathFlags

    The lookup flags.

    SubdocDocFlags docFlags

    The document flags.

    Returns
    Type Description
    ILookupInBuilder<TDocument>

    A ILookupInBuilder<TDocument> implementation reference for chaining operations.

    | Edit this page View Source

    Get(string)

    Gets the value at a specified N1QL path.

    Declaration
    ILookupInBuilder<TDocument> Get(string path)
    Parameters
    Type Name Description
    string path

    The path.

    Returns
    Type Description
    ILookupInBuilder<TDocument>

    A ILookupInBuilder<TDocument> implementation reference for chaining operations.

    | Edit this page View Source

    Get(string, SubdocPathFlags, SubdocDocFlags)

    Gets the value at a specified N1QL path.

    Declaration
    ILookupInBuilder<TDocument> Get(string path, SubdocPathFlags pathFlags, SubdocDocFlags docFlags = SubdocDocFlags.None)
    Parameters
    Type Name Description
    string path

    The path.

    SubdocPathFlags pathFlags

    The path flags.

    SubdocDocFlags docFlags

    The document flags.

    Returns
    Type Description
    ILookupInBuilder<TDocument>

    A ILookupInBuilder<TDocument> implementation reference for chaining operations.

    | Edit this page View Source

    GetCount(string)

    Gets the number of items in a collection or dictionary at a specified N1QL path.

    Declaration
    ILookupInBuilder<TDocument> GetCount(string path)
    Parameters
    Type Name Description
    string path

    The path.

    Returns
    Type Description
    ILookupInBuilder<TDocument>

    A ILookupInBuilder<TDocument> implementation reference for chaining operations.

    Remarks

    Requires Couchbase Server 5.0 or higher

    | Edit this page View Source

    GetCount(string, SubdocPathFlags, SubdocDocFlags)

    Gets the number of items in a collection or dictionary at a specified N1QL path.

    Declaration
    ILookupInBuilder<TDocument> GetCount(string path, SubdocPathFlags pathFlags, SubdocDocFlags docFlags = SubdocDocFlags.None)
    Parameters
    Type Name Description
    string path

    The path.

    SubdocPathFlags pathFlags

    The subdocument lookup flags.

    SubdocDocFlags docFlags

    The document flags.

    Returns
    Type Description
    ILookupInBuilder<TDocument>

    A ILookupInBuilder<TDocument> implementation reference for chaining operations.

    Remarks

    Requires Couchbase Server 5.0 or higher

    | Edit this page View Source

    WithTimeout(TimeSpan)

    The maximum time allowed for an operation to live before timing out.

    Declaration
    ILookupInBuilder<TDocument> WithTimeout(TimeSpan timeout)
    Parameters
    Type Name Description
    TimeSpan timeout

    The timeout.

    Returns
    Type Description
    ILookupInBuilder<TDocument>

    An ILookupInBuilder<TDocument> reference for chaining operations.

    • Edit this page
    • View Source
    In this article
    Back to top © 2025 Couchbase, Inc.