apiargs-MongoDBCollection-method-count-option.yaml 1.12 KB
Newer Older
1 2 3 4
source:
  file: apiargs-MongoDBCollection-common-option.yaml
  ref: collation
---
5 6
arg_name: option
name: hint
7
type: string|array|object
8
description: |
9 10 11 12 13 14 15
  The index to use. Specify either the index name as a string or the index key
  pattern as a document. If specified, then the query system will only consider
  plans using the hinted index.

  .. versionchanged:: 1.2
     If a document is provided, it is passed to the command as-is. Previously,
     the library would convert the key pattern to an index name.
16
interface: phpmethod
17
operation: ~
18
optional: true
19 20 21 22 23
---
arg_name: option
name: limit
type: integer
description: |
24
  The maximum number of matching documents to return.
25
interface: phpmethod
26
operation: ~
27
optional: true
28 29 30
---
source:
  file: apiargs-common-option.yaml
31
  ref: maxTimeMS
32 33
---
source:
34
  file: apiargs-MongoDBCollection-common-option.yaml
35 36 37
  ref: readConcern
---
source:
38
  file: apiargs-MongoDBCollection-common-option.yaml
39 40 41 42 43 44
  ref: readPreference
---
arg_name: option
name: skip
type: integer
description: |
45
  The number of matching documents to skip before returning results.
46
interface: phpmethod
47
operation: ~
48
optional: true
49
...