Skip to content

SWIFT-1034 Add sorted find example to README #605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 12, 2021
Merged

SWIFT-1034 Add sorted find example to README #605

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa8f47d
add sort example
patrickfreed Feb 11, 2021
997a6a5
add comment
patrickfreed Feb 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,11 @@ print(result?.insertedID ?? "") // prints `.int64(100)`
**Async**:
```swift
let query: BSONDocument = ["a": 1]
let result = collection.find(query).flatMap { cursor in
// The `sort` option specifies the order in which results are returned
// via the cursor. In this case, `["_id": -1]` indicates that the documents will
// be returned in descending order according to the `_id` field.
let options = FindOptions(sort: ["_id": -1])
Copy link
Contributor

@kmahar kmahar Feb 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it would be obvious from context what this is doing. maybe we could add a comment or something?

Copy link
Contributor Author

@patrickfreed patrickfreed Feb 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done. I figure these examples will largely be used for copy/paste, so I included the comment in both examples to ensure it gets picked up regardless of how a user tries out the driver.

let result = collection.find(query, options: options).flatMap { cursor in
cursor.forEach { doc in
print(doc)
}
Expand All @@ -147,7 +151,11 @@ let result = collection.find(query).flatMap { cursor in
**Sync**:
```swift
let query: BSONDocument = ["a": 1]
let documents = try collection.find(query)
// The `sort` option specifies the order in which results are returned
// via the cursor. In this case, `["_id": -1]` indicates that the documents will
// be returned in descending order according to the `_id` field.
let options = FindOptions(sort: ["_id": -1])
let documents = try collection.find(query, options: options)
for d in documents {
print(try d.get())
}
Expand Down