Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
create_query_index_options Class Reference

#include <couchbase/create_query_index_options.hxx>

Inheritance diagram for create_query_index_options:
Inheritance graph

Classes

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

Public Member Functions

auto ignore_if_exists (bool ignore_if_exists) -> create_query_index_options &
 Set flag to ignore error if the index already exists.
 
auto build_deferred (bool deferred) -> create_query_index_options &
 Set flag to defer building of the index.
 
auto num_replicas (uint8_t num_replicas) -> create_query_index_options &
 Set the number of replicas the index will have.
 
auto condition (std::string condition) -> create_query_index_options &
 Supply an extra condition on this index.
 
auto build () const -> built
 Validates options and returns them as an immutable value.
 
- Public Member Functions inherited from common_options< create_query_index_options >
auto timeout (const std::chrono::milliseconds timeout) -> create_query_index_options &
 Specifies a custom per-operation timeout.
 
auto retry_strategy (const std::shared_ptr< retry_strategy > strategy) -> create_query_index_options &
 Specifies a custom couchbase::retry_strategy for this operation.
 

Additional Inherited Members

- Protected Member Functions inherited from common_options< create_query_index_options >
auto build_common_options () const -> built
 
auto self () -> create_query_index_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_errorwith code errc::common::invalid_argument if the options are not valid
Since
1.0.0
Internal
Internal interface

◆ build_deferred()

auto build_deferred ( bool deferred) -> create_query_index_options&
inline

Set flag to defer building of the index.

The default is false, meaning start building the index immediately.

Parameters
deferred
Returns
reference to this object, for use in chaining.
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ condition()

auto condition ( std::string condition) -> create_query_index_options&
inline

Supply an extra condition on this index.

This is the contents of the WHERE clause when creating the index.

Parameters
condition
Returns
reference to this object, for use in chaining.

◆ ignore_if_exists()

auto ignore_if_exists ( bool ignore_if_exists) -> create_query_index_options&
inline

Set flag to ignore error if the index already exists.

The default is to not ignore the error.

Parameters
ignore_if_existsif true, we don't return an error if the index already exists
Returns
reference to this object, for use in chaining.
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ num_replicas()

auto num_replicas ( uint8_t num_replicas) -> create_query_index_options&
inline

Set the number of replicas the index will have.

Parameters
num_replicas
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: