Provide options to PiiCatcher
PiiCatcher is invoked from the command line. It can take options from the command line or through a configuration file.
PiiCatcher functionality is organized into sub-commands. Sub-commands accept options specific to their functionality from the command-line or configuration files.
This document is also organized similarly. Common options are documented in this page. Sub-command options are documented in their respective pages.
--help will provide help in the top-level or any sub-command context.
Configuration File Format
PiiCatcher uses ConfigObj to parse configuration files. Config files have to be in ini format. For more details refer to ConfigObj 5 documentation
Common options are specified at the top-level. Sub command options are specified in a section with same name as sub command.
For example, options for aws sub-command are specified as follows:
|config||None||Path to configuration file|
|catalog-format||ascii_table||The format of the data catalog. |
|catalog-file||None||Path to catalog file. Valid if catalog-format is |
|catalog-host||None||Hostname of the database. Use if catalog has to be stored in a database|
|catalog-port||None||Port of database. Use if catalog has to be stored in a database|
|catalog-user||None||Username to connect database. Use if catalog has to be stored in a database|
|catalog-password||None||Password of the user. Use if catalog has to be stored in a database|