From 23e581a60bb12a39a8c601fb115e9d5dfef3b2dd Mon Sep 17 00:00:00 2001 From: Matt Lord Date: Tue, 28 Jun 2022 16:27:19 -0400 Subject: [PATCH 1/3] Document VDiff2 Delete Action Signed-off-by: Matt Lord --- .../15.0/reference/vreplication/vdiff2.md | 37 +++++++++++++++++-- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/content/en/docs/15.0/reference/vreplication/vdiff2.md b/content/en/docs/15.0/reference/vreplication/vdiff2.md index 990326ca3..54ef160de 100644 --- a/content/en/docs/15.0/reference/vreplication/vdiff2.md +++ b/content/en/docs/15.0/reference/vreplication/vdiff2.md @@ -28,7 +28,7 @@ will be generated. ``` VDiff -- --v2 [--source_cell=] [--target_cell=] [--tablet_types=in_order:RDONLY,REPLICA,PRIMARY] - [--limit=] [--tables=] [--format=json] [--max_extra_rows_to_compare=1000] + [--limit=] [--tables=
] [--format=json] [--verbose] [--max_extra_rows_to_compare=1000] [--filtered_replication_wait_time=30s] [--debug_query] [--only_pks] create [] ``` @@ -99,6 +99,30 @@ $ vtctlclient --server=localhost:15999 VDiff -- --v2 --format=json customer.comm `show all` lists all vdiffs created for the specified keyspace and workflow. +#### Delete VDiff results + +``` +VDiff -- --v2 delete [ | all] +``` + +You can either delete a specific UUID or use the `all` shorthand to delete all VDiffs created for the specified keyspace and workflow. Example: + +``` +$ vtctlclient --server=localhost:15999 VDiff -- --v2 customer.commerce2customer delete all +VDiff delete is completed on target shards + +$ vtctlclient --server=localhost:15999 VDiff -- --v2 --format=json customer.commerce2customer delete all +{ + "Action": "delete", + "Status": "completed" +} +``` + +{{ }} +Deletes are idempotent, so attempting to delete VDiff data that does not exist is a no-op. +{{ }} + + ### Description VDiff does a row by row comparison of all tables associated with the workflow, diffing the @@ -164,10 +188,17 @@ A comma separated list of tables to run vdiff on. #### --format **optional**\ -**default** unstructured text output +**default** text (unstructured text output) + +
+Only other format supported is JSON +
+ +#### --verbose +**optional**\
-Only other format supported is json +Show full vdiff output in summaries (only applicable when using `JSON` format)
#### --max_extra_rows_to_compare From 7afc1b13afb5bd87809d7c1ba91a3e12ccf126a6 Mon Sep 17 00:00:00 2001 From: Matt Lord Date: Wed, 29 Jun 2022 02:14:52 -0400 Subject: [PATCH 2/3] Adjust verbose description (it apples to text too) Signed-off-by: Matt Lord --- content/en/docs/15.0/reference/vreplication/vdiff2.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/en/docs/15.0/reference/vreplication/vdiff2.md b/content/en/docs/15.0/reference/vreplication/vdiff2.md index 54ef160de..5d0328817 100644 --- a/content/en/docs/15.0/reference/vreplication/vdiff2.md +++ b/content/en/docs/15.0/reference/vreplication/vdiff2.md @@ -120,6 +120,8 @@ $ vtctlclient --server=localhost:15999 VDiff -- --v2 --format=json customer.comm {{ }} Deletes are idempotent, so attempting to delete VDiff data that does not exist is a no-op. + +All VDiff data associated with a VReplication workflow is deleted when the workflow is deleted. {{ }} @@ -198,7 +200,7 @@ Only other format supported is JSON **optional**\
-Show full vdiff output in summaries (only applicable when using `JSON` format) +Show verbose vdiff output in summaries
#### --max_extra_rows_to_compare From 65e3ed49fcf7a8e83df98ae8062ae5c750bc7289 Mon Sep 17 00:00:00 2001 From: Matt Lord Date: Wed, 29 Jun 2022 03:10:48 -0400 Subject: [PATCH 3/3] Tweaks/corrections Signed-off-by: Matt Lord --- content/en/docs/15.0/reference/vreplication/vdiff2.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/content/en/docs/15.0/reference/vreplication/vdiff2.md b/content/en/docs/15.0/reference/vreplication/vdiff2.md index 5d0328817..5d4ddee21 100644 --- a/content/en/docs/15.0/reference/vreplication/vdiff2.md +++ b/content/en/docs/15.0/reference/vreplication/vdiff2.md @@ -109,7 +109,7 @@ You can either delete a specific UUID or use the `all` shorthand to delete all V ``` $ vtctlclient --server=localhost:15999 VDiff -- --v2 customer.commerce2customer delete all -VDiff delete is completed on target shards +VDiff delete status is completed on target shards $ vtctlclient --server=localhost:15999 VDiff -- --v2 --format=json customer.commerce2customer delete all { @@ -118,12 +118,11 @@ $ vtctlclient --server=localhost:15999 VDiff -- --v2 --format=json customer.comm } ``` -{{ }} +{{< info >}} Deletes are idempotent, so attempting to delete VDiff data that does not exist is a no-op. All VDiff data associated with a VReplication workflow is deleted when the workflow is deleted. -{{ }} - +{{< /info >}} ### Description @@ -197,7 +196,7 @@ Only other format supported is JSON #### --verbose -**optional**\ +**optional**
Show verbose vdiff output in summaries