Skip to content

Commit b1f6003

Browse files
author
Chris Cho
authored
DOCSP-10101: feedback fixes for skip results (#93)
* DOCSP-10101: feedback fixes for skip results
1 parent d0fc8d5 commit b1f6003

File tree

1 file changed

+21
-11
lines changed
  • source/fundamentals/crud/read-operations

1 file changed

+21
-11
lines changed

source/fundamentals/crud/read-operations/skip.txt

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,23 @@ a query, that query returns no documents.
2020
Follow the instructions in the examples below to insert data into
2121
a collection and perform a sort and skip on the results of a query.
2222
Consider a collection containing documents that describe varieties of
23-
fruit. To insert this data into a collection, run the following
24-
operation:
23+
fruit:
2524

2625
.. code-block:: javascript
2726

28-
await collection.insertMany([
27+
[
2928
{ "_id": 1, "name": "apples", "qty": 5, "rating": 3 },
3029
{ "_id": 2, "name": "bananas", "qty": 7, "rating": 1 },
3130
{ "_id": 3, "name": "oranges", "qty": 6, "rating": 2 },
3231
{ "_id": 4, "name": "avocados", "qty": 3, "rating": 5 },
33-
]);
32+
]
3433

35-
Pass the following sort document to a read operation to ensure that the
36-
operation returns fruit documents with higher ratings before fruit
37-
documents with lower ratings:
34+
In the following example, we query the collection with a filter that
35+
matches all the documents and pass options that specifies ``sort`` and
36+
``skip`` commands as query options. The sort option specifies that fruit
37+
documents with higher ratings should be returned before ones with lower
38+
ratings. The skip option specifies that the first 2 documents should be
39+
omitted from the result:
3840

3941
.. code-block:: javascript
4042

@@ -50,12 +52,20 @@ documents with lower ratings:
5052
const cursor = collection.find(query, options);
5153
await cursor.forEach(console.dir);
5254

53-
In this case, the number ``-1`` tells the read operation to sort the
54-
fruit in descending order by rating. ``skip`` omits the first two
55-
matched documents in the sorted order. ``find()`` returns the following
56-
documents when this sort is used with an empty query:
55+
Since we specified that the first ``2`` documents should be skipped, the
56+
third and fourth highest rating documents are printed by the code snippet
57+
above:
5758

5859
.. code-block:: javascript
5960

6061
{ "_id": 3, "name": "oranges", "qty": 6, "rating": 2 }
6162
{ "_id": 2, "name": "bananas", "qty": 7, "rating": 1 }
63+
64+
65+
The ``sort`` and ``skip`` options can also be specified as methods chained to
66+
the ``find`` method. The following two commands are equivalent:
67+
68+
.. code-block:: javascript
69+
70+
collection.find(query, { sort: { rating: -1}, skip: 2});
71+
collection.find(query).sort({rating: -1}).skip(2);

0 commit comments

Comments
 (0)