Commandline Options

This section documents the command line options and how they work.

General Options

The general options control the main functions of the tool.

Option Multiple Description
-h, --help - Display command line help information
--skip-queries-shape-explain-plan-execution - Skip attempt to use detected queries shapes to detect additional information
--skip-read-profile-collection - Skip attempting to queries the profile collection
--version - Display the command line version information

Notes

The --skip-queries-shape-explain-plan-execution disables the index recommendation engines attempts to grab the query explain plan for an existing compound index shape from MongoDB to be able to determine if the index is a multikey index.

The --skip-read-profile-collection disables the index recommendation engine’s attempt to read the system.profile collection to extract query shapes to create candidate indexes for the recommendation engine.

Logging Options

Allows for setting the logging options for the tool.

Options Multiple Description
--logpath - The path of the file we wish to log too
--quiet - Turn off all logging
-v, --verbosity Yes Set the verbosity of the logging

Connection Options

The connection options are options for the MongoDB connectivity.

Options Multiple Description
--uri - The MongoDB Connection URI

Extract Options

Outlines all options available when extracting schemas from MongoDB.

Options Multiple Values Description
--format ` - txt, json Set the output format of the Schema extraction, ex: [–output txt]
--mongolog Yes - One or more MongoDB logs to parse for analysis.
--namespace Yes - Add a namespace to analyse indexes for, format , ex: db1.coll
--output-directory - - Output directory for the extracted schemas, ex: --output-directory ./

Statistics Options

Outlines the all options available collection statistics.

Options Multiple Values Description
--bucket-resolution - millisecond, second, minute, hour, day The statistics gathering resolution (millisecond, second, minute, hour, day)