Couchbase Transactions C++ Client  1.0.0
Transactions client for couchbase
Public Member Functions | Static Public Member Functions | List of all members
couchbase::lookup_in_spec Class Reference

Specify specific elements in a document to look up. More...

#include <lookup_in_spec.hxx>

Public Member Functions

lookup_in_specxattr ()
 

Static Public Member Functions

static lookup_in_spec get (const std::string &path)
 
static lookup_in_spec fulldoc_get ()
 

Detailed Description

Specify specific elements in a document to look up.

Used in collection::lookup_in, you can specify a specific path within a document to return. See collection::lookup_in.

Member Function Documentation

◆ fulldoc_get()

static lookup_in_spec couchbase::lookup_in_spec::fulldoc_get ( )
inlinestatic

Get entire doc.

Returns
A new lookup_in_spec.

◆ get()

static lookup_in_spec couchbase::lookup_in_spec::get ( const std::string &  path)
inlinestatic

Get everything at a specific path.

Parameters
pathThe dot-separated path you are interested in.
Returns
A new lookup_in_spec.

◆ xattr()

lookup_in_spec& couchbase::lookup_in_spec::xattr ( )

Specify the lookup is on xattrs, rather than the document body.

Returns
Reference to the spec, so you can chain the calls.

The documentation for this class was generated from the following file: