Document VStream

[mattlord]

And the new vstream copy resume work added in:

• VSCopy: Resume the copy phase consistently from given GTID and lastpk vitess#11103
• VSCopy: Send COPY_COMPLETED events when the copy operation is done vitess#11740

Quick link: https://deploy-preview-1216--vitess.netlify.app/docs/16.0/reference/vreplication/vstream/

Signed-off-by: Matt Lord [email protected]

[netlify]

✅ Deploy Preview for vitess ready!

Name	Link
🔨 Latest commit	83c7e99
🔍 Latest deploy log	https://app.netlify.com/sites/vitess/deploys/63af2bd46a070d0008e616e5
😎 Deploy Preview	https://deploy-preview-1216--vitess.netlify.app/docs/16.0/reference/vreplication/vstream
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[rohit-nayak-ps]

Great, we have been missing such a doc for VStream ...

Have suggested some changes/additions.

[rohit-nayak-ps]

Do we want to talk about the MySQL interface? It is not really a VStream API functionality, it is hacky and has minimal use/support ... We also don't want anyone to start depending on it.

[mattlord]

I think it's useful for debugging/testing. That's why I only call it out in that section.

[mattlord]

Just FYI, I'm going to try and finish this out tomorrow. I'll make some additions/changes based on @rohit-nayak-ps's feedback.

[yoheimuta]

And the new vstream copy resume work added in:
vitessio/vitess#11909

@mattlord Hi. As to vitessio/vitess#11909 (comment), is something missing in this request?
I was going to add the below commit.

commit

Commit: 241e00346d3bc7ce592b1d36f0d47389e92905b5 (HEAD -> vstream_docs)
Author: yoheimuta <[email protected]>
Date:   2022-12-14 19:15:29 +0900 (2 weeks ago)

Add info about the new ability to copy all tables in a keyspace or all tables in all keyspaces. It's added in https://github.com/vitessio/vitess/pull/11909
---
 .../en/docs/16.0/reference/vreplication/vstream.md | 31 ++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/content/en/docs/16.0/reference/vreplication/vstream.md b/content/en/docs/16.0/reference/vreplication/vstream.md
index 5f714c74..95a9f6d8 100644
--- a/content/en/docs/16.0/reference/vreplication/vstream.md
+++ b/content/en/docs/16.0/reference/vreplication/vstream.md
@@ -97,6 +97,37 @@ for {
     ...
 
+### Copy all tables in a keyspace
+```
+vgtid := &binlogdatapb.VGtid{
+  ShardGtids: []*binlogdatapb.ShardGtid{{
+    Keyspace: "ks",
+    Gtid: "",
+  }},
+}
+filter := &binlogdatapb.Filter{
+  Rules: []*binlogdatapb.Rule{{
+    Match: "/.*/",
+  }},
+}
+reader, err := gconn.VStream(ctx, topodatapb.TabletType_PRIMARY, vgtid, filter, flags)
+```
+
+### Copy all tables in all keyspaces
+```
+vgtid := &binlogdatapb.VGtid{
+  ShardGtids: []*binlogdatapb.ShardGtid{{
+    Gtid: "",
+  }},
+}
+filter := &binlogdatapb.Filter{
+  Rules: []*binlogdatapb.Rule{{
+    Match: "/.*/",
+  }},
+}
+reader, err := gconn.VStream(ctx, topodatapb.TabletType_PRIMARY, vgtid, filter, flags)
+```
+
 ## Debugging
 
 There is also an SQL interface that can be used for testing and debugging from a `vtgate`. Here's an example:

[mattlord]

And the new vstream copy resume work added in:
vitessio/vitess#11909

@mattlord Hi. As to vitessio/vitess#11909 (comment), is something missing in this request? I was going to add the below commit.

@yoheimuta I've added you as a collaborator on the website repo so you should be able to open PRs directly against the repo and push commits to PRs like this one. In this specific case though... I'm not 100% sure that will be the final syntax but I think it probably will. Our options are to include it in this one or do it separately. At this point it's a matter of timing: if the PR gets approved before this is merged then makes sense to include it. If not, then we can do it in a separate PR.

Thanks!

[rohit-nayak-ps]

lgtm

[rohit-nayak-ps]

@mattlord, since vitessio/vitess#11909 is still in progress, maybe we can remove it from the description and merge this now and document it in a separate PR.

[mattlord]

@mattlord, since vitessio/vitess#11909 is still in progress, maybe we can remove it from the description and merge this now and document it in a separate PR.

Sounds good. I'll remove it from the description here and we'll do a follow-up. Thanks!