Skip to content

Commit 823d1e8

Browse files
committed
Merge pull request #637
2 parents 4ba6259 + c56b33e commit 823d1e8

4 files changed

+46
-4
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ source:
3434
file: apiargs-common-option.yaml
3535
ref: session
3636
---
37+
source:
38+
file: apiargs-method-watch-option.yaml
39+
ref: startAfter
40+
post: |
41+
.. versionadded: 1.5
42+
---
3743
source:
3844
file: apiargs-method-watch-option.yaml
3945
ref: startAtOperationTime

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ source:
3434
file: apiargs-common-option.yaml
3535
ref: session
3636
---
37+
source:
38+
file: apiargs-method-watch-option.yaml
39+
ref: startAfter
40+
post: |
41+
.. versionadded: 1.5
42+
---
3743
source:
3844
file: apiargs-method-watch-option.yaml
3945
ref: startAtOperationTime

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ source:
3434
file: apiargs-common-option.yaml
3535
ref: session
3636
---
37+
source:
38+
file: apiargs-method-watch-option.yaml
39+
ref: startAfter
40+
post: |
41+
.. versionadded: 1.5
42+
---
3743
source:
3844
file: apiargs-method-watch-option.yaml
3945
ref: startAtOperationTime

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

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,32 @@ description: |
4646
Specifies the logical starting point for the new change stream. The ``_id``
4747
field in documents returned by the change stream may be used here.
4848
49-
Using this option in conjunction with ``startAtOperationTime`` will result in
50-
a server error. The options are mutually exclusive.
49+
Using this option in conjunction with ``startAfter`` and/or
50+
``startAtOperationTime`` will result in a server error. The options are
51+
mutually exclusive.
52+
53+
.. note::
54+
55+
This is an option of the ``$changeStream`` pipeline stage.
56+
interface: phpmethod
57+
operation: ~
58+
optional: true
59+
---
60+
arg_name: option
61+
name: startAfter
62+
type: array|object
63+
description: |
64+
Specifies the logical starting point for the new change stream. The ``_id``
65+
field in documents returned by the change stream may be used here. Unlike
66+
``resumeAfter``, this option can be used with a resume token from an
67+
"invalidate" event.
68+
69+
Using this option in conjunction with ``resumeAfter`` and/or
70+
``startAtOperationTime`` will result in a server error. The options are
71+
mutually exclusive.
72+
73+
This is not supported for server versions prior to 4.2 and will result in an
74+
exception at execution time if used.
5175
5276
.. note::
5377
@@ -66,8 +90,8 @@ description: |
6690
``operationTime`` returned by the initial ``aggregate`` command will be used
6791
if available.
6892
69-
Using this option in conjunction with ``resumeAfter`` will result in a server
70-
error. The options are mutually exclusive.
93+
Using this option in conjunction with ``resumeAfter`` and/or ``startAfter``
94+
will result in a server error. The options are mutually exclusive.
7195
7296
This is not supported for server versions prior to 4.0 and will result in an
7397
exception at execution time if used.

0 commit comments

Comments
 (0)