Class LookupInSpecBuilder

A builder for chaining together lookup specs into a JSON document.

Inheritance

object

LookupInSpecBuilder

LookupInSpecBuilder<TDocument>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.KeyValue

Assembly: Couchbase.NetClient.dll

Syntax

public class LookupInSpecBuilder

Methods

Count(string, bool)

Provides a count of a dictionary or list attribute given a JSON path.

Declaration

public LookupInSpecBuilder Count(string path, bool isXattr = false)

Parameters

Type	Name	Description
string	path	The path to the JSON attribute.
bool	isXattr	true if the path is an xAttr; otherwise false.

Returns

Type	Description
LookupInSpecBuilder	A LookupInSpecBuilder for chaining specs.

Exists(string, bool)

Checks for the existence of a value given a path.

Declaration

public LookupInSpecBuilder Exists(string path, bool isXattr = false)

Parameters

Type	Name	Description
string	path	The path to the JSON attribute.
bool	isXattr	true if the path is an xAttr; otherwise false.

Returns

Type	Description
LookupInSpecBuilder	A LookupInSpecBuilder for chaining specs.

Get(string, bool)

Fetches the value of an attribute for a given path.

Declaration

public LookupInSpecBuilder Get(string path, bool isXattr = false)

Parameters

Type	Name	Description
string	path	The path to the JSON attribute.
bool	isXattr	true if the path is an xAttr; otherwise false.

Returns

Type	Description
LookupInSpecBuilder	A LookupInSpecBuilder for chaining specs.

GetFull()

Fetches the entire JSON document for a key.

Declaration

public LookupInSpecBuilder GetFull()

Returns

Type	Description
LookupInSpecBuilder	A LookupInSpecBuilder for chaining specs.