apiargs-MongoDBCollection-method-findOneAndUpdate-option.yaml 1.05 KB
Newer Older
1 2 3 4 5 6 7
source:
  file: apiargs-MongoDBCollection-method-find-option.yaml
  ref: projection
---
source:
  file: apiargs-MongoDBCollection-method-find-option.yaml
  ref: sort
8 9 10 11
---
source:
  file: apiargs-MongoDBCollection-common-option.yaml
  ref: collation
12 13 14 15 16 17
---
source:
  file: apiargs-common-option.yaml
  ref: maxTimeMS
---
source:
18
  file: apiargs-MongoDBCollection-common-option.yaml
19 20 21 22 23 24
  ref: bypassDocumentValidation
---
arg_name: option
name: returnDocument
type: integer
description: |
25
  Specifies whether to return the document before the update is applied, or
26
  after. ``returnDocument`` supports the following values:
27 28 29

  - ``MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_BEFORE`` (*default*)
  - ``MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_AFTER``
30
interface: phpmethod
31
operation: ~
32
optional: true
33 34
---
source:
35
  file: apiargs-MongoDBCollection-common-option.yaml
36 37 38
  ref: upsert
---
source:
39
  file: apiargs-MongoDBCollection-common-option.yaml
40
  ref: writeConcern
41 42 43
post: |
  This is not supported for server versions prior to 3.2 and will be ignored if
  used.
44
...