Skip to content

Commit

Permalink
Document VStream
Browse files Browse the repository at this point in the history
And the new vstream copy resume work added in:
  vitessio/vitess#11103

Signed-off-by: Matt Lord <[email protected]>
  • Loading branch information
mattlord committed Nov 8, 2022
1 parent 33e1882 commit ee116d3
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions content/en/docs/16.0/reference/vreplication/vstream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: VStream
description: Change event streams
weight: 75
---

Vitess Gateways (`vtgate`) provide a `VStream` API that allows clients to subscribe
to a change event stream for a set of tables.

## Use Cases

* **Change Data Capture (CDC)**: `VStream` can be used to capture changes to a
table and send them to a downstream system. This is useful for building
real-time data pipelines.

## Overview

`VStream` supports copying the current contents of a table — as you will often not
have the binary logs going back to the creation of the table — and then begin streaming
new changes to the table from that point on. It also supports resuming this initial copy
phase if it's interrupted for any reason.

Events in the stream are [MySQL row based binary log events](https://dev.mysql.com/doc/refman/en/mysqlbinlog-row-events.html)
and can be processed by event bridges which support Vitess such as
[Debezium](https://debezium.io/documentation/reference/stable/connectors/vitess.html)
and to some extent bridges that support MySQL such as
[GoldenGate](https://docs.oracle.com/en/middleware/goldengate/core/21.3/gghdb/using-oracle-goldengate-mysql.html).
Other products such as [AirByte](https://airbyte.com) can also be used with [custom
Vitess connectors](https://docs.airbyte.com/connector-development/).

{{< warning >}}
We recommend Debezium as it has native Vitess support and has been used in production
environments by many Vitess users.
{{< /warning >}}

## API Details

## Notes

### More Reading

0 comments on commit ee116d3

Please sign in to comment.