CLI Reference
This page provides documentation for the command line arguments and options.
dbworkload
dbworkload v0.6.3: DBMS workload utility.
Usage:
dbworkload [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version, -v |
boolean | Print the version and exit | False |
--install-completion |
boolean | Install completion for the current shell. | None |
--show-completion |
boolean | Show completion for the current shell, to copy it or customize the installation. | None |
--help |
boolean | Show this message and exit. | False |
Subcommands
dbworkload run
Run the workload.
Usage:
dbworkload run [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--workload, -w |
file | Filepath to the workload module. | None |
--driver |
choice (postgres | mysql | maria | oracle | sqlserver | mongo | cassandra | spanner) |
DBMS driver. | None |
--uri |
text | The connection URI to the database. | None |
--procs, -x |
integer | Number of processes to spawn. Defaults to |
None |
--args |
text | JSON string, or filepath to a JSON/YAML file, to pass to Workload. | None |
-c, --concurrency |
integer | Number of concurrent workers. | 1 |
-r, --ramp |
integer | Ramp up time in seconds. | 0 |
-i, --iterations |
integer | Total number of iterations. Defaults to |
None |
-d, --duration |
integer | Duration in seconds. Defaults to |
None |
-k, --conn-duration |
integer | The number of seconds to keep database connection alive before restarting. Defaults to |
None |
--app-name, -a |
text | The application name specified by the client. Defaults to |
None |
--no-autocommit |
boolean | Unset autocommit in the connections. | True |
-p, --port |
integer | The port of the Prometheus server. | 26260 |
--quiet, -q |
boolean | Disable printing intermediate stats. | False |
--save, -s |
boolean | Save stats to CSV files. | False |
--log-level, -l |
choice (debug | info | warning | error) |
Set the logging level. | info |
--help |
boolean | Show this message and exit. | False |
dbworkload util
Various utils.
Usage:
dbworkload util [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- csv: Generate CSV files from a YAML data generation file.
- gen_stub: Generate a dbworkload class stub.
- html: Save charts to HTML from the dbworkload statistics CSV file.
- merge: Merge multiple sorted CSV files into 1+ files.
- merge_csvs: Merge multiple dbworkload statistic CSV files.
- plot: Plot charts from the dbworkload statistics CSV file.
- yaml: Generate YAML data generation file from a DDL SQL file.
dbworkload util csv
Generate CSV files from a YAML data generation file.
Usage:
dbworkload util csv [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--input, -i |
file | Filepath to the YAML data generation file. | _required |
--output, -o |
directory | Output directory for the CSV files. Defaults to |
None |
--procs, -x |
integer | Number of processes to spawn. Defaults to |
None |
--csv-max-rows |
integer | Max count of rows per resulting CSV file. | 100000 |
-n, --hostname |
text | The hostname of the http server that serves the CSV files. | localhost |
-p, --port |
integer | The port of the http server that servers the CSV files. | 3000 |
-c, --compression |
choice (bz2 | gzip | xz | zip) |
The compression format. | None |
-d, --delimiter |
text | The delimeter char to use for the CSV files. Defaults to "tab". | |
--help |
boolean | Show this message and exit. | False |
dbworkload util gen_stub
Generate a dbworkload class stub.
Usage:
dbworkload util gen_stub [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--input, -i |
file | Input SQL file | _required |
--help |
boolean | Show this message and exit. | False |
dbworkload util html
Save charts to HTML from the dbworkload statistics CSV file.
Usage:
dbworkload util html [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--input, -i |
file | Input CSV file | _required |
--help |
boolean | Show this message and exit. | False |
dbworkload util merge
Merge multiple sorted CSV files into 1+ files.
Usage:
dbworkload util merge [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--input, -i |
directory | Directory of files to be merged | _required |
--output, -o |
path | Output filepath. Defaults to .merged. | None |
--csv-max-rows |
integer | Max count of rows per resulting CSV file. | 100000 |
--help |
boolean | Show this message and exit. | False |
dbworkload util merge_csvs
Merge multiple dbworkload statistic CSV files.
Usage:
dbworkload util merge_csvs [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--input_dir, -i |
directory | Input CSV directory | _required |
--help |
boolean | Show this message and exit. | False |
dbworkload util plot
Plot charts from the dbworkload statistics CSV file.
Usage:
dbworkload util plot [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--input, -i |
file | Input CSV file | _required |
--help |
boolean | Show this message and exit. | False |
dbworkload util yaml
Generate YAML data generation file from a DDL SQL file.
Usage:
dbworkload util yaml [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--input, -i |
file | Filepath to the DDL SQL file. | _required |
--output, -o |
path | Output filepath. Defaults to |
None |
--help |
boolean | Show this message and exit. | False |