Skip to main content

Usage

piicatcher

Usage:

$ piicatcher [OPTIONS] COMMAND [ARGS]...

Options:

  • --log-level TEXT: Logging Level [default: WARNING]
  • --log-data / --no-log-data: Choose output format type [default: False]
  • --log-scan / --no-log-scan: Log data that was scanned [default: False]
  • --output-format [tabular|json]: [default: tabular]
  • --catalog-path PATH: Path to store catalog state. Use if NOT using a database
  • --catalog-host TEXT: hostname of Postgres database. Use if catalog is a database.
  • --catalog-port INTEGER: port of Postgres database. Use if catalog is a database.
  • --catalog-user TEXT: user of Postgres database. Use if catalog is a database.
  • --catalog-password TEXT: password of Postgres database. Use if catalog is a database.
  • --catalog-database TEXT: database of Postgres database. Use if catalog is a database.
  • --version
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • scan

piicatcher scan

Usage:

$ piicatcher scan [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • athena
  • mysql
  • postgresql
  • redshift
  • snowflake
  • sqlite

piicatcher scan athena

Usage:

$ piicatcher scan athena [OPTIONS]

Options:

  • --name TEXT: A memorable name for the database [required]

  • --aws-access-key-id TEXT: AWS Access Key [required]

  • --aws-secret-access-key TEXT: AWS Secret Key [required]

  • --region-name TEXT: AWS Region Name [required]

  • --s3-staging-dir TEXT: S3 Staging Dir [required]

  • --scan-type [shallow|deep]: Choose deep(scan data) or shallow(scan column names only) [default: shallow]

  • --incremental / --no-incremental: Scan columns updated or created since last run [default: True]

  • --list-all / --no-list-all: List all columns. By default only columns with PII information is listed [default: False]

  • --include-schema TEXT: Scan only schemas matching schema; When this option is not specified, all non-system schemas in the target database will be dumped. Multiple schemas can be selected by writing multiple --include switches. Also, the schema parameter is interpreted as a regular expression, so multiple schemas can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards;

  • --exclude-schema TEXT: Do not scan any schemas matching the schema pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude schemas matching any of several patterns.

When both --include and ---exclude are given, the behavior is to dump just the schemas that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then schemas matching --exclude are excluded from what is otherwise a normal scan.")

  • --include-table TEXT: Scan only tables matching table. Multiple tables can be selected by writing multiple switches. Also, the table parameter is interpreted as a regular expression, so multiple tables can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards.

  • --exclude-table TEXT: Do not scan any tables matching the table pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude tables matching any of several patterns.

When both switches are given, the behavior is to dump just the tables that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then tables matching --exclude are excluded from what is otherwise a normal scan.

  • --help: Show this message and exit.

piicatcher scan mysql

Usage:

$ piicatcher scan mysql [OPTIONS]

Options:

  • --name TEXT: A memorable name for the database [required]

  • --username TEXT: Username or role to connect database [required]

  • --password TEXT: Password of username or role [required]

  • --database TEXT: Database name [required]

  • --uri TEXT: Hostname or URI of the database [required]

  • --port INTEGER: Port number of the database

  • --scan-type [shallow|deep]: Choose deep(scan data) or shallow(scan column names only) [default: shallow]

  • --incremental / --no-incremental: Scan columns updated or created since last run [default: True]

  • --list-all / --no-list-all: List all columns. By default only columns with PII information is listed [default: False]

  • --include-schema TEXT: Scan only schemas matching schema; When this option is not specified, all non-system schemas in the target database will be dumped. Multiple schemas can be selected by writing multiple --include switches. Also, the schema parameter is interpreted as a regular expression, so multiple schemas can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards;

  • --exclude-schema TEXT: Do not scan any schemas matching the schema pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude schemas matching any of several patterns.

When both --include and ---exclude are given, the behavior is to dump just the schemas that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then schemas matching --exclude are excluded from what is otherwise a normal scan.")

  • --include-table TEXT: Scan only tables matching table. Multiple tables can be selected by writing multiple switches. Also, the table parameter is interpreted as a regular expression, so multiple tables can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards.

  • --exclude-table TEXT: Do not scan any tables matching the table pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude tables matching any of several patterns.

When both switches are given, the behavior is to dump just the tables that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then tables matching --exclude are excluded from what is otherwise a normal scan.

  • --help: Show this message and exit.

piicatcher scan postgresql

Usage:

$ piicatcher scan postgresql [OPTIONS]

Options:

  • --name TEXT: A memorable name for the database [required]

  • --username TEXT: Username or role to connect database [required]

  • --password TEXT: Password of username or role [required]

  • --database TEXT: Database name [required]

  • --uri TEXT: Hostname or URI of the database [required]

  • --port INTEGER: Port number of the database

  • --scan-type [shallow|deep]: Choose deep(scan data) or shallow(scan column names only) [default: shallow]

  • --incremental / --no-incremental: Scan columns updated or created since last run [default: True]

  • --list-all / --no-list-all: List all columns. By default only columns with PII information is listed [default: False]

  • --include-schema TEXT: Scan only schemas matching schema; When this option is not specified, all non-system schemas in the target database will be dumped. Multiple schemas can be selected by writing multiple --include switches. Also, the schema parameter is interpreted as a regular expression, so multiple schemas can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards;

  • --exclude-schema TEXT: Do not scan any schemas matching the schema pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude schemas matching any of several patterns.

When both --include and ---exclude are given, the behavior is to dump just the schemas that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then schemas matching --exclude are excluded from what is otherwise a normal scan.")

  • --include-table TEXT: Scan only tables matching table. Multiple tables can be selected by writing multiple switches. Also, the table parameter is interpreted as a regular expression, so multiple tables can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards.

  • --exclude-table TEXT: Do not scan any tables matching the table pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude tables matching any of several patterns.

When both switches are given, the behavior is to dump just the tables that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then tables matching --exclude are excluded from what is otherwise a normal scan.

  • --help: Show this message and exit.

piicatcher scan redshift

Usage:

$ piicatcher scan redshift [OPTIONS]

Options:

  • --name TEXT: A memorable name for the database [required]

  • --username TEXT: Username or role to connect database [required]

  • --password TEXT: Password of username or role [required]

  • --database TEXT: Database name [required]

  • --uri TEXT: Hostname or URI of the database [required]

  • --port INTEGER: Port number of the database

  • --scan-type [shallow|deep]: Choose deep(scan data) or shallow(scan column names only) [default: shallow]

  • --incremental / --no-incremental: Scan columns updated or created since last run [default: True]

  • --list-all / --no-list-all: List all columns. By default only columns with PII information is listed [default: False]

  • --include-schema TEXT: Scan only schemas matching schema; When this option is not specified, all non-system schemas in the target database will be dumped. Multiple schemas can be selected by writing multiple --include switches. Also, the schema parameter is interpreted as a regular expression, so multiple schemas can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards;

  • --exclude-schema TEXT: Do not scan any schemas matching the schema pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude schemas matching any of several patterns.

When both --include and ---exclude are given, the behavior is to dump just the schemas that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then schemas matching --exclude are excluded from what is otherwise a normal scan.")

  • --include-table TEXT: Scan only tables matching table. Multiple tables can be selected by writing multiple switches. Also, the table parameter is interpreted as a regular expression, so multiple tables can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards.

  • --exclude-table TEXT: Do not scan any tables matching the table pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude tables matching any of several patterns.

When both switches are given, the behavior is to dump just the tables that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then tables matching --exclude are excluded from what is otherwise a normal scan.

  • --help: Show this message and exit.

piicatcher scan snowflake

Usage:

$ piicatcher scan snowflake [OPTIONS]

Options:

  • --name TEXT: A memorable name for the database [required]

  • --username TEXT: Username or role to connect database [required]

  • --password TEXT: Password of username or role [required]

  • --database TEXT: Database name [required]

  • --account TEXT: Snowflake Account Name [required]

  • --warehouse TEXT: Snowflake Warehouse Name [required]

  • --role TEXT: Snowflake Role Name [required]

  • --scan-type [shallow|deep]: Choose deep(scan data) or shallow(scan column names only) [default: shallow]

  • --incremental / --no-incremental: Scan columns updated or created since last run [default: True]

  • --list-all / --no-list-all: List all columns. By default only columns with PII information is listed [default: False]

  • --include-schema TEXT: Scan only schemas matching schema; When this option is not specified, all non-system schemas in the target database will be dumped. Multiple schemas can be selected by writing multiple --include switches. Also, the schema parameter is interpreted as a regular expression, so multiple schemas can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards;

  • --exclude-schema TEXT: Do not scan any schemas matching the schema pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude schemas matching any of several patterns.

When both --include and ---exclude are given, the behavior is to dump just the schemas that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then schemas matching --exclude are excluded from what is otherwise a normal scan.")

  • --include-table TEXT: Scan only tables matching table. Multiple tables can be selected by writing multiple switches. Also, the table parameter is interpreted as a regular expression, so multiple tables can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards.

  • --exclude-table TEXT: Do not scan any tables matching the table pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude tables matching any of several patterns.

When both switches are given, the behavior is to dump just the tables that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then tables matching --exclude are excluded from what is otherwise a normal scan.

  • --help: Show this message and exit.

piicatcher scan sqlite

Usage:

$ piicatcher scan sqlite [OPTIONS]

Options:

  • --name TEXT: A memorable name for the database [required]

  • --path PATH: File path to SQLite database [required]

  • --scan-type [shallow|deep]: Choose deep(scan data) or shallow(scan column names only) [default: shallow]

  • --incremental / --no-incremental: Scan columns updated or created since last run [default: True]

  • --list-all / --no-list-all: List all columns. By default only columns with PII information is listed [default: False]

  • --include-schema TEXT: Scan only schemas matching schema; When this option is not specified, all non-system schemas in the target database will be dumped. Multiple schemas can be selected by writing multiple --include switches. Also, the schema parameter is interpreted as a regular expression, so multiple schemas can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards;

  • --exclude-schema TEXT: Do not scan any schemas matching the schema pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude schemas matching any of several patterns.

When both --include and ---exclude are given, the behavior is to dump just the schemas that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then schemas matching --exclude are excluded from what is otherwise a normal scan.")

  • --include-table TEXT: Scan only tables matching table. Multiple tables can be selected by writing multiple switches. Also, the table parameter is interpreted as a regular expression, so multiple tables can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards.

  • --exclude-table TEXT: Do not scan any tables matching the table pattern. The pattern is interpreted according to the same rules as for --include. --exclude can be given more than once to exclude tables matching any of several patterns.

When both switches are given, the behavior is to dump just the tables that match at least one --include switch but no --exclude switches. If --exclude appears without --include, then tables matching --exclude are excluded from what is otherwise a normal scan.

  • --help: Show this message and exit.