SchemaSmith Documentation
Command Line Options - MySQL (Enterprise)
Flags to standardize automation and logging across environments.
Flags to standardize automation and logging across environments.
All SchemaSmith Enterprise command-line tools (SchemaQuench, SchemaTongs, DataTongs, and SchemaHammer) share a common set of switches for configuration, logging, and licensing. SchemaQuench adds switches for checkpoint-based resume after deployment failures.
Switches can be passed directly on the command line or combined with configuration files
and environment variables. Command-line values take the highest priority, overriding
both appsettings.json settings and environment variables.
All switches accept a double-dash (--), single-dash (-), or forward-slash (/) prefix:
> SchemaQuench --ConfigFile:production.json
> SchemaQuench -ConfigFile:production.json
> SchemaQuench /ConfigFile:production.jsonValues are separated from the switch name by a colon (:) or equals sign (=):
--ConfigFile:production.json
--ConfigFile=production.jsonSwitch names are not case-sensitive. These are all equivalent:
--version
--Version
--VERSIONIf a value contains spaces, wrap it in quotes:
> SchemaQuench --ConfigFile:"C:\My Projects\settings.json"These switches are recognized by all SchemaSmith Enterprise tools: SchemaQuench, SchemaTongs, DataTongs, and SchemaHammer.
| Switch | Aliases | Description |
|---|---|---|
--version |
-v, --ver |
Print the tool version and license information, then exit. |
--help |
-h, -? |
Print command-line options, then exit. |
--ConfigFile:<path> |
Path to the configuration file. Overrides the default appsettings.json in the current working directory. |
|
--LogPath:<path> |
Directory for log output and backup directories. Defaults to the executable directory. | |
--LicenseFile:<path> |
Path to the license file. When not specified, the tools search the SCHEMASMITH_LICENSE environment variable, the tool directory, parent directories, and directories on PATH. |
In addition to the common switches, SchemaQuench supports these switches for checkpoint-based resume after deployment failures. SchemaTongs, DataTongs, and SchemaHammer accept only the common switches.
| Switch | Description |
|---|---|
--ResumeQuench |
Resume a previously interrupted quench from the last checkpoint. Without this flag, any existing checkpoint files are deleted and the quench starts from the beginning. See Checkpointing for details. |
--CheckpointDirectory:<path> |
Directory for checkpoint files that track quench progress. Overrides the CheckpointDirectory setting in appsettings.json. Defaults to the --LogPath directory. |
> SchemaQuench --ConfigFile:appsettings.staging.json
> SchemaTongs --ConfigFile:extract-config.json
> DataTongs --LicenseFile:"/opt/licenses/SchemaSmith License.lic"
> SchemaQuench --ResumeQuench --ConfigFile:appsettings.production.json
> SchemaQuench --version
> SchemaTongs --help