Document VStreamFlags.IncludeReshardJournalEvents (#1844)

* Document VStreamFlags.IncludeReshardJournalEvents Signed-off-by: Matt Lord <[email protected]> * Kick CI Signed-off-by: Matt Lord <[email protected]> --------- Signed-off-by: Matt Lord <[email protected]>
vitessio · Sep 21, 2024 · 6e3bd8c · 6e3bd8c
1 parent c02a198
commit 6e3bd8c
Showing 1 changed file with 33 additions and 26 deletions.
diff --git a/content/en/docs/21.0/reference/vreplication/vstream.md b/content/en/docs/21.0/reference/vreplication/vstream.md
@@ -91,19 +91,23 @@ events will be generated.
 
 #### VStreamFlags
 
-##### MinimizeSkew
+##### Cells
 
-**Type** bool\
-**Default** false
+**Type** string\
+**Default** ""
 
-When enabled the `vtgate` will keep the events in the stream roughly time aligned — it is aggregating streams coming
-from each of the shards involved — using the event timestamps to ensure the maximum time skew between the source
-tablet shard streams is kept under 10 minutes. When it detects skew between the source streams it will pause sending
-the client more events and allow the lagging shard(s) to catch up.
+If specified, these cells (comma-separated list) are used
+[when selecting stream source tablets](../tablet_selection/). When no value is specified the `vtgate` will
+default to looking for source tablets within its own local cell.
 
-{{< info >}}
-There is no strict ordering of events across shards and the client will need to examine the event timestamps.
-{{</ info >}}
+##### CellPreference
+
+**Type** string\
+**Default** ""
+
+If specified, this determines which cells to give preference to during [tablet selection](../tablet_selection/). 
+By default, `preferlocalwithalias` is used in order to give preference to the caller's local cell and then any alias its cell belongs to. 
+If `onlyspecified` is given, then only tablets within the specified `Cells` field value will be considered.
 
 ##### HeartbeatInterval
 
@@ -113,32 +117,35 @@ There is no strict ordering of events across shards and the client will need to
 How frequently, in seconds, to send heartbeat events to the client when there are no other events in the stream to
 send.
 
-##### StopOnReshard
+##### IncludeReshardJournalEvents
 
 **Type** bool\
 **Default** false
 
-When enabled the `vtgate` will send a reshard event to the client along with an `EOF`
-`error` in the [`VStreamReader.Recv`](https://pkg.go.dev/vitess.io/vitess/go/vt/vtgate/vtgateconn#VStreamReader)
-response and stop sending any further events.
+When enabled the `vtgate` will include reshard journal events in the stream along with all other events.
 
-##### Cells
+##### MinimizeSkew
 
-**Type** string\
-**Default** ""
+**Type** bool\
+**Default** false
 
-If specified, these cells (comma-separated list) are used
-[when selecting stream source tablets](../tablet_selection/). When no value is specified the `vtgate` will
-default to looking for source tablets within its own local cell.
+When enabled the `vtgate` will keep the events in the stream roughly time aligned — it is aggregating streams coming
+from each of the shards involved — using the event timestamps to ensure the maximum time skew between the source
+tablet shard streams is kept under 10 minutes. When it detects skew between the source streams it will pause sending
+the client more events and allow the lagging shard(s) to catch up.
 
-##### CellPreference
+{{< info >}}
+There is no strict ordering of events across shards and the client will need to examine the event timestamps.
+{{</ info >}}
 
-**Type** string\
-**Default** ""
+##### StopOnReshard
 
-If specified, this determines which cells to give preference to during [tablet selection](../tablet_selection/). 
-By default, `preferlocalwithalias` is used in order to give preference to the caller's local cell and then any alias its cell belongs to. 
-If `onlyspecified` is given, then only tablets within the specified `Cells` field value will be considered.
+**Type** bool\
+**Default** false
+
+When enabled the `vtgate` will send a reshard journal event to the client along with an `EOF`
+`error` in the [`VStreamReader.Recv`](https://pkg.go.dev/vitess.io/vitess/go/vt/vtgate/vtgateconn#VStreamReader)
+response and stop sending any further events.
 
 ##### TabletOrder