56 std::map<std::string, codec::binary, std::less<>>
raw;
80 positional_parameters_,
98 priority_ = prioritized;
162 client_context_id_.reset();
194 mutation_state_.clear();
220 mutation_state_ = state.tokens();
221 scan_consistency_.reset();
235 template<
typename Value>
252 template<
typename... Parameters>
255 named_parameters_.clear();
256 positional_parameters_.clear();
257 encode_positional_parameters(parameters...);
271 template<
typename... Parameters>
274 named_parameters_.clear();
275 positional_parameters_.clear();
276 encode_named_parameters(parameters...);
297 raw_ = std::move(options);
318 named_parameters_.clear();
319 positional_parameters_ = std::move(parameters);
340 named_parameters_ = std::move(parameters);
341 positional_parameters_.clear();
346 template<
typename Parameter,
typename... Rest>
347 void encode_positional_parameters(
const Parameter& parameter, Rest... args)
349 positional_parameters_.emplace_back(
351 if constexpr (
sizeof...(args) > 0) {
352 encode_positional_parameters(args...);
356 template<
typename Name,
typename Parameter,
typename... Rest>
357 void encode_named_parameters(
const std::pair<Name, Parameter>& parameter, Rest... args)
359 named_parameters_[parameter.first] =
361 if constexpr (
sizeof...(args) > 0) {
362 encode_named_parameters(args...);
366 bool priority_{
true };
367 bool readonly_{
false };
368 std::optional<std::string> client_context_id_{};
369 std::optional<std::chrono::milliseconds> scan_wait_{};
370 std::optional<analytics_scan_consistency> scan_consistency_{};
371 std::vector<mutation_token> mutation_state_{};
372 std::vector<codec::binary> positional_parameters_{};
373 std::map<std::string, codec::binary, std::less<>> raw_{};
374 std::map<std::string, codec::binary, std::less<>> named_parameters_{};
Represents result of cluster::analytics_query() and scope::analytics_query() calls.
Definition analytics_result.hxx:38
static auto serialize(Document document) -> binary
Definition tao_json_serializer.hxx:47
Common options that used by most operations.
Definition common_options.hxx:37
auto self() -> analytics_options &
Allows to return the right options builder instance for child implementations.
Definition common_options.hxx:102
auto build_common_options() const -> built
Definition common_options.hxx:89
Aggregation of one or more mutation_tokens for specifying consistency requirements of N1QL or FTS que...
Definition mutation_state.hxx:35
std::vector< std::byte > binary
Definition encoded_value.hxx:25
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
analytics_scan_consistency
Definition analytics_scan_consistency.hxx:22
@ not_bounded
The indexer will return whatever state it has to the query engine at the time of query.
std::function< void(error, analytics_result)> analytics_handler
The signature for the handler of the cluster::analytics_query() and scope::analytics_query() operatio...
Definition analytics_options.hxx:384
Immutable value object representing consistent options.
Definition analytics_options.hxx:47
std::vector< mutation_token > mutation_state
Definition analytics_options.hxx:53
std::map< std::string, codec::binary, std::less<> > named_parameters
Definition analytics_options.hxx:55
const bool priority
Definition analytics_options.hxx:49
const bool readonly
Definition analytics_options.hxx:50
std::optional< std::chrono::milliseconds > scan_wait
Definition analytics_options.hxx:52
std::map< std::string, codec::binary, std::less<> > raw
Definition analytics_options.hxx:56
std::optional< std::string > client_context_id
Definition analytics_options.hxx:48
std::optional< analytics_scan_consistency > scan_consistency
Definition analytics_options.hxx:51
std::vector< codec::binary > positional_parameters
Definition analytics_options.hxx:54
Options for cluster::analytics_query() and scope::analytics_query().
Definition analytics_options.hxx:40
auto client_context_id(std::string client_context_id) -> analytics_options &
Supports providing a custom client context ID for this query.
Definition analytics_options.hxx:159
auto raw(std::string name, const Value &value) -> analytics_options &
Definition analytics_options.hxx:236
auto scan_consistency(analytics_scan_consistency scan_consistency) -> analytics_options &
Customizes the consistency guarantees for this query.
Definition analytics_options.hxx:191
auto encoded_raw_options(std::map< std::string, codec::binary, std::less<> > options) -> analytics_options &
Set map of raw options for a query.
Definition analytics_options.hxx:294
auto named_parameters(const Parameters &... parameters) -> analytics_options &
Set list of named parameters for a query.
Definition analytics_options.hxx:272
auto encoded_positional_parameters(std::vector< codec::binary > parameters) -> analytics_options &
Set list of positional parameters for a query.
Definition analytics_options.hxx:316
auto readonly(bool readonly) -> analytics_options &
Allows explicitly marking a query as being readonly and not mutating and documents on the server side...
Definition analytics_options.hxx:118
auto scan_wait(std::chrono::milliseconds wait) -> analytics_options &
Allows customizing how long the query engine is willing to wait until the index catches up to whateve...
Definition analytics_options.hxx:137
auto priority(bool prioritized) -> analytics_options &
Allows to give certain requests higher priority than others.
Definition analytics_options.hxx:96
auto build() const -> built
Validates options and returns them as an immutable value.
Definition analytics_options.hxx:70
auto positional_parameters(const Parameters &... parameters) -> analytics_options &
Set list of positional parameters for a query.
Definition analytics_options.hxx:253
auto consistent_with(const mutation_state &state) -> analytics_options &
Sets the mutation_tokens this query should be consistent with.
Definition analytics_options.hxx:218
auto encoded_named_parameters(std::map< std::string, codec::binary, std::less<> > parameters) -> analytics_options &
Set map of named parameters for a query.
Definition analytics_options.hxx:337