Skip to content

Add all CLI options and descriptions to README #21

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

Merged
merged 2 commits into from
Oct 2, 2024
Merged

Add all CLI options and descriptions to README #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5deba3a
Update README.md
tdq45gj Sep 23, 2024
748a4e1
Update README.md
tdq45gj Sep 23, 2024
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
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,34 @@ The verifier will now check to completion to make sure that there are no inconsi
`{"progress":{"phase":"idle","error":null,"verificationStatus":{"totalTasks":1,"addedTasks":0,"processingTasks":0,"failedTasks":1,"completedTasks":0,"metadataMismatchTasks":0,"recheckTasks":0}}}`


# CLI Options

| Flag | Description |
|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--configFile <value>` | path to an optional YAML config file |
| `--srcURI <URI>` | source Host URI for migration verification (default: "mongodb://localhost:27017") |
| `--dstURI <URI>` | destination Host URI for migration verification (default: "mongodb://localhost:27018") |
| `--metaURI <URI>` | host URI for storing migration verification metadata (default: "mongodb://localhost:27019") |
| `--serverPort <port>` | port for the control web server (default: 27020) |
| `--logPath <path>` | logging file path (default: "stdout") |
| `--numWorkers <number>` | number of worker threads to use for verification (default: 10) |
| `--generationPauseDelay <milliseconds>` | milliseconds to wait between generations of rechecking, allowing for more time to turn off writes (default: 1000) |
| `--workerSleepDelay <milliseconds>` | milliseconds workers sleep while waiting for work (default: 1000) |
| `--srcNamespace <namespaces>` | source namespaces to check |
| `--dstNamespace <namespaces>` | destination namespaces to check |
| `--metaDBName <name>` | name of the database in which to store verification metadata (default: "migration_verification_metadata") |
| `--ignoreFieldOrder` | Whether or not field order is ignored in documents |
| `--verifyAll` | If set, verify all user namespaces |
| `--clean` | If set, drop all previous verification metadata before starting |
| `--readPreference <value>` | Read preference for reading data from clusters. May be 'primary', 'secondary', 'primaryPreferred', 'secondaryPreferred', or 'nearest' (default: "primary") |
| `--partitionSizeMB <Megabytes>` | Megabytes to use for a partition. Change only for debugging. 0 means use partitioner default. (default: 0) |
| `--debug` | Turn on debug logging |
| `--checkOnly` | Do not run the webserver or recheck, just run the check (for debugging) |
| `--failureDisplaySize <value>` | Number of failures to display. Will display all failures if the number doesn’t exceed this limit by 25% (default: 20) |
| `--ignoreReadConcern` | Use connection-default read concerns rather than setting majority read concern. This option may degrade consistency, so only enable it if majority read concern (the default) doesn’t work. |
| `--help`, `-h` | show help |


# Benchmarking Results

Ran on m6id.metal + M40 with 3 replica sets
Expand Down