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 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
use std::{borrow::Borrow, fmt::Debug};
use serde::{de::DeserializeOwned, Serialize};
use super::{ChangeStream, ClientSession, Cursor, SessionChangeStream, SessionCursor};
use crate::{
bson::{Bson, Document},
change_stream::{event::ChangeStreamEvent, options::ChangeStreamOptions},
error::Result,
index::IndexModel,
options::{
AggregateOptions,
CountOptions,
CreateIndexOptions,
DeleteOptions,
DistinctOptions,
DropCollectionOptions,
DropIndexOptions,
EstimatedDocumentCountOptions,
FindOneAndDeleteOptions,
FindOneAndReplaceOptions,
FindOneAndUpdateOptions,
FindOneOptions,
FindOptions,
InsertManyOptions,
InsertOneOptions,
ListIndexesOptions,
ReadConcern,
ReplaceOptions,
SelectionCriteria,
UpdateModifications,
UpdateOptions,
WriteConcern,
},
results::{
CreateIndexResult,
CreateIndexesResult,
DeleteResult,
InsertManyResult,
InsertOneResult,
UpdateResult,
},
runtime,
Collection as AsyncCollection,
Namespace,
};
/// `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> {
async_collection: AsyncCollection<T>,
}
impl<T> Collection<T> {
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> {
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()))
}
/// Drops the collection, deleting all data, users, and indexes stored in it using the provided
/// `ClientSession`.
pub fn drop_with_session(
&self,
options: impl Into<Option<DropCollectionOptions>>,
session: &mut ClientSession,
) -> Result<()> {
runtime::block_on(
self.async_collection
.drop_with_session(options.into(), &mut session.async_client_session),
)
}
/// Runs an aggregation operation.
///
/// See the documentation [here](https://www.mongodb.com/docs/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_collection.aggregate(pipeline, options.into()))
.map(Cursor::new)
}
/// Runs an aggregation operation using the provided `ClientSession`.
///
/// See the documentation [here](https://www.mongodb.com/docs/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_collection.aggregate_with_session(
pipeline,
options.into(),
&mut session.async_client_session,
))
.map(SessionCursor::new)
}
/// Estimates the number of documents in the collection using collection metadata.
///
/// Due to an oversight in versions 5.0.0 - 5.0.7 of MongoDB, the `count` server command,
/// which `estimatedDocumentCount` uses in its implementation, was not included in v1 of the
/// Stable API. Users of the Stable API with `estimatedDocumentCount` are recommended to
/// upgrade their cluster to 5.0.8+ or set
/// [`ServerApi::strict`](crate::options::ServerApi::strict) to false to avoid encountering
/// errors.
///
/// For more information on the behavior of the `count` server command, see
/// [Count: Behavior](https://www.mongodb.com/docs/manual/reference/command/count/#behavior).
pub fn estimated_document_count(
&self,
options: impl Into<Option<EstimatedDocumentCountOptions>>,
) -> Result<u64> {
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<u64> {
runtime::block_on(
self.async_collection
.count_documents(filter.into(), options.into()),
)
}
/// Gets the number of documents matching `filter` using the provided `ClientSession`.
///
/// Note that using [`Collection::estimated_document_count`](#method.estimated_document_count)
/// is recommended instead of this method is most cases.
pub fn count_documents_with_session(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<CountOptions>>,
session: &mut ClientSession,
) -> Result<u64> {
runtime::block_on(self.async_collection.count_documents_with_session(
filter.into(),
options.into(),
&mut session.async_client_session,
))
}
/// Creates the given index on this collection.
pub fn create_index(
&self,
index: IndexModel,
options: impl Into<Option<CreateIndexOptions>>,
) -> Result<CreateIndexResult> {
runtime::block_on(self.async_collection.create_index(index, options))
}
/// Creates the given index on this collection using the provided `ClientSession`.
pub fn create_index_with_session(
&self,
index: IndexModel,
options: impl Into<Option<CreateIndexOptions>>,
session: &mut ClientSession,
) -> Result<CreateIndexResult> {
runtime::block_on(self.async_collection.create_index_with_session(
index,
options,
&mut session.async_client_session,
))
}
/// Creates the given indexes on this collection.
pub fn create_indexes(
&self,
indexes: impl IntoIterator<Item = IndexModel>,
options: impl Into<Option<CreateIndexOptions>>,
) -> Result<CreateIndexesResult> {
runtime::block_on(self.async_collection.create_indexes(indexes, options))
}
/// Creates the given indexes on this collection using the provided `ClientSession`.
pub fn create_indexes_with_session(
&self,
indexes: impl IntoIterator<Item = IndexModel>,
options: impl Into<Option<CreateIndexOptions>>,
session: &mut ClientSession,
) -> Result<CreateIndexesResult> {
runtime::block_on(self.async_collection.create_indexes_with_session(
indexes,
options,
&mut session.async_client_session,
))
}
/// 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 all documents stored in the collection matching `query` using the provided
/// `ClientSession`.
pub fn delete_many_with_session(
&self,
query: Document,
options: impl Into<Option<DeleteOptions>>,
session: &mut ClientSession,
) -> Result<DeleteResult> {
runtime::block_on(self.async_collection.delete_many_with_session(
query,
options.into(),
&mut session.async_client_session,
))
}
/// 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://www.mongodb.com/docs/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()))
}
/// Deletes up to one document found matching `query` using the provided `ClientSession`.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn delete_one_with_session(
&self,
query: Document,
options: impl Into<Option<DeleteOptions>>,
session: &mut ClientSession,
) -> Result<DeleteResult> {
runtime::block_on(self.async_collection.delete_one_with_session(
query,
options.into(),
&mut session.async_client_session,
))
}
/// Finds the distinct values of the field specified by `field_name` across the collection.
pub fn distinct(
&self,
field_name: impl AsRef<str>,
filter: impl Into<Option<Document>>,
options: impl Into<Option<DistinctOptions>>,
) -> Result<Vec<Bson>> {
runtime::block_on(self.async_collection.distinct(
field_name.as_ref(),
filter.into(),
options.into(),
))
}
/// Finds the distinct values of the field specified by `field_name` across the collection using
/// the provided `ClientSession`.
pub fn distinct_with_session(
&self,
field_name: impl AsRef<str>,
filter: impl Into<Option<Document>>,
options: impl Into<Option<DistinctOptions>>,
session: &mut ClientSession,
) -> Result<Vec<Bson>> {
runtime::block_on(self.async_collection.distinct_with_session(
field_name.as_ref(),
filter.into(),
options.into(),
&mut session.async_client_session,
))
}
/// 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://www.mongodb.com/docs/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()),
)
}
/// Drops the index specified by `name` from this collection.
pub fn drop_index(
&self,
name: impl AsRef<str>,
options: impl Into<Option<DropIndexOptions>>,
) -> Result<()> {
runtime::block_on(self.async_collection.drop_index(name, options))
}
/// Drops the index specified by `name` from this collection using the provided `ClientSession`.
pub fn drop_index_with_session(
&self,
name: impl AsRef<str>,
options: impl Into<Option<DropIndexOptions>>,
session: &mut ClientSession,
) -> Result<()> {
runtime::block_on(self.async_collection.drop_index_with_session(
name,
options,
&mut session.async_client_session,
))
}
/// Drops all indexes associated with this collection.
pub fn drop_indexes(&self, options: impl Into<Option<DropIndexOptions>>) -> Result<()> {
runtime::block_on(self.async_collection.drop_indexes(options))
}
/// Drops all indexes associated with this collection using the provided `ClientSession`.
pub fn drop_indexes_with_session(
&self,
options: impl Into<Option<DropIndexOptions>>,
session: &mut ClientSession,
) -> Result<()> {
runtime::block_on(
self.async_collection
.drop_indexes_with_session(options, &mut session.async_client_session),
)
}
/// Lists all indexes on this collection.
pub fn list_indexes(
&self,
options: impl Into<Option<ListIndexesOptions>>,
) -> Result<Cursor<IndexModel>> {
runtime::block_on(self.async_collection.list_indexes(options)).map(Cursor::new)
}
/// Lists all indexes on this collection using the provided `ClientSession`.
pub fn list_indexes_with_session(
&self,
options: impl Into<Option<ListIndexesOptions>>,
session: &mut ClientSession,
) -> Result<SessionCursor<IndexModel>> {
runtime::block_on(
self.async_collection
.list_indexes_with_session(options, &mut session.async_client_session),
)
.map(SessionCursor::new)
}
/// Gets the names of all indexes on the collection.
pub fn list_index_names(&self) -> Result<Vec<String>> {
runtime::block_on(self.async_collection.list_index_names())
}
/// Gets the names of all indexes on the collection using the provided `ClientSession`.
pub fn list_index_names_with_session(
&self,
session: &mut ClientSession,
) -> Result<Vec<String>> {
runtime::block_on(
self.async_collection
.list_index_names_with_session(&mut session.async_client_session),
)
}
/// Updates all documents matching `query` in the collection using the provided `ClientSession`.
///
/// 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://www.mongodb.com/docs/manual/reference/command/update/#behavior) for more information on specifying updates.
pub fn update_many_with_session(
&self,
query: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<UpdateOptions>>,
session: &mut ClientSession,
) -> Result<UpdateResult> {
runtime::block_on(self.async_collection.update_many_with_session(
query,
update.into(),
options.into(),
&mut session.async_client_session,
))
}
/// 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://www.mongodb.com/docs/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://www.mongodb.com/docs/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()),
)
}
/// Updates up to one document matching `query` in the collection using the provided
/// `ClientSession`.
///
/// 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://www.mongodb.com/docs/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://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn update_one_with_session(
&self,
query: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<UpdateOptions>>,
session: &mut ClientSession,
) -> Result<UpdateResult> {
runtime::block_on(self.async_collection.update_one_with_session(
query,
update.into(),
options.into(),
&mut session.async_client_session,
))
}
/// Starts a new [`ChangeStream`](change_stream/struct.ChangeStream.html) that receives events
/// for all changes in this collection. A
/// [`ChangeStream`](change_stream/struct.ChangeStream.html) cannot be started on system
/// collections.
///
/// See the documentation [here](https://www.mongodb.com/docs/manual/changeStreams/) on change
/// streams.
///
/// Change streams require either a "majority" read concern or no read concern. Anything else
/// will cause a server error.
///
/// Also 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<T>>>
where
T: DeserializeOwned + Unpin + Send + Sync,
{
runtime::block_on(self.async_collection.watch(pipeline, options)).map(ChangeStream::new)
}
/// Starts a new [`SessionChangeStream`] that receives events for all changes in this collection
/// using the provided [`ClientSession`]. See [`Client::watch`](crate::sync::Client::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<T>>>
where
T: DeserializeOwned + Unpin + Send + Sync,
{
runtime::block_on(self.async_collection.watch_with_session(
pipeline,
options,
&mut session.async_client_session,
))
.map(SessionChangeStream::new)
}
/// 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 the documents in the collection matching `filter` using the provided `ClientSession`.
pub fn find_with_session(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<FindOptions>>,
session: &mut ClientSession,
) -> Result<SessionCursor<T>> {
runtime::block_on(self.async_collection.find_with_session(
filter.into(),
options.into(),
&mut session.async_client_session,
))
.map(SessionCursor::new)
}
}
impl<T> Collection<T>
where
T: DeserializeOwned + Unpin + Send + Sync,
{
/// 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()),
)
}
/// Finds a single document in the collection matching `filter` using the provided
/// `ClientSession`.
pub fn find_one_with_session(
&self,
filter: impl Into<Option<Document>>,
options: impl Into<Option<FindOneOptions>>,
session: &mut ClientSession,
) -> Result<Option<T>> {
runtime::block_on(self.async_collection.find_one_with_session(
filter.into(),
options.into(),
&mut session.async_client_session,
))
}
}
impl<T> Collection<T>
where
T: DeserializeOwned,
{
/// 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://www.mongodb.com/docs/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 deletes it using
/// the provided `ClientSession`.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn find_one_and_delete_with_session(
&self,
filter: Document,
options: impl Into<Option<FindOneAndDeleteOptions>>,
session: &mut ClientSession,
) -> Result<Option<T>> {
runtime::block_on(self.async_collection.find_one_and_delete_with_session(
filter,
options.into(),
&mut session.async_client_session,
))
}
/// 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://www.mongodb.com/docs/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(),
))
}
/// Atomically finds up to one document in the collection matching `filter` and updates it using
/// the provided `ClientSession`. 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://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn find_one_and_update_with_session(
&self,
filter: Document,
update: impl Into<UpdateModifications>,
options: impl Into<Option<FindOneAndUpdateOptions>>,
session: &mut ClientSession,
) -> Result<Option<T>> {
runtime::block_on(self.async_collection.find_one_and_update_with_session(
filter,
update.into(),
options.into(),
&mut session.async_client_session,
))
}
}
impl<T> Collection<T>
where
T: Serialize + DeserializeOwned,
{
/// 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://www.mongodb.com/docs/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 replaces it with
/// `replacement` using the provided `ClientSession`.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn find_one_and_replace_with_session(
&self,
filter: Document,
replacement: T,
options: impl Into<Option<FindOneAndReplaceOptions>>,
session: &mut ClientSession,
) -> Result<Option<T>> {
runtime::block_on(self.async_collection.find_one_and_replace_with_session(
filter,
replacement,
options.into(),
&mut session.async_client_session,
))
}
}
impl<T> Collection<T>
where
T: Serialize,
{
/// 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://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn insert_many(
&self,
docs: impl IntoIterator<Item = impl Borrow<T>>,
options: impl Into<Option<InsertManyOptions>>,
) -> Result<InsertManyResult> {
runtime::block_on(self.async_collection.insert_many(docs, options.into()))
}
/// Inserts the documents in `docs` into the collection using the provided `ClientSession`.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn insert_many_with_session(
&self,
docs: impl IntoIterator<Item = impl Borrow<T>>,
options: impl Into<Option<InsertManyOptions>>,
session: &mut ClientSession,
) -> Result<InsertManyResult> {
runtime::block_on(self.async_collection.insert_many_with_session(
docs,
options.into(),
&mut session.async_client_session,
))
}
/// 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://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn insert_one(
&self,
doc: impl Borrow<T>,
options: impl Into<Option<InsertOneOptions>>,
) -> Result<InsertOneResult> {
runtime::block_on(
self.async_collection
.insert_one(doc.borrow(), options.into()),
)
}
/// Inserts `doc` into the collection using the provided `ClientSession`.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn insert_one_with_session(
&self,
doc: impl Borrow<T>,
options: impl Into<Option<InsertOneOptions>>,
session: &mut ClientSession,
) -> Result<InsertOneResult> {
runtime::block_on(self.async_collection.insert_one_with_session(
doc.borrow(),
options.into(),
&mut session.async_client_session,
))
}
/// 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://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn replace_one(
&self,
query: Document,
replacement: impl Borrow<T>,
options: impl Into<Option<ReplaceOptions>>,
) -> Result<UpdateResult> {
runtime::block_on(self.async_collection.replace_one(
query,
replacement.borrow(),
options.into(),
))
}
/// Replaces up to one document matching `query` in the collection with `replacement` using the
/// provided `ClientSession`.
///
/// This operation will retry once upon failure if the connection and encountered error support
/// retryability. See the documentation
/// [here](https://www.mongodb.com/docs/manual/core/retryable-writes/) for more information on
/// retryable writes.
pub fn replace_one_with_session(
&self,
query: Document,
replacement: impl Borrow<T>,
options: impl Into<Option<ReplaceOptions>>,
session: &mut ClientSession,
) -> Result<UpdateResult> {
runtime::block_on(self.async_collection.replace_one_with_session(
query,
replacement.borrow(),
options.into(),
&mut session.async_client_session,
))
}
}