create_dataset_analytics_options Class Reference

#include <couchbase/create_dataset_analytics_options.hxx>

Inheritance diagram for create_dataset_analytics_options:

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

Public Member Functions
auto	ignore_if_exists (bool ignore_if_exists) -> create_dataset_analytics_options &
	Ignore error if the dataset already exists.
auto	condition (std::string condition) -> create_dataset_analytics_options &
	WHERE clause to use for creating the dataset.
auto	dataverse_name (std::string dataverse_name) -> create_dataset_analytics_options &
	The name of the dataverse the dataset should be created into.
auto	build () const -> built
	Validates options and returns them as an immutable value.
Public Member Functions inherited from common_options< create_dataset_analytics_options >
auto	timeout (const std::chrono::milliseconds timeout) -> create_dataset_analytics_options &
	Specifies a custom per-operation timeout.
auto	retry_strategy (const std::shared_ptr< retry_strategy > strategy) -> create_dataset_analytics_options &
	Specifies a custom couchbase::retry_strategy for this operation.
auto	parent_span (std::shared_ptr< tracing::request_span > span) -> create_dataset_analytics_options &

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

Member Function Documentation

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

condition()

auto condition ( std::string condition ) -> create_dataset_analytics_options &

inline

WHERE clause to use for creating the dataset.

The value is an arbitrary SQL++ predicate and is embedded in the generated statement verbatim. Unlike the dataverse, dataset and bucket names, it is not quoted or escaped, because there is no encoding that would leave a predicate meaningful. Pass only expressions the application itself controls; interpolating unvalidated input here allows arbitrary SQL++ to be injected.

Parameters

condition

SQL++ predicate expression, e.g. type = "airline"

Returns

reference to this object, for use in chaining

Since

1.0.0

Committed

Generally available API and should be preferred in production

dataverse_name()

auto dataverse_name ( std::string dataverse_name ) -> create_dataset_analytics_options &

inline

The name of the dataverse the dataset should be created into.

Parameters

dataverse_name

Returns

reference to this object, for use in chaining

Since

1.0.0

Committed

Generally available API and should be preferred in production

ignore_if_exists()

auto ignore_if_exists ( bool ignore_if_exists ) -> create_dataset_analytics_options &

inline

Ignore error if the dataset already exists.

defaults to false

Parameters

ignore_if_exists

Returns

reference to this object, for use in chaining

Since

1.0.0

Committed

Generally available API and should be preferred in production

---

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

• couchbase/create_dataset_analytics_options.hxx