[−][src]Struct mongodb::Database
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(); task::spawn(async move { let collection = db_ref.collection(&format!("coll{}", i)); // Do something with the collection }); }
Implementations
impl Database
[src]
pub fn name(&self) -> &str
[src]
Gets the name of the Database
.
pub fn selection_criteria(&self) -> Option<&SelectionCriteria>
[src]
Gets the read preference of the Database
.
pub fn read_concern(&self) -> Option<&ReadConcern>
[src]
Gets the read concern of the Database
.
pub fn write_concern(&self) -> Option<&WriteConcern>
[src]
Gets the write concern of the Database
.
pub fn collection(&self, name: &str) -> Collection
[src]
Gets a handle to a collection specified by name
of the database. The Collection
options
(e.g. read preference and write concern) will default to those of the Database
.
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(
&self,
name: &str,
options: CollectionOptions
) -> Collection
[src]
&self,
name: &str,
options: CollectionOptions
) -> Collection
Gets a handle to a collection specified by name
in the cluster the Client
is connected
to. Operations done with this Collection
will use the options specified by options
by
default and will otherwise default to those of the Database
.
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 async fn drop<'_>(
&'_ self,
options: impl Into<Option<DropDatabaseOptions>>
) -> Result<()>
[src]
&'_ self,
options: impl Into<Option<DropDatabaseOptions>>
) -> Result<()>
Drops the database, deleting all data, collections, users, and indexes stored in it.
pub async fn list_collections<'_>(
&'_ self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<ListCollectionsOptions>>
) -> Result<Cursor>
[src]
&'_ self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<ListCollectionsOptions>>
) -> Result<Cursor>
Gets information about each of the collections in the database. The cursor will yield a document pertaining to each collection in the database.
pub async fn list_collection_names<'_>(
&'_ self,
filter: impl Into<Option<Document>>
) -> Result<Vec<String>>
[src]
&'_ self,
filter: impl Into<Option<Document>>
) -> Result<Vec<String>>
Gets the names of the collections in the database.
pub async fn create_collection<'_, '_>(
&'_ self,
name: &'_ str,
options: impl Into<Option<CreateCollectionOptions>>
) -> Result<()>
[src]
&'_ self,
name: &'_ str,
options: impl Into<Option<CreateCollectionOptions>>
) -> Result<()>
Creates a new collection in the database with the given name
and options
.
Note that MongoDB creates collections implicitly when data is inserted, so this method is not needed if no special options are required.
pub async fn run_command<'_>(
&'_ self,
command: Document,
selection_criteria: impl Into<Option<SelectionCriteria>>
) -> Result<Document>
[src]
&'_ self,
command: Document,
selection_criteria: impl Into<Option<SelectionCriteria>>
) -> Result<Document>
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.
pub async fn aggregate<'_>(
&'_ self,
pipeline: impl IntoIterator<Item = Document>,
options: impl Into<Option<AggregateOptions>>
) -> Result<Cursor>
[src]
&'_ self,
pipeline: impl IntoIterator<Item = Document>,
options: impl Into<Option<AggregateOptions>>
) -> Result<Cursor>
Runs an aggregation operation.
See the documentation here for more information on aggregations.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Database
impl Send for Database
impl Sync for Database
impl Unpin for Database
impl !UnwindSafe for Database
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,