apiargs-MongoDBCollection-method-aggregate-option.yaml 1.63 KB
Newer Older
1 2 3
source:
  file: apiargs-aggregate-option.yaml
  ref: allowDiskUse
4
---
5 6 7
source:
  file: apiargs-aggregate-option.yaml
  ref: batchSize
8 9
---
source:
10
  file: apiargs-aggregate-option.yaml
11
  ref: bypassDocumentValidation
12
---
13 14 15 16
source:
  file: apiargs-aggregate-option.yaml
  ref: comment
post: |
17 18
  .. versionadded:: 1.3
---
19 20 21 22
source:
  file: apiargs-aggregate-option.yaml
  ref: explain
post: |
23 24
  .. versionadded:: 1.4
---
25 26 27 28
source:
  file: apiargs-aggregate-option.yaml
  ref: hint
post: |
29
  .. versionadded:: 1.3
30
---
31 32
source:
  file: apiargs-common-option.yaml
33
  ref: maxTimeMS
34 35
---
source:
36
  file: apiargs-MongoDBCollection-common-option.yaml
37
  ref: readConcern
38 39
---
source:
40
  file: apiargs-MongoDBCollection-common-option.yaml
41
  ref: readPreference
42
---
43 44 45
source:
  file: apiargs-common-option.yaml
  ref: session
46 47
post: |
  .. versionadded:: 1.3
48
---
49
source:
50
  file: apiargs-MongoDBCollection-common-option.yaml
51
  ref: typeMap
52
---
53
arg_name: option
54 55 56
name: useCursor
type: boolean
description: |
57 58
  Indicates whether the command will request that the server provide results
  using a cursor. The default is ``true``.
59 60 61 62 63 64

  .. note::

     MongoDB 3.6+ no longer supports returning results without a cursor (excluding
     when the explain option is used) and specifying false for this option will
     result in a server error.
65
interface: phpmethod
66
operation: ~
67
optional: true
68 69 70 71 72
---
source:
  file: apiargs-MongoDBCollection-common-option.yaml
  ref: writeConcern
post: |
73 74
  This only applies when a :ref:`$out <agg-out>` or :ref:`$merge <agg-merge>`
  stage is specified.
75 76 77

  This is not supported for server versions prior to 3.4 and will result in an
  exception at execution time if used.
78
...