apiargs-MongoDBCollection-method-findOneAndUpdate-option.yaml 1.26 KB
source:
  file: apiargs-MongoDBCollection-method-find-option.yaml
  ref: projection
operation: MongoDB\Collection::findOneAndUpdate
position: 1
---
source:
  file: apiargs-MongoDBCollection-method-find-option.yaml
  ref: sort
operation: MongoDB\Collection::findOneAndUpdate
position: 2
---
source:
  file: apiargs-common-option.yaml
  ref: maxTimeMS
operation: MongoDB\Collection::findOneAndUpdate
position: 3
---
source:
  file: apiargs-common-option.yaml
  ref: bypassDocumentValidation
operation: MongoDB\Collection::findOneAndUpdate
position: 4
---
arg_name: option
name: returnDocument
type: integer
description: |
  Specifies whether to return the document before the {{event}}, or
  after. ``returnDocument`` supports the following values:
  
  - ``MongoDB\Operation\FindOneAndReplace::RETURN_DOCUMENT_BEFORE`` (*default*)
  - ``MongoDB\Operation\FindOneAndReplace::RETURN_DOCUMENT_AFTER``
optional: true
replacement:
  event: "update is applied"
interface: phpmethod
operation: MongoDB\Collection::findOneAndUpdate
position: 5
---
source:
  file: apiargs-common-option.yaml
  ref: upsert
operation: MongoDB\\Collection::findOneAndUpdate
position: 6
---
source:
  file: apiargs-common-option.yaml
  ref: writeConcern
operation: MongoDB\Collection::findOneAndUpdate
position: 7
...