MongoDB C++ Driver 4.1.0
|
#include <mongocxx/v_noabi/mongocxx/options/index.hpp>
Used by MongoDB index creation operations.
Classes | |
class | base_storage_options |
Base class representing the optional storage engine options for indexes. More... | |
class | wiredtiger_storage_options |
The optional WiredTiger storage engine options for indexes. More... | |
Public Member Functions | |
bsoncxx::v_noabi::stdx::optional< bool > const & | background () const |
The current background setting. | |
index & | background (bool background) |
Whether or not to build the index in the background so that building the index does not block other database activities. The default is to build indexes in the foreground. | |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view > const & | collation () const |
Retrieves the current collation for this index. | |
index & | collation (bsoncxx::v_noabi::document::view collation) |
Sets the collation for this index. | |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::string::view_or_value > const & | default_language () const |
The current default_language setting. | |
index & | default_language (bsoncxx::v_noabi::string::view_or_value default_language) |
For text indexes, the language that determines the list of stop words and the rules for the stemmer and tokenizer. | |
bsoncxx::v_noabi::stdx::optional< std::chrono::seconds > const & | expire_after () const |
The current expire_after setting. | |
index & | expire_after (std::chrono::seconds seconds) |
Set a value, in seconds, as a TTL to control how long MongoDB retains documents in this collection. | |
bsoncxx::v_noabi::stdx::optional< double > const & | haystack_bucket_size () const |
The current haystack_bucket_size setting. | |
index & | haystack_bucket_size (double haystack_bucket_size) |
For geoHaystack indexes, specify the number of units within which to group the location values; i.e. group in the same bucket those location values that are within the specified number of units to each other. | |
bsoncxx::v_noabi::stdx::optional< bool > const & | hidden () const |
The current hidden setting. | |
index & | hidden (bool hidden) |
Whether or not the index is hidden from the query planner. A hidden index is not evaluated as part of query plan selection. | |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::string::view_or_value > const & | language_override () const |
The current name of the field that contains the override language for text indexes. | |
index & | language_override (bsoncxx::v_noabi::string::view_or_value language_override) |
For text indexes, the name of the field, in the collection’s documents, that contains the override language for the document. | |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::string::view_or_value > const & | name () const |
The current name setting. | |
index & | name (bsoncxx::v_noabi::string::view_or_value name) |
The name of the index. | |
operator bsoncxx::v_noabi::document::view_or_value () | |
Conversion operator that provides a view of the options in document form. | |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view > const & | partial_filter_expression () const |
The current partial_filter_expression setting. | |
index & | partial_filter_expression (bsoncxx::v_noabi::document::view partial_filter_expression) |
Sets the document for the partial filter expression for partial indexes. | |
bsoncxx::v_noabi::stdx::optional< bool > const & | sparse () const |
The current sparse setting. | |
index & | sparse (bool sparse) |
Whether or not to create a sparse index. Sparse indexes only reference documents with the indexed fields. | |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view > const & | storage_engine () const |
The current storage engine options. | |
index & | storage_engine (bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view > storage_engine) |
Specifies the storage engine options for the index. | |
index & | storage_options (std::unique_ptr< base_storage_options > storage_options) |
Specifies the storage engine options for the index. | |
index & | storage_options (std::unique_ptr< wiredtiger_storage_options > storage_options) |
Specifies the WiredTiger-specific storage engine options for the index. | |
bsoncxx::v_noabi::stdx::optional< std::uint8_t > const & | twod_bits_precision () const |
The current precision of the stored geohash value of the location data. | |
index & | twod_bits_precision (std::uint8_t twod_bits_precision) |
For 2d indexes, the precision of the stored geohash value of the location data. | |
bsoncxx::v_noabi::stdx::optional< double > const & | twod_location_max () const |
The current upper inclusive boundary for the longitude and latitude values. | |
index & | twod_location_max (double twod_location_max) |
For 2d indexes, the upper inclusive boundary for the longitude and latitude values. | |
bsoncxx::v_noabi::stdx::optional< double > const & | twod_location_min () const |
The current lower inclusive boundary for the longitude and latitude values. | |
index & | twod_location_min (double twod_location_min) |
For 2d indexes, the lower inclusive boundary for the longitude and latitude values. | |
bsoncxx::v_noabi::stdx::optional< std::uint8_t > const & | twod_sphere_version () const |
The current twod_sphere_version setting. | |
index & | twod_sphere_version (std::uint8_t twod_sphere_version) |
For 2dsphere indexes, the 2dsphere index version number. Version can be either 1 or 2. | |
bsoncxx::v_noabi::stdx::optional< bool > const & | unique () const |
The current unique setting. | |
index & | unique (bool unique) |
Whether or not to create a unique index so that the collection will not accept insertion of documents where the index key or keys match an existing value in the index. | |
bsoncxx::v_noabi::stdx::optional< std::int32_t > const & | version () const |
The current index version. | |
index & | version (std::int32_t v) |
Sets the index version. | |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view > const & | weights () const |
The current weights setting. | |
index & | weights (bsoncxx::v_noabi::document::view weights) |
For text indexes, sets the weight document. The weight document contains field and weight pairs. | |
bsoncxx::v_noabi::stdx::optional< bool > const & mongocxx::v_noabi::options::index::background | ( | ) | const |
The current background setting.
index & mongocxx::v_noabi::options::index::background | ( | bool | background | ) |
Whether or not to build the index in the background so that building the index does not block other database activities. The default is to build indexes in the foreground.
background | Whether or not to build the index in the background. |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view > const & mongocxx::v_noabi::options::index::collation | ( | ) | const |
Retrieves the current collation for this index.
index & mongocxx::v_noabi::options::index::collation | ( | bsoncxx::v_noabi::document::view | collation | ) |
Sets the collation for this index.
collation | The new collation. |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::string::view_or_value > const & mongocxx::v_noabi::options::index::default_language | ( | ) | const |
The current default_language setting.
index & mongocxx::v_noabi::options::index::default_language | ( | bsoncxx::v_noabi::string::view_or_value | default_language | ) |
For text indexes, the language that determines the list of stop words and the rules for the stemmer and tokenizer.
default_language | The default language used when creating text indexes. |
bsoncxx::v_noabi::stdx::optional< std::chrono::seconds > const & mongocxx::v_noabi::options::index::expire_after | ( | ) | const |
The current expire_after setting.
index & mongocxx::v_noabi::options::index::expire_after | ( | std::chrono::seconds | seconds | ) |
Set a value, in seconds, as a TTL to control how long MongoDB retains documents in this collection.
seconds | The amount of time, in seconds, to retain documents. |
bsoncxx::v_noabi::stdx::optional< double > const & mongocxx::v_noabi::options::index::haystack_bucket_size | ( | ) | const |
The current haystack_bucket_size setting.
index & mongocxx::v_noabi::options::index::haystack_bucket_size | ( | double | haystack_bucket_size | ) |
For geoHaystack indexes, specify the number of units within which to group the location values; i.e. group in the same bucket those location values that are within the specified number of units to each other.
haystack_bucket_size | The geoHaystack bucket size. |
bsoncxx::v_noabi::stdx::optional< bool > const & mongocxx::v_noabi::options::index::hidden | ( | ) | const |
The current hidden setting.
index & mongocxx::v_noabi::options::index::hidden | ( | bool | hidden | ) |
Whether or not the index is hidden from the query planner. A hidden index is not evaluated as part of query plan selection.
hidden | Whether or not to create a hidden index. |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::string::view_or_value > const & mongocxx::v_noabi::options::index::language_override | ( | ) | const |
The current name of the field that contains the override language for text indexes.
index & mongocxx::v_noabi::options::index::language_override | ( | bsoncxx::v_noabi::string::view_or_value | language_override | ) |
For text indexes, the name of the field, in the collection’s documents, that contains the override language for the document.
language_override | The name of the field that contains the override language for text indexes. |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::string::view_or_value > const & mongocxx::v_noabi::options::index::name | ( | ) | const |
The current name setting.
index & mongocxx::v_noabi::options::index::name | ( | bsoncxx::v_noabi::string::view_or_value | name | ) |
The name of the index.
name | The name of the index. |
mongocxx::v_noabi::options::index::operator bsoncxx::v_noabi::document::view_or_value | ( | ) |
Conversion operator that provides a view of the options in document form.
mongocxx::v_noabi::logic_error | if an invalid expireAfterSeconds field is provided. |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view > const & mongocxx::v_noabi::options::index::partial_filter_expression | ( | ) | const |
The current partial_filter_expression setting.
index & mongocxx::v_noabi::options::index::partial_filter_expression | ( | bsoncxx::v_noabi::document::view | partial_filter_expression | ) |
Sets the document for the partial filter expression for partial indexes.
partial_filter_expression | The partial filter expression document. |
bsoncxx::v_noabi::stdx::optional< bool > const & mongocxx::v_noabi::options::index::sparse | ( | ) | const |
The current sparse setting.
index & mongocxx::v_noabi::options::index::sparse | ( | bool | sparse | ) |
Whether or not to create a sparse index. Sparse indexes only reference documents with the indexed fields.
sparse | Whether or not to create a sparse index. |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view > const & mongocxx::v_noabi::options::index::storage_engine | ( | ) | const |
The current storage engine options.
index & mongocxx::v_noabi::options::index::storage_engine | ( | bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view > | storage_engine | ) |
Specifies the storage engine options for the index.
storage_options
when set.The document must have the form { <storage-engine-name>: <options> }
, e.g.:
storage_engine | The storage engine options for the index. |
index & mongocxx::v_noabi::options::index::storage_options | ( | std::unique_ptr< base_storage_options > | storage_options | ) |
Specifies the storage engine options for the index.
storage_engine
when set.storage_options | The storage engine options for the index. |
index & mongocxx::v_noabi::options::index::storage_options | ( | std::unique_ptr< wiredtiger_storage_options > | storage_options | ) |
Specifies the WiredTiger-specific storage engine options for the index.
storage_engine
when set.storage_options | The storage engine options for the index. |
bsoncxx::v_noabi::stdx::optional< std::uint8_t > const & mongocxx::v_noabi::options::index::twod_bits_precision | ( | ) | const |
The current precision of the stored geohash value of the location data.
index & mongocxx::v_noabi::options::index::twod_bits_precision | ( | std::uint8_t | twod_bits_precision | ) |
For 2d indexes, the precision of the stored geohash value of the location data.
twod_bits_precision | The precision of the stored geohash value. |
bsoncxx::v_noabi::stdx::optional< double > const & mongocxx::v_noabi::options::index::twod_location_max | ( | ) | const |
The current upper inclusive boundary for the longitude and latitude values.
index & mongocxx::v_noabi::options::index::twod_location_max | ( | double | twod_location_max | ) |
For 2d indexes, the upper inclusive boundary for the longitude and latitude values.
twod_location_max | The upper inclusive boundary. |
bsoncxx::v_noabi::stdx::optional< double > const & mongocxx::v_noabi::options::index::twod_location_min | ( | ) | const |
The current lower inclusive boundary for the longitude and latitude values.
index & mongocxx::v_noabi::options::index::twod_location_min | ( | double | twod_location_min | ) |
For 2d indexes, the lower inclusive boundary for the longitude and latitude values.
twod_location_min | The lower inclusive boundary. |
bsoncxx::v_noabi::stdx::optional< std::uint8_t > const & mongocxx::v_noabi::options::index::twod_sphere_version | ( | ) | const |
The current twod_sphere_version setting.
index & mongocxx::v_noabi::options::index::twod_sphere_version | ( | std::uint8_t | twod_sphere_version | ) |
For 2dsphere indexes, the 2dsphere index version number. Version can be either 1 or 2.
twod_sphere_version | The 2dsphere index version number. |
bsoncxx::v_noabi::stdx::optional< bool > const & mongocxx::v_noabi::options::index::unique | ( | ) | const |
The current unique setting.
index & mongocxx::v_noabi::options::index::unique | ( | bool | unique | ) |
Whether or not to create a unique index so that the collection will not accept insertion of documents where the index key or keys match an existing value in the index.
unique | Whether or not to create a unique index. |
bsoncxx::v_noabi::stdx::optional< std::int32_t > const & mongocxx::v_noabi::options::index::version | ( | ) | const |
The current index version.
index & mongocxx::v_noabi::options::index::version | ( | std::int32_t | v | ) |
Sets the index version.
v | The index version. |
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view > const & mongocxx::v_noabi::options::index::weights | ( | ) | const |
The current weights setting.
index & mongocxx::v_noabi::options::index::weights | ( | bsoncxx::v_noabi::document::view | weights | ) |
For text indexes, sets the weight document. The weight document contains field and weight pairs.
weights | The weight document for text indexes. |