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.

Sign up for GitHub

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

Jump to bottom

Document VDiff2 Delete Action #1079

Merged
merged 3 commits into from
Jul 2, 2022
Merged

Document VDiff2 Delete Action #1079

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
23e581a
Document VDiff2 Delete Action
mattlord Jun 28, 2022
7afc1b1
Adjust verbose description (it apples to text too)
mattlord Jun 29, 2022
65e3ed4
Tweaks/corrections
mattlord Jun 29, 2022
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
38 changes: 35 additions & 3 deletions content/en/docs/15.0/reference/vreplication/vdiff2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ will be generated.

```
VDiff -- --v2 [--source_cell=<cell>] [--target_cell=<cell>] [--tablet_types=in_order:RDONLY,REPLICA,PRIMARY]
[--limit=<max rows to diff>] [--tables=<table list>] [--format=json] [--max_extra_rows_to_compare=1000]
[--limit=<max rows to diff>] [--tables=<table list>] [--format=json] [--verbose] [--max_extra_rows_to_compare=1000]
[--filtered_replication_wait_time=30s] [--debug_query] [--only_pks] <keyspace.workflow> create [<UUID>]
```

Expand Down Expand Up @@ -99,6 +99,31 @@ $ 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 <keyspace.workflow> delete [<UUID> | 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 status is completed on target shards

$ vtctlclient --server=localhost:15999 VDiff -- --v2 --format=json customer.commerce2customer delete all
{
"Action": "delete",
"Status": "completed"
}
```

{{< 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

VDiff does a row by row comparison of all tables associated with the workflow, diffing the
Expand Down Expand Up @@ -164,10 +189,17 @@ A comma separated list of tables to run vdiff on.

#### --format
**optional**\
**default** unstructured text output
**default** text (unstructured text output)

<div class="cmd">
Only other format supported is JSON
</div>

#### --verbose
**optional**

<div class="cmd">
Only other format supported is json
Show verbose vdiff output in summaries
</div>

#### --max_extra_rows_to_compare
Expand Down