lookup_in_options Struct Reference

Options for collection::lookup_in(). More...

#include <couchbase/lookup_in_options.hxx>

Inheritance diagram for lookup_in_options:

Classes
struct	built
	Immutable value object representing consistent options. More...

Public Member Functions
auto	build () const -> built
	Validates options and returns them as an immutable value.
auto	access_deleted (bool value) -> lookup_in_options &
	For internal use only: allows access to deleted documents that are in 'tombstone' form.
Public Member Functions inherited from common_durability_options< lookup_in_options >
auto	durability (durability_level level) -> lookup_in_options &
	Allows to customize the enhanced durability requirements for this operation.
auto	durability (persist_to persist_to_nodes, replicate_to replicate_to_nodes) -> lookup_in_options &
	Allows to customize the poll-based durability requirements for this operation.
Public Member Functions inherited from common_options< lookup_in_options >
auto	timeout (const std::chrono::milliseconds timeout) -> lookup_in_options &
	Specifies a custom per-operation timeout.
auto	retry_strategy (const std::shared_ptr< retry_strategy > strategy) -> lookup_in_options &
	Specifies a custom couchbase::retry_strategy for this operation.
auto	parent_span (std::shared_ptr< tracing::request_span > span) -> lookup_in_options &

Additional Inherited Members
Protected Member Functions inherited from common_durability_options< lookup_in_options >
auto	build_common_durability_options () const -> built
Protected Member Functions inherited from common_options< lookup_in_options >
auto	build_common_options () const -> built
auto	self () -> lookup_in_options &
	Allows to return the right options builder instance for child implementations.

Detailed Description

Options for collection::lookup_in().

Since

1.0.0

Committed

Generally available API and should be preferred in production

Member Function Documentation

access_deleted()

auto access_deleted ( bool value ) -> lookup_in_options&

inline

For internal use only: allows access to deleted documents that are in 'tombstone' form.

Since

1.0.0

Internal

Internal interface

build()

auto build ( ) const -> built

inlinenodiscard

Validates options and returns them as an immutable value.

Returns

consistent options as an immutable value

Exceptions

std::system_error

with code errc::common::invalid_argument if the options are not valid

Since

1.0.0

Internal

Internal interface

---

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

• couchbase/lookup_in_options.hxx