Struct Database

pub struct Database { /* private fields */ }

Database is the client-side abstraction of a MongoDB database. It can be used to perform database-level operations or to obtain handles to specific collections within the database. A Database can only be obtained through a Client by calling either Client::database or Client::database_with_options.

Database uses std::sync::Arc internally, so it can safely be shared across threads or async tasks. For example:

 
let db = client.database("items");

for i in 0..5 {
    let db_ref = db.clone();

    tokio::task::spawn(async move {
        let collection = db_ref.collection::<Document>(&format!("coll{}", i));

        // Do something with the collection
    });
}

Implementations

impl Database

pub fn aggregate( &self, pipeline: impl IntoIterator<Item = Document>, ) -> Aggregate<'_>

Runs an aggregation operation.

See the documentation here for more information on aggregations.

await will return Result<Cursor<Document>>. If a ClientSession was provided, the returned cursor will be a SessionCursor. If with_type was called, the returned cursor will be generic over the T specified.

These methods can be chained before .await to set options:

• with_type
• with_options
• allow_disk_use
• batch_size
• bypass_document_validation
• collation
• comment
• hint
• max_await_time
• max_time
• read_concern
• selection_criteria
• write_concern
• let_vars
• session

impl Database

pub fn create_collection(&self, name: impl Into<String>) -> CreateCollection<'_>

Creates a new collection in the database with the given name.

Note that MongoDB creates collections implicitly when data is inserted, so this method is not needed if no special options are required.

await will return Result<()>.

These methods can be chained before .await to set options:

• session
• with_options
• capped
• size
• max
• storage_engine
• validator
• validation_level
• validation_action
• view_on
• pipeline
• collation
• write_concern
• index_option_defaults
• timeseries
• expire_after_seconds
• change_stream_pre_and_post_images
• clustered_index
• comment
• encrypted_fields

impl Database

pub fn drop(&self) -> DropDatabase<'_>

Drops the database, deleting all data, collections, and indexes stored in it.

await will return Result<()>.

These methods can be chained before .await to set options:

• session
• with_options
• write_concern

impl Database

pub fn list_collections(&self) -> ListCollections<'_>

Gets information about each of the collections in the database.

await will return Result<Cursor<CollectionSpecification>>.

These methods can be chained before .await to set options:

• with_options
• batch_size
• comment
• filter
• authorized_collections
• session

pub fn list_collection_names(&self) -> ListCollections<'_, ListNames>

Gets the names of the collections in the database.

await will return Result<Vec<String>>.

These methods can be chained before .await to set options:

• with_options
• batch_size
• comment
• filter
• authorized_collections
• session

impl Database

pub fn run_command(&self, command: Document) -> RunCommand<'_>

Runs a database-level command.

Note that no inspection is done on doc, so the command will not use the database’s default read concern or write concern. If specific read concern or write concern is desired, it must be specified manually. Please note that run_command doesn’t validate WriteConcerns passed into the body of the command document.

await will return Result<Document>.

These methods can be chained before .await to set options:

• session
• with_options
• selection_criteria

pub fn run_cursor_command(&self, command: Document) -> RunCursorCommand<'_>

Runs a database-level command and returns a cursor to the response.

await will return Result<Cursor<Document>> or a Result<SessionCursor<Document>> if a ClientSession is provided.

These methods can be chained before .await to set options:

• with_options
• selection_criteria
• cursor_type
• batch_size
• max_time
• comment
• session

impl Database

pub fn watch(&self) -> Watch<'_>

Starts a new ChangeStream that receives events for all changes in this database. The stream does not observe changes from system collections and cannot be started on “config”, “local” or “admin” databases.

See the documentation here on change streams.

Change streams require either a “majority” read concern or no read concern. Anything else will cause a server error.

Note that using a $project stage to remove any of the _id, operationType or ns fields will cause an error. The driver requires these fields to support resumability. For more information on resumability, see the documentation for ChangeStream.

If the pipeline alters the structure of the returned events, the parsed type will need to be changed via ChangeStream::with_type.

await will return Result<ChangeStream<ChangeStreamEvent<Document>>> or Result<SessionChangeStream<ChangeStreamEvent<Document>>> if a ClientSession has been provided.

These methods can be chained before .await to set options:

• pipeline
• resume_after
• with_options
• full_document
• full_document_before_change
• start_at_operation_time
• start_after
• max_await_time
• batch_size
• collation
• read_concern
• selection_criteria
• show_expanded_events
• comment
• session

impl Database

pub fn client(&self) -> &Client

Get the Client that this collection descended from.

pub fn name(&self) -> &str

Gets the name of the Database.

pub fn selection_criteria(&self) -> Option<&SelectionCriteria>

Gets the read preference of the Database.

pub fn read_concern(&self) -> Option<&ReadConcern>

Gets the read concern of the Database.

pub fn write_concern(&self) -> Option<&WriteConcern>

Gets the write concern of the Database.

pub fn collection<T: Send + Sync>(&self, name: &str) -> Collection<T>

Gets a handle to a collection in this database with the provided name. The Collection options (e.g. read preference and write concern) will default to those of this Database.

For more information on how the generic parameter T is used, check out the Collection documentation.

This method does not send or receive anything across the wire to the database, so it can be used repeatedly without incurring any costs from I/O.

pub fn collection_with_options<T: Send + Sync>( &self, name: &str, options: CollectionOptions, ) -> Collection<T>

Gets a handle to a collection in this database with the provided name. Operations done with this Collection will use the options specified by options and will otherwise default to those of this Database.

For more information on how the generic parameter T is used, check out the Collection documentation.

This method does not send or receive anything across the wire to the database, so it can be used repeatedly without incurring any costs from I/O.

pub fn gridfs_bucket( &self, options: impl Into<Option<GridFsBucketOptions>>, ) -> GridFsBucket

Creates a new GridFsBucket in the database with the given options.

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Database

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.