You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<tr><td><p>skip</p></td><td><p>A uint32_t of number of documents to skip or 0.</p></td></tr>
38
38
<tr><td><p>limit</p></td><td><p>A uint32_t of max number of documents to return or 0.</p></td></tr>
39
39
<tr><td><p>batch_size</p></td><td><p>A uint32_t containing batch size of document result sets or 0 for default. Default is 100.</p></td></tr>
40
-
<tr><td><p>query</p></td><td><p>A bson_t to execute.</p></td></tr>
40
+
<tr><td><p>query</p></td><td><p>A bson_t containing the query and options to execute.</p></td></tr>
41
41
<tr><td><p>fields</p></td><td><p>A bson_t containing fields to return or NULL.</p></td></tr>
42
42
<tr><td><p>read_prefs</p></td><td><p>A <linkxref="mongoc_read_prefs_t">mongoc_read_prefs_t</link> or NULL for default read preferences.</p></td></tr>
43
43
</table>
44
44
</section>
45
45
46
46
<sectionid="description">
47
47
<title>Description</title>
48
-
<p>This function shall execute a query on the underlying <code>collection</code>. The bson <code>query</code> is not validated, simply passed along as appropriate to the server. As such, compatibility and errors should be validated in the appropriate server documentation.</p>
48
+
<p>This function shall execute a query on the underlying <code>collection</code>.</p>
49
+
<p>If no options are necessary, <code>query</code> can simply contain a query such as <code>{a:1}</code>. If you would like to specify options such as a sort order, the query must be placed inside of <code>{"$query": {}}</code> as specified by the server documentation. See the example below for how to properly specify additional options to <code>query</code>.</p>
0 commit comments