#include <couchbase/create_primary_query_index_options.hxx>
|
struct | built |
| Immutable value object representing consistent options. More...
|
|
◆ build()
auto build |
( |
| ) |
const -> built
|
|
inlinenodiscard |
Validates options and returns them as an immutable value.
- Returns
- consistent options as an immutable value
- Exceptions
-
- Since
- 1.0.0
- Internal
- Internal interface
◆ build_deferred()
Set flag to defer building of the index.
The default is false, meaning start building the index immediately.
- Parameters
-
- 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()
Set flag to ignore error if the index already exists.
The default is to not ignore the error.
- Parameters
-
ignore_if_exists | if 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
◆ index_name()
Give the primary index a name.
defaults to #primary
- Parameters
-
- Returns
- reference to this object, for use in chaining.
◆ num_replicas()
Set the number of replicas the index will have.
- Parameters
-
- 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: