Class: LookupInBuilder

LookupInBuilder

Builder used to create a set of sub-document lookup operations.

<private> new LookupInBuilder()

Since:
  • 2.1.4 (stability: committed)

Methods

execute(callback)

Executes this set of lookup operations on the bucket.

Parameters:
Name Type Description
callback
Since:
  • 2.1.4 (stability: committed)

exists(path)

Similar to get(), but does not actually retrieve the value from the server. This may save bandwidth if you only need to check for the existence of a path (without caring for its content). You can check the status of this operation by using .content (and ignoring the value) or .exists()

Parameters:
Name Type Description
path string
Since:
  • 2.1.4 (stability: committed)

get(path)

Indicate a path to be retrieved from the document. The value of the path can later be retrieved (after .execute()) using the content or contentByIndex method. The path syntax follows N1QL's path syntax (e.g. foo.bar.baz).

Parameters:
Name Type Description
path string
Since:
  • 2.1.4 (stability: committed)