Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document VStreamFlags.IncludeReshardJournalEvents #1844

Merged
merged 2 commits into from
Sep 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 33 additions & 26 deletions content/en/docs/21.0/reference/vreplication/vstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down