apiargs-MongoDBCollection-method-findOneAndUpdate-option.yaml 1.3 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 12
source:
  file: apiargs-MongoDBCollection-common-option.yaml
  ref: arrayFilters
---
13 14 15
source:
  file: apiargs-MongoDBCollection-common-option.yaml
  ref: collation
16 17 18 19 20 21
---
source:
  file: apiargs-common-option.yaml
  ref: maxTimeMS
---
source:
22
  file: apiargs-MongoDBCollection-common-option.yaml
23 24 25 26 27 28
  ref: bypassDocumentValidation
---
arg_name: option
name: returnDocument
type: integer
description: |
29
  Specifies whether to return the document before the update is applied, or
30
  after. ``returnDocument`` supports the following values:
31 32 33

  - ``MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_BEFORE`` (*default*)
  - ``MongoDB\Operation\FindOneAndUpdate::RETURN_DOCUMENT_AFTER``
34
interface: phpmethod
35
operation: ~
36
optional: true
37
---
38 39 40 41 42 43
source:
  file: apiargs-MongoDBCollection-common-option.yaml
  ref: typeMap
post: |
  This will be used for the returned result document.
---
44
source:
45
  file: apiargs-MongoDBCollection-common-option.yaml
46 47 48
  ref: upsert
---
source:
49
  file: apiargs-MongoDBCollection-common-option.yaml
50
  ref: writeConcern
51
post: |
52 53
  This is not supported for server versions prior to 3.2 and will result in an
  exception at execution time if used.
54
...