CLI Reference¶
1 | |
| Option | Required | Description | Example |
|---|---|---|---|
--dialect <name> |
✔ | Database dialect to parse. Supported: access, ansi, athena, azuresql, bigquery, couchbase, dax, db2, exasol, firebird, generic, greenplum, hana, hive, impala, informix, mdx, mysql, mssql, netezza, odbc, openedge, oracle, postgresql, presto, redshift, snowflake, soql, sparksql, sybase, teradata, trino, vertica, databricks, gaussdb | --dialect postgresql |
--in <path> |
✔ | Input file, directory or glob pattern. If a directory is specified, all .sql files under it are scanned recursively. |
--in scripts/**/*.{sql,txt} |
--out <file> |
✖ | Output JSON file path. If omitted, output is printed to stdout. | --out report/detail.json |
--summary |
✖ (exclusive) | Enable CRUD summary mode (table-level analysis). Mutually exclusive with --pii and --dynamic. |
--summary |
--pii |
✖ (exclusive) | Enable PII (Personally Identifiable Information) detection mode. Requires --pii-list. |
--pii |
--pii-list <file> |
✖ | CSV file with PII column definitions. Required only when --pii is set. |
--pii-list config/pii-columns.csv |
--dynamic |
✖ (exclusive) | Enable dynamic SQL detection mode. Mutually exclusive with --summary and --pii. |
--dynamic |
--quiet |
✖ | Suppress all standard output; only errors will be printed to stderr. | --quiet |
--get-machine-code |
✖ | Print the machine code and exit. Useful for license generation. | --get-machine-code |
--show-license |
✖ | Display current license information and exit. | --show-license |
--help |
✖ | Show help message and usage instructions. | --help |
--version |
✖ | Show version information. | --version |
Exit Codes¶
| Code | Meaning |
|---|---|
0 |
Success, no parsing errors. |
1 |
General error (invalid arguments, IO failures, etc.). |
2 |
Unknown exception, refer to stack trace. |
To check the exit code after running SQLImpact:
- Windows (Command Prompt): echo %ERRORLEVEL%
- Windows (PowerShell): $LASTEXITCODE
- Linux/macOS: echo $?
Environment Variables¶
| Variable | Purpose |
|---|---|
SQLIMPACT_MAX_MEMORY |
Override JVM -Xmx setting for large batch jobs. |
For concrete walkthroughs, see the Examples page.