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 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
use std::{
fmt::Debug,
marker::{Send, Sync},
};
use serde::{de::DeserializeOwned, Serialize};
use super::Cursor;
use crate::{
bson::{Bson, Document},
error::Result,
options::{
AggregateOptions,
CountOptions,
DeleteOptions,
DistinctOptions,
DropCollectionOptions,
EstimatedDocumentCountOptions,
FindOneAndDeleteOptions,
FindOneAndReplaceOptions,
FindOneAndUpdateOptions,
FindOneOptions,
FindOptions,
InsertManyOptions,
InsertOneOptions,
ReadConcern,
ReplaceOptions,
SelectionCriteria,
UpdateModifications,
UpdateOptions,
WriteConcern,
},
results::{DeleteResult, InsertManyResult, InsertOneResult, UpdateResult},
Collection as AsyncCollection,
Namespace,
RUNTIME,
};
/// `Collection` is the client-side abstraction of a MongoDB Collection. It can be used to
/// perform collection-level operations such as CRUD operations. A `Collection` can be obtained
/// through a [`Database`](struct.Database.html) by calling either
/// [`Database::collection`](struct.Database.html#method.collection) or
/// [`Database::collection_with_options`](struct.Database.html#method.collection_with_options).
///
/// `Collection` 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::doc,
/// # error::Result,
/// # sync::Client,
/// # };
/// #
/// # fn start_workers() -> Result<()> {
/// # let client = Client::with_uri_str("mongodb://example.com")?;
/// let coll = client.database("items").collection("in_stock");
///
/// for i in 0..5 {
/// let coll_ref = coll.clone();
///
/// std::thread::spawn(move || {
/// // Perform operations with `coll_ref`. For example:
/// coll_ref.insert_one(doc! { "x": i }, None);
/// });
/// }
/// #
/// # // 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(Clone, Debug)]
pub struct Collection<T = Document>
where
T: Serialize + DeserializeOwned + Unpin + Debug + Send + Sync,
{
async_collection: AsyncCollection<T>,
}
impl<T> Collection<T>
where
T: Serialize + DeserializeOwned + Unpin + Debug + Send + Sync,
{
pub(crate) fn new(async_collection: AsyncCollection<T>) -> Self {
Self { async_collection }
}
/// Gets a clone of the `Collection` with a different type `U`.
pub fn clone_with_type<U>(&self) -> Collection<U>
where
U: Serialize + DeserializeOwned + Unpin + Debug + Send + Sync,
{
Collection::new(self.async_collection.clone_with_type())
}
/// Gets the name of the `Collection`.
pub fn name(&self) -> &str {
self.async_collection.name()
}
/// Gets the namespace of the `Collection`.
///
/// The namespace of a MongoDB collection is the concatenation of the name of the database
/// containing it, the '.' character, and the name of the collection itself. For example, if a
/// collection named "bar" is created in a database named "foo", the namespace of the collection
/// is "foo.bar".
pub fn namespace(&self) -> Namespace {
self.async_collection.namespace()
}
/// Gets the selection criteria of the `Collection`.
pub fn selection_criteria(&self) -> Option<&SelectionCriteria> {
self.async_collection.selection_criteria()
}
/// Gets the read concern of the `Collection`.
pub fn read_concern(&self) -> Option<&ReadConcern> {
self.async_collection.read_concern()
}
/// Gets the write concern of the `Collection`.
pub fn write_concern(&self) -> Option<&WriteConcern> {
self.async_collection.write_concern()
}
/// Drops the collection, deleting all data, users, and indexes stored in it.
pub fn drop(&self, options: impl Into<Option<DropCollectionOptions>>) -> Result<()> {
RUNTIME.block_on(self.async_collection.drop(options.into()))
}
/// 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> {
let pipeline: Vec<Document> = pipeline.into_iter().collect();
RUNTIME
.block_on(self.async_collection.aggregate(pipeline, options.into()))
.map(Cursor::new)
}
/// Estimates the number of documents in the collection using collection metadata.
pub fn estimated_document_count(
&self,
options: impl Into<Option<EstimatedDocumentCountOptions>>,
) -> Result<i64> {
RUNTIME.block_on(
self.async_collection
.estimated_document_count(options.into()),
)
}
/// Gets the number of documents matching `filter`.
///
/// Note that using [`Collection::estimated_document_count`](#method.estimated_document_count)
/// is recommended instead of this method is most cases.
pub fn count_documents(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<CountOptions>>,
) -> Result<i64> {
RUNTIME.block_on(
self.async_collection
.count_documents(filter.into(), options.into()),
)
}
/// Deletes all documents stored in the collection matching `query`.
pub fn delete_many(
&self,
query: Document,
options: impl Into<Option<DeleteOptions>>,
) -> Result<DeleteResult> {
RUNTIME.block_on(self.async_collection.delete_many(query, options.into()))
}
/// Deletes up to one document found matching `query`.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://docs.mongodb.com/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn delete_one(
&self,
query: Document,
options: impl Into<Option<DeleteOptions>>,
) -> Result<DeleteResult> {
RUNTIME.block_on(self.async_collection.delete_one(query, options.into()))
}
/// Finds the distinct values of the field specified by `field_name` across the collection.
pub fn distinct(
&self,
field_name: &str,
filter: impl Into<Option<Document>>,
options: impl Into<Option<DistinctOptions>>,
) -> Result<Vec<Bson>> {
RUNTIME.block_on(
self.async_collection
.distinct(field_name, filter.into(), options.into()),
)
}
/// Finds the documents in the collection matching `filter`.
pub fn find(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<FindOptions>>,
) -> Result<Cursor<T>> {
RUNTIME
.block_on(self.async_collection.find(filter.into(), options.into()))
.map(Cursor::new)
}
/// Finds a single document in the collection matching `filter`.
pub fn find_one(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<FindOneOptions>>,
) -> Result<Option<T>> {
RUNTIME.block_on(
self.async_collection
.find_one(filter.into(), options.into()),
)
}
/// Atomically finds up to one document in the collection matching `filter` and deletes it.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://docs.mongodb.com/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn find_one_and_delete(
&self,
filter: Document,
options: impl Into<Option<FindOneAndDeleteOptions>>,
) -> Result<Option<T>> {
RUNTIME.block_on(
self.async_collection
.find_one_and_delete(filter, options.into()),
)
}
/// Atomically finds up to one document in the collection matching `filter` and replaces it with
/// `replacement`.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://docs.mongodb.com/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn find_one_and_replace(
&self,
filter: Document,
replacement: T,
options: impl Into<Option<FindOneAndReplaceOptions>>,
) -> Result<Option<T>> {
RUNTIME.block_on(self.async_collection.find_one_and_replace(
filter,
replacement,
options.into(),
))
}
/// Atomically finds up to one document in the collection matching `filter` and updates it.
/// Both `Document` and `Vec<Document>` implement `Into<UpdateModifications>`, so either can be
/// passed in place of constructing the enum case. Note: pipeline updates are only supported
/// in MongoDB 4.2+.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://docs.mongodb.com/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn find_one_and_update(
&self,
filter: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<FindOneAndUpdateOptions>>,
) -> Result<Option<T>> {
RUNTIME.block_on(self.async_collection.find_one_and_update(
filter,
update.into(),
options.into(),
))
}
/// Inserts the documents in `docs` into the collection.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://docs.mongodb.com/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn insert_many(
&self,
docs: impl IntoIterator<Item = T>,
options: impl Into<Option<InsertManyOptions>>,
) -> Result<InsertManyResult> {
let docs: Vec<T> = docs.into_iter().collect();
RUNTIME.block_on(self.async_collection.insert_many(docs, options.into()))
}
/// Inserts `doc` into the collection.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://docs.mongodb.com/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn insert_one(
&self,
doc: T,
options: impl Into<Option<InsertOneOptions>>,
) -> Result<InsertOneResult> {
RUNTIME.block_on(self.async_collection.insert_one(doc, options.into()))
}
/// Replaces up to one document matching `query` in the collection with `replacement`.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://docs.mongodb.com/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn replace_one(
&self,
query: Document,
replacement: T,
options: impl Into<Option<ReplaceOptions>>,
) -> Result<UpdateResult> {
RUNTIME.block_on(
self.async_collection
.replace_one(query, replacement, options.into()),
)
}
/// Updates all documents matching `query` in the collection.
///
/// Both `Document` and `Vec<Document>` implement `Into<UpdateModifications>`, so either can be
/// passed in place of constructing the enum case. Note: pipeline updates are only supported
/// in MongoDB 4.2+. See the official MongoDB
/// [documentation](https://docs.mongodb.com/manual/reference/command/update/#behavior) for more information on specifying updates.
pub fn update_many(
&self,
query: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<UpdateOptions>>,
) -> Result<UpdateResult> {
RUNTIME.block_on(
self.async_collection
.update_many(query, update.into(), options.into()),
)
}
/// Updates up to one document matching `query` in the collection.
///
/// Both `Document` and `Vec<Document>` implement `Into<UpdateModifications>`, so either can be
/// passed in place of constructing the enum case. Note: pipeline updates are only supported
/// in MongoDB 4.2+. See the official MongoDB
/// [documentation](https://docs.mongodb.com/manual/reference/command/update/#behavior) for more information on specifying updates.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://docs.mongodb.com/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn update_one(
&self,
query: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<UpdateOptions>>,
) -> Result<UpdateResult> {
RUNTIME.block_on(
self.async_collection
.update_one(query, update.into(), options.into()),
)
}
}