apiargs-MongoDBCollection-method-aggregate-option.yaml

source:
  file: apiargs-aggregate-option.yaml
  ref: allowDiskUse
---
source:
  file: apiargs-aggregate-option.yaml
  ref: batchSize
---
source:
  file: apiargs-aggregate-option.yaml
  ref: bypassDocumentValidation
---
source:
  file: apiargs-aggregate-option.yaml
  ref: comment
post: |
  .. versionadded:: 1.3
---
source:
  file: apiargs-aggregate-option.yaml
  ref: explain
post: |
  .. versionadded:: 1.4
---
source:
  file: apiargs-aggregate-option.yaml
  ref: hint
post: |
  .. versionadded:: 1.3
---
source:
  file: apiargs-common-option.yaml
  ref: maxTimeMS
---
source:
  file: apiargs-MongoDBCollection-common-option.yaml
  ref: readConcern
---
source:
  file: apiargs-MongoDBCollection-common-option.yaml
  ref: readPreference
---
source:
  file: apiargs-common-option.yaml
  ref: session
post: |
  .. versionadded:: 1.3
---
source:
  file: apiargs-MongoDBCollection-common-option.yaml
  ref: typeMap
---
arg_name: option
name: useCursor
type: boolean
description: |
  Indicates whether the command will request that the server provide results
  using a cursor. The default is ``true``.

  .. 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.
interface: phpmethod
operation: ~
optional: true
---
source:
  file: apiargs-MongoDBCollection-common-option.yaml
  ref: writeConcern
post: |
  This only applies when a :ref:`$out <agg-out>` or :ref:`$merge <agg-merge>`
  stage is specified.

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