1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
use std::fmt::Debug;
use super::{ChangeStream, ClientSession, Collection, Cursor, SessionChangeStream, SessionCursor};
use crate::{
bson::Document,
change_stream::{event::ChangeStreamEvent, options::ChangeStreamOptions},
error::Result,
options::{
AggregateOptions,
CollectionOptions,
CreateCollectionOptions,
DropDatabaseOptions,
ListCollectionsOptions,
ReadConcern,
SelectionCriteria,
WriteConcern,
},
results::CollectionSpecification,
runtime,
Database as AsyncDatabase,
};
/// `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`](struct.Client.html) by calling either
/// [`Client::database`](struct.Client.html#method.database) or
/// [`Client::database_with_options`](struct.Client.html#method.database_with_options).
///
/// `Database` uses [`std::sync::Arc`](https://doc.rust-lang.org/std/sync/struct.Arc.html) internally,
/// so it can safely be shared across threads. For example:
///
/// ```rust
/// # use mongodb::{bson::Document, sync::Client, error::Result};
///
/// # fn start_workers() -> Result<()> {
/// # let client = Client::with_uri_str("mongodb://example.com")?;
/// let db = client.database("items");
///
/// for i in 0..5 {
/// let db_ref = db.clone();
///
/// std::thread::spawn(move || {
/// let collection = db_ref.collection::<Document>(&format!("coll{}", i));
///
/// // Do something with the collection
/// });
/// }
/// #
/// # // Technically we should join the threads here, but for the purpose of the example, we'll just
/// # // sleep for a bit.
/// # std::thread::sleep(std::time::Duration::from_secs(3));
/// # Ok(())
/// # }
/// ```
#[derive(Debug, Clone)]
pub struct Database {
async_database: AsyncDatabase,
}
impl Database {
pub(crate) fn new(async_database: AsyncDatabase) -> Self {
Self { async_database }
}
/// Gets the name of the `Database`.
pub fn name(&self) -> &str {
self.async_database.name()
}
/// Gets the read preference of the `Database`.
pub fn selection_criteria(&self) -> Option<&SelectionCriteria> {
self.async_database.selection_criteria()
}
/// Gets the read concern of the `Database`.
pub fn read_concern(&self) -> Option<&ReadConcern> {
self.async_database.read_concern()
}
/// Gets the write concern of the `Database`.
pub fn write_concern(&self) -> Option<&WriteConcern> {
self.async_database.write_concern()
}
/// Gets a handle to a collection with type `T` 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<T>(&self, name: &str) -> Collection<T> {
Collection::new(self.async_database.collection(name))
}
/// Gets a handle to a collection with type `T` 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 fn collection_with_options<T>(
&self,
name: &str,
options: CollectionOptions,
) -> Collection<T> {
Collection::new(self.async_database.collection_with_options(name, options))
}
/// Drops the database, deleting all data, collections, users, and indexes stored in it.
pub fn drop(&self, options: impl Into<Option<DropDatabaseOptions>>) -> Result<()> {
runtime::block_on(self.async_database.drop(options.into()))
}
/// Drops the database, deleting all data, collections, users, and indexes stored in it using
/// the provided `ClientSession`.
pub fn drop_with_session(
&self,
options: impl Into<Option<DropDatabaseOptions>>,
session: &mut ClientSession,
) -> Result<()> {
runtime::block_on(
self.async_database
.drop_with_session(options.into(), &mut session.async_client_session),
)
}
/// Gets information about each of the collections in the database. The cursor will yield a
/// document pertaining to each collection in the database.
pub fn list_collections(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<ListCollectionsOptions>>,
) -> Result<Cursor<CollectionSpecification>> {
runtime::block_on(
self.async_database
.list_collections(filter.into(), options.into()),
)
.map(Cursor::new)
}
/// Gets information about each of the collections in the database using the provided
/// `ClientSession`. The cursor will yield a document pertaining to each collection in the
/// database.
pub fn list_collections_with_session(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<ListCollectionsOptions>>,
session: &mut ClientSession,
) -> Result<SessionCursor<CollectionSpecification>> {
runtime::block_on(self.async_database.list_collections_with_session(
filter.into(),
options.into(),
&mut session.async_client_session,
))
.map(SessionCursor::new)
}
/// Gets the names of the collections in the database.
pub fn list_collection_names(
&self,
filter: impl Into<Option<Document>>,
) -> Result<Vec<String>> {
runtime::block_on(self.async_database.list_collection_names(filter.into()))
}
/// Gets the names of the collections in the database using the provided `ClientSession`.
pub fn list_collection_names_with_session(
&self,
filter: impl Into<Option<Document>>,
session: &mut ClientSession,
) -> Result<Vec<String>> {
runtime::block_on(
self.async_database.list_collection_names_with_session(
filter.into(),
&mut session.async_client_session,
),
)
}
/// 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 fn create_collection(
&self,
name: impl AsRef<str>,
options: impl Into<Option<CreateCollectionOptions>>,
) -> Result<()> {
runtime::block_on(
self.async_database
.create_collection(name.as_ref(), options.into()),
)
}
/// Creates a new collection in the database with the given `name` and `options` using the
/// provided `ClientSession`.
///
/// Note that MongoDB creates collections implicitly when data is inserted, so this method is
/// not needed if no special options are required.
pub fn create_collection_with_session(
&self,
name: impl AsRef<str>,
options: impl Into<Option<CreateCollectionOptions>>,
session: &mut ClientSession,
) -> Result<()> {
runtime::block_on(self.async_database.create_collection_with_session(
name.as_ref(),
options.into(),
&mut session.async_client_session,
))
}
/// 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 fn run_command(
&self,
command: Document,
selection_criteria: impl Into<Option<SelectionCriteria>>,
) -> Result<Document> {
runtime::block_on(
self.async_database
.run_command(command, selection_criteria.into()),
)
}
/// Runs a database-level command using the provided `ClientSession`.
///
/// 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 fn run_command_with_session(
&self,
command: Document,
selection_criteria: impl Into<Option<SelectionCriteria>>,
session: &mut ClientSession,
) -> Result<Document> {
runtime::block_on(self.async_database.run_command_with_session(
command,
selection_criteria.into(),
&mut session.async_client_session,
))
}
/// Runs an aggregation operation.
///
/// See the documentation [here](https://docs.mongodb.com/manual/aggregation/) for more
/// information on aggregations.
pub fn aggregate(
&self,
pipeline: impl IntoIterator<Item = Document>,
options: impl Into<Option<AggregateOptions>>,
) -> Result<Cursor<Document>> {
let pipeline: Vec<Document> = pipeline.into_iter().collect();
runtime::block_on(self.async_database.aggregate(pipeline, options.into())).map(Cursor::new)
}
/// Runs an aggregation operation using the provided `ClientSession`.
///
/// See the documentation [here](https://docs.mongodb.com/manual/aggregation/) for more
/// information on aggregations.
pub fn aggregate_with_session(
&self,
pipeline: impl IntoIterator<Item = Document>,
options: impl Into<Option<AggregateOptions>>,
session: &mut ClientSession,
) -> Result<SessionCursor<Document>> {
let pipeline: Vec<Document> = pipeline.into_iter().collect();
runtime::block_on(self.async_database.aggregate_with_session(
pipeline,
options.into(),
&mut session.async_client_session,
))
.map(SessionCursor::new)
}
/// Starts a new [`ChangeStream`](change_stream/struct.ChangeStream.html) 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](https://docs.mongodb.com/manual/changeStreams/) 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`](change_stream/struct.ChangeStream.html)
///
/// If the pipeline alters the structure of the returned events, the parsed type will need to be
/// changed via [`ChangeStream::with_type`].
pub fn watch(
&self,
pipeline: impl IntoIterator<Item = Document>,
options: impl Into<Option<ChangeStreamOptions>>,
) -> Result<ChangeStream<ChangeStreamEvent<Document>>> {
runtime::block_on(self.async_database.watch(pipeline, options)).map(ChangeStream::new)
}
/// Starts a new [`SessionChangeStream`] that receives events for all changes in this database
/// using the provided [`ClientSession`]. See [`Database::watch`] for more information.
pub fn watch_with_session(
&self,
pipeline: impl IntoIterator<Item = Document>,
options: impl Into<Option<ChangeStreamOptions>>,
session: &mut ClientSession,
) -> Result<SessionChangeStream<ChangeStreamEvent<Document>>> {
runtime::block_on(self.async_database.watch_with_session(
pipeline,
options,
&mut session.async_client_session,
))
.map(SessionChangeStream::new)
}
}