Skip to content

Commit 0c771ba

Browse files
PHPLIB-846: Improved change stream event visibility for C2C Replication (#949)
Spec tests synced with mongodb/specifications@8da1a89 Co-authored-by: Jeremy Mikola <[email protected]>
1 parent 9cbe36c commit 0c771ba

4 files changed

+43
-0
lines changed

source/includes/apiargs-MongoDBClient-method-watch-option.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ source:
4949
file: apiargs-common-option.yaml
5050
ref: session
5151
---
52+
source:
53+
file: apiargs-method-watch-option.yaml
54+
ref: showExpandedEvents
55+
post: |
56+
.. versionadded:: 1.13
57+
---
5258
source:
5359
file: apiargs-method-watch-option.yaml
5460
ref: startAfter

source/includes/apiargs-MongoDBCollection-method-watch-option.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ source:
4949
file: apiargs-common-option.yaml
5050
ref: session
5151
---
52+
source:
53+
file: apiargs-method-watch-option.yaml
54+
ref: showExpandedEvents
55+
post: |
56+
.. versionadded:: 1.13
57+
---
5258
source:
5359
file: apiargs-method-watch-option.yaml
5460
ref: startAfter

source/includes/apiargs-MongoDBDatabase-method-watch-option.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ source:
4949
file: apiargs-common-option.yaml
5050
ref: session
5151
---
52+
source:
53+
file: apiargs-method-watch-option.yaml
54+
ref: showExpandedEvents
55+
post: |
56+
.. versionadded:: 1.13
57+
---
5258
source:
5359
file: apiargs-method-watch-option.yaml
5460
ref: startAfter

source/includes/apiargs-method-watch-option.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,31 @@ operation: ~
9797
optional: true
9898
---
9999
arg_name: option
100+
name: showExpandedEvents
101+
type: boolean
102+
description: |
103+
If true, instructs the server to include additional DDL events in the change
104+
stream. The additional events that may be included are:
105+
106+
- ``createIndexes``
107+
- ``dropIndexes``
108+
- ``modify``
109+
- ``create``
110+
- ``shardCollection``
111+
- ``reshardCollection`` (server 6.1+)
112+
- ``refineCollectionShardKey`` (server 6.1+)
113+
114+
This is not supported for server versions prior to 6.0 and will result in an
115+
exception at execution time if used.
116+
117+
.. note::
118+
119+
This is an option of the ``$changeStream`` pipeline stage.
120+
interface: phpmethod
121+
operation: ~
122+
optional: true
123+
---
124+
arg_name: option
100125
name: startAfter
101126
type: array|object
102127
description: |

0 commit comments

Comments
 (0)