Module mongodb::options [−][src]
Contains all of the types needed to specify options to MongoDB operations.
Most of the options structs in this module use the
typed-builder
crate to derive a type-safe builder
API on them. For example, to create an instance of
FindOptions
with only limit
and batch_size
set, the builder
API can be used as follows:
Structs
AggregateOptions | Specifies the options to a |
ClientOptions | Contains the options that can be used to create a new |
Collation | A collation configuration. See the official MongoDB documentation for more information on each of the fields. |
CollectionOptions | These are the valid options for creating a |
CountOptions | Specifies the options to a
|
CreateCollectionOptions | These are the valid options for creating a collection with
|
Credential | A struct containing authentication information. |
DatabaseOptions | These are the valid options for creating a |
DeleteOptions | Specifies the options to a
|
DistinctOptions | Specifies the options to a |
DriverInfo | Extra information to append to the driver version in the metadata of the handshake with the server. This should be used by libraries wrapping the driver, e.g. ODMs. |
DropCollectionOptions | Specifies the options to a |
DropDatabaseOptions | Specifies the options to a |
EstimatedDocumentCountOptions | Specifies the options to a
|
FindOneAndDeleteOptions | Specifies the options to a
|
FindOneAndReplaceOptions | Specifies the options to a
|
FindOneAndUpdateOptions | Specifies the options to a
|
FindOneOptions | Specifies the options to a |
FindOptions | Specifies the options to a |
HedgedReadOptions | Specifies hedging behavior for reads. |
IndexOptionDefaults | Specifies default configuration for indexes created on a collection, including the _id index. |
InsertManyOptions | Specifies the options to a
|
InsertOneOptions | Specifies the options to a
|
ListCollectionsOptions | Specifies the options to a
|
ListDatabasesOptions | Specifies the options to a
|
ReadConcern | Specifies the consistency and isolation properties of read operations from replica sets and replica set shards. |
ReadPreferenceOptions | Specifies read preference options for non-primary read preferences. |
ReplaceOptions | Specifies the options to a
|
ResolverConfig | Configuration for the upstream nameservers to use for resolution |
StreamAddress | A hostname:port address pair. |
TlsOptions | Specifies the TLS configuration that the |
UpdateOptions | Specifies the options to a
|
WriteConcern | Specifies the level of acknowledgement requested from the server for write operations. |
Enums
Acknowledgment | The type of the |
AuthMechanism | The authentication mechanisms supported by MongoDB. |
CursorType | Specifies the type of cursor to return from a find operation. |
Hint | Specifies the index to use for an operation. |
ReadConcernLevel | Specifies the level consistency and isolation properties of a given |
ReadPreference | Specifies how the driver should route a read operation to members of a replica set. |
ReturnDocument | Specifies whether a
|
SelectionCriteria | Describes which servers are suitable for a given operation. |
Tls | Specifies whether TLS configuration should be used with the operations that the
|
UpdateModifications | Enum modeling the modifications to apply during an update. For details, see the official MongoDB documentation |
ValidationAction | Specifies whether the database should return an error or simply raise a warning if inserted documents do not pass the validation. |
ValidationLevel | Specifies how strictly the database should apply validation rules to existing documents during an update. |
Type Definitions
Predicate | A predicate used to filter servers that are considered suitable. |
TagSet | A read preference tag set. See the documentation here for more details. |