Skip to content

Commit

Permalink
Added --show-diffs to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
julien committed Feb 23, 2022
1 parent 6b57705 commit ec53163
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
7 changes: 7 additions & 0 deletions connectors/riot-redis/src/docs/asciidoc/compare.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,10 @@ We are now all set to begin the comparison process.
riot-redis -h <left host> -p <left port> compare -h <right host> -p <right port>
----

To show which keys are different use the `--show-diffs` option:

[source,console,subs="attributes,+quotes"]
----
riot-redis -h <left host> -p <left port> compare -h <right host> -p <right port> [red]#--show-diffs#
----

11 changes: 9 additions & 2 deletions connectors/riot-redis/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Can be smaller than the number of threads

Performance tuning is an art but {project-title} offers some facilities to identify potential bottlenecks. In addition to the <<batch,batch>> and <<threads,threads>> options you have the `--dry-run` option which disables writing to the target Redis database so that you can tune <<reader-options,reading>> in isolation. Add that option to your existing `replicate` command-line to compare replication speeds with and without writing to the target Redis database:

[source,console,subs=+quotes]
[source,console,subs="attributes,+quotes"]
----
[green]#riot-redis# <source> replicate <target> ... [red]#--dry-run#
----
Expand All @@ -101,7 +101,7 @@ The verification step happens automatically after the scan is complete (snapshot
Verification can also be run on-demand using the `compare` command:
[source,console]
----
riot-redis compare --help
riot-redis -h <left host> -p <left port> compare -h <right host> -p <right port>
----

The output looks like this:
Expand All @@ -118,6 +118,13 @@ The output looks like this:

include::{includedir}/architecture.adoc[leveloffset=+1]

To show which keys are different use the `--show-diffs` option:

[source,console,subs="attributes,+quotes"]
----
riot-redis -h <left host> -p <left port> compare -h <right host> -p <right port> [red]#--show-diffs#
----

=== Reader

image::reader-architecture.svg[]
Expand Down

0 comments on commit ec53163

Please sign in to comment.