Interface ILookupInBuilder<TDocument>
Exposes a "builder" API for constructing a chain of read commands on a document within Couchbase.
Inherited Members
Namespace: Couchbase.Core.IO.Operations.SubDocument
Assembly: Couchbase.NetClient.dll
Syntax
public interface ILookupInBuilder<TDocument> : ISubDocBuilder<TDocument>, ITypeSerializerProvider
Type Parameters
Name | Description |
---|---|
TDocument | The type of the document. |
Methods
| Improve this Doc View SourceExists(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. |
Exists(String, SubdocPathFlags, SubdocDocFlags)
Checks for the existence of a given N1QL path.
Declaration
ILookupInBuilder<TDocument> Exists(string path, SubdocPathFlags pathFlags, SubdocDocFlags docFlags = default(SubdocDocFlags))
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. |
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. |
Get(String, SubdocPathFlags, SubdocDocFlags)
Gets the value at a specified N1QL path.
Declaration
ILookupInBuilder<TDocument> Get(string path, SubdocPathFlags pathFlags, SubdocDocFlags docFlags = default(SubdocDocFlags))
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. |
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
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 = default(SubdocDocFlags))
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
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. |