Skip to content

Commit 462d1e3

Browse files
committed
Simplify and reorder option docs for Watch operation
Read concern is supported by all server versions that support change streams, so we need not discuss its requirement.
1 parent a09973f commit 462d1e3

File tree

1 file changed

+9
-19
lines changed

1 file changed

+9
-19
lines changed

src/Operation/Watch.php

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ class Watch implements Executable
5151
*
5252
* Supported options:
5353
*
54+
* * batchSize (integer): The number of documents to return per batch.
55+
*
56+
* * collation (document): Specifies a collation.
57+
*
5458
* * fullDocument (string): Determines whether the "fullDocument" field
5559
* will be populated for update operations. By default, change streams
5660
* only return the delta of fields during the update operation (via the
@@ -61,31 +65,17 @@ class Watch implements Executable
6165
* Insert and replace operations always include the "fullDocument" field
6266
* and delete operations omit the field as the document no longer exists.
6367
*
64-
* * resumeAfter (document): Specifies the logical starting point for the
65-
* new change stream.
66-
*
67-
* * readConcern (MongoDB\Driver\ReadConcern): Read concern. Note that a
68-
* "majority" read concern is not compatible with the $out stage
68+
* * maxAwaitTimeMS (integer): The maximum amount of time for the server to
69+
* wait on new documents to satisfy a change stream query.
6970
*
70-
* This is not supported for server versions < 3.2 and will result in an
71-
* exception at execution time if used.
71+
* * readConcern (MongoDB\Driver\ReadConcern): Read concern.
7272
*
7373
* * readPreference (MongoDB\Driver\ReadPreference): Read preference. This
7474
* will be used to select a new server when resuming. Defaults to a
7575
* "primary" read preference.
7676
*
77-
* * maxAwaitTimeMS (integer): The maximum amount of time for the server to
78-
* wait on new documents to satisfy a change stream query.
79-
*
80-
* * batchSize (integer): The number of documents to return per batch.
81-
*
82-
* This option is sent only if the caller explicitly provides a value.
83-
* The default is to not send a value.
84-
*
85-
* * collation (document): Specifies a collation.
86-
*
87-
* This option is sent only if the caller explicitly provides a value.
88-
* The default is to not send a value.
77+
* * resumeAfter (document): Specifies the logical starting point for the
78+
* new change stream.
8979
*
9080
* @param string $databaseName Database name
9181
* @param string $collectionName Collection name

0 commit comments

Comments
 (0)