apiargs-MongoDBCollection-method-findOneAndReplace-option.yaml 1.32 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
  ref: bypassDocumentValidation
---
21 22 23 24
arg_name: option
name: returnDocument
type: integer
description: |
25
  Specifies whether to return the document before the replacement is applied, or
26 27 28 29 30
  after. ``returnDocument`` supports the following values:

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