HammerDB

https://www.hammerdb.com/docs/
Admin
HammerDB is an open-source database benchmarking and stress testing tool that evaluates database...
Tokens:77,408
Snippets:835
Trust Score:9.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start HammerDB

Source: https://www.hammerdb.com/docs/ch01s11.html

Execute the hammerdb binary from within the installation directory to start the application.

```bash
./hammerdb
```

--------------------------------

### Python Directory Paths for Windows

Source: https://www.hammerdb.com/docs/ch01s17.html

Example paths for Python installation directories required for the build process on Windows.

```text
C:\Users\username\AppData\Local\Programs\Python\Python312
C:\Users\username\AppData\Local\Programs\Python\Python312\include
C:\Users\username\AppData\Local\Programs\Python\Python312\libs
```

--------------------------------

### Initialize HammerDB CLI

Source: https://www.hammerdb.com/docs/ch01s13.html

Start the HammerDB CLI from the installation directory to initialize the jobs database.

```bash
ubuntu@ubuntu24:/opt/hammerdb-ci/HammerDB-6.0$ ./hammerdbcli

HammerDB CLI v6.0
Copyright © HammerDB Ltd hosted by tpc.org 2019-2026
Type "help" for a list of commands
Initialized new Jobs on-disk database /opt/hammerdb-ci/TMP/hammer.DB
```

--------------------------------

### Start HammerDB CLI on Linux

Source: https://www.hammerdb.com/docs/ch09s01.html

Execute the hammerdbcli binary from the installation directory to enter interactive mode.

```bash
ubuntu@ubuntu24:/opt/HammerDB-6.0$ ./hammerdbcli 
HammerDB CLI v6.0
Copyright © HammerDB Ltd hosted by tpc.org 2019-2026
Type "help" for a list of commands
Initialized new Jobs on-disk database /tmp/hammer.DB
hammerdb>
```

--------------------------------

### Start the HammerDB Metric Agent on Linux

Source: https://www.hammerdb.com/docs/ch07s01.html

Execute the agent binary directly from the terminal within the installation directory.

```bash
$./agent 
Initializing HammerDB Metric Agent 6.0
HammerDB Metric Agent active @ id 15224 hostname ubuntu24 (Ctrl-C to Exit)
```

--------------------------------

### Manual Pipeline Execution Examples

Source: https://www.hammerdb.com/docs/ch01s13.html

Examples of triggering various pipeline types for MariaDB using different reference types.

```text
hammerdb>cipush refs/heads/11.8 single C maria 0
hammerdb>cipush refs/tags/mariadb-12.3.2 profile C maria 0
hammerdb>cipush refs/heads/11.8 compare C maria 0
hammerdb>cipush d33f879aec858063edd17aa2daa46db03abb2bae profile C maria 0
```

--------------------------------

### metstart

Source: https://www.hammerdb.com/docs/ch09s03.html

Starts the CPU Metrics and agent if configured to the localhost.

```APIDOC
## metstart

### Description
Starts the CPU Metrics and agent if configured to the localhost.

### Usage
metstart
```

--------------------------------

### Start CI Listener

Source: https://www.hammerdb.com/docs/ch01s13.html

Launch the CI listener using the cilisten command to begin monitoring.

```bash
ubuntu@ubuntu24:/opt/hammerdb-ci/HammerDB-6.0$ ./hammerdbcli

HammerDB CLI v6.0
Copyright © HammerDB Ltd hosted by tpc.org 2019-2026
Type "help" for a list of commands
Initialized Jobs on-disk database /opt/hammerdb-ci/TMP/hammer.DB using existing tables (86,016 bytes)
hammerdb>cilisten
CI validation passed
CI reset: no blocked CI pipeline rows found
CI TMP: /opt/hammerdb-ci/TMP
CI listener: port 5000
CI log: /opt/hammerdb-ci/TMP/hammerdbci.log
CI watcher: initializing
CI watcher started.
```

--------------------------------

### Install HammerDB via APT

Source: https://www.hammerdb.com/docs/ch01s11.html

Install the HammerDB .deb package on Ubuntu using apt-get.

```bash
ubuntu@ubuntu24:~$ sudo apt-get install -f ./hammerdb_6.0-1.ubu24.amd64.deb
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
Note, selecting 'hammerdb' instead of './hammerdb_6.0-1.ubu24.amd64.deb'
The following additional packages will be installed:
  libmariadb3 libpq5 mariadb-common mysql-common
The following NEW packages will be installed:
  hammerdb libmariadb3 libpq5 mariadb-common mysql-common
0 upgraded, 5 newly installed, 0 to remove and 317 not upgraded.
Need to get 0 B/34.3 MB of archives.
After this operation, 45.3 MB of additional disk space will be used.
Do you want to continue? [Y/n] Y
```

--------------------------------

### Install Linux Build Dependencies

Source: https://www.hammerdb.com/docs/ch01s17.html

Commands to install the necessary development tools, p7zip, and graphics libraries on Red Hat Linux.

```bash
yum install p7zip-16.02-20.el8.x86_64.rpm
sudo yum install libXft-devel
yum group install "Development Tools"
```

--------------------------------

### Example XML Configuration

Source: https://www.hammerdb.com/docs/ch01s15.html

Shows the structure of the sqlitedb configuration block within XML files.

```xml
   <sqlitedb>
        <sqlitedb_dir>TMP</sqlitedb_dir>
   </sqlitedb>
```

--------------------------------

### Step Workload Configuration Summary

Source: https://www.hammerdb.com/docs/ch04s08.html

Example output showing the timing and load distribution for a primary and four replica instances.

```text
primary starts immediately, runs rampup for 2 minutes then runs test for 5 minutes with 2 Active VU
replica1 starts 1 minutes after rampup completes and runs test for 4 minutes with 2 Active VU
replica2 starts 1 minutes after previous replica starts and runs test for 3 minutes with 2 Active VU
replica3 starts 1 minutes after previous replica starts and runs test for 2 minutes with 2 Active VU
replica4 starts 1 minutes after previous replica starts and runs test for 1 minutes with 2 Active VU
```

--------------------------------

### tcstart

Source: https://www.hammerdb.com/docs/ch09s03.html

Starts the Transaction Counter.

```APIDOC
## tcstart

### Description
Starts the Transaction Counter.

### Usage
tcstart
```

--------------------------------

### Full Build Sequence Examples

Source: https://www.hammerdb.com/docs/ch01s17.html

Complete command sequences for setting environment variables and running the build script on Linux and Windows.

```bash
$ export PG_CONFIG=/opt/postgresql-17.2/bin
$ export MARIADB_CONFIG=/opt/mariadb-11.4.4-linux-systemd-x86_64/bin
$ export MYSQL_CONFIG=/opt/mysql-8.4.4-linux-glibc2.28-x86_64/bin
$ echo $IBM_DB_DIR /opt/ibm/sqllib
$ ./Build-Linux.sh x64 Setup/HammerDB-Linux.bawt update
```

```batch
set MARIADB_CONFIG=C:\Program Files\MariaDB\MariaDB Connector C 64-bit
set MYSQL_CONFIG=C:\Program Files\MySQL\MySQL Server 8.4
set PG_CONFIG=C:\Program Files\PostgreSQL\17\bin
set IBM_DB_DIR=C:\Program Files\IBM\SQLLIB
set PYTHONHOME=C:\Users\smsha\AppData\Local\Programs\Python\Python312
Build-Windows.bat x64 vs2022+gcc Setup\HammerDB-Windows.bawt update
```

--------------------------------

### HammerDB CLI Step Execution Example

Source: https://www.hammerdb.com/docs/ch04s08.html

Interactive CLI session demonstrating dictionary settings, parameter updates, and the initiation of a steprun.

```text
HammerDB CLI v6.0
Copyright © HammerDB Ltd hosted by tpc.org 2019-2026
Type "help" for a list of commands
Initialized Jobs on-disk database C:/Users/smsha/AppData/Local/Temp/hammer.DB using existing tables (110,592 bytes)
hammerdb>print dict
Dictionary Settings for MSSQLServer
connection {
 mssqls_server             = (local)
 mssqls_linux_server       = localhost
 mssqls_tcp                = false
 mssqls_port               = 1433
 mssqls_azure              = false
 mssqls_authentication     = windows
 mssqls_msi_object_id      = null
 mssqls_linux_authent      = sql
 mssqls_odbc_driver        = ODBC Driver 18 for SQL Server
 mssqls_linux_odbc         = ODBC Driver 18 for SQL Server
 mssqls_uid                = sa
 mssqls_pass               = admin
 mssqls_encrypt_connection = true
 mssqls_trust_server_cert  = true
}
tpcc       {
 mssqls_count_ware       = 1
 mssqls_num_vu           = 1
 mssqls_dbase            = tpcc
 mssqls_imdb             = false
 mssqls_bucket           = 1
 mssqls_durability       = SCHEMA_AND_DATA
 mssqls_use_bcp          = true
 mssqls_total_iterations = 10000000
 mssqls_raiseerror       = false
 mssqls_keyandthink      = false
 mssqls_checkpoint       = false
 mssqls_driver           = timed
 mssqls_rampup           = 0
 mssqls_duration         = 1
 mssqls_allwarehouse     = false
 mssqls_timeprofile      = true
 mssqls_async_scale      = false
 mssqls_async_client     = 10
 mssqls_async_verbose    = false
 mssqls_async_delay      = 1000
 mssqls_connect_pool     = false
}

hammerdb>diset tpcc mssqls_rampup 2
Changed tpcc:mssqls_rampup from 0 to 2 for MSSQLServer

hammerdb>diset tpcc mssqls_duration 5
Changed tpcc:mssqls_duration from 1 to 5 for MSSQLServer

hammerdb>print dict
Dictionary Settings for MSSQLServer
connection {
 mssqls_server             = (local)
 mssqls_linux_server       = localhost
 mssqls_tcp                = false
 mssqls_port               = 1433
 mssqls_azure              = false
 mssqls_authentication     = windows
 mssqls_msi_object_id      = null
 mssqls_linux_authent      = sql
 mssqls_odbc_driver        = ODBC Driver 18 for SQL Server
 mssqls_linux_odbc         = ODBC Driver 18 for SQL Server
 mssqls_uid                = sa
 mssqls_pass               = admin
 mssqls_encrypt_connection = true
 mssqls_trust_server_cert  = true
}
tpcc       {
 mssqls_count_ware       = 1
 mssqls_num_vu           = 1
 mssqls_dbase            = tpcc
 mssqls_imdb             = false
 mssqls_bucket           = 1
 mssqls_durability       = SCHEMA_AND_DATA
 mssqls_use_bcp          = true
 mssqls_total_iterations = 10000000
 mssqls_raiseerror       = false
 mssqls_keyandthink      = false
 mssqls_checkpoint       = false
 mssqls_driver           = timed
 mssqls_rampup           = 2
 mssqls_duration         = 5
 mssqls_allwarehouse     = false
 mssqls_timeprofile      = true
 mssqls_async_scale      = false
 mssqls_async_client     = 10
 mssqls_async_verbose    = false
 mssqls_async_delay      = 1000
 mssqls_connect_pool     = false
}

hammerdb>diset tpcc mssqls_timeprofile false
Changed tpcc:mssqls_timeprofile from true to false for MSSQLServer

hammerdb>steprun
primary starts immediately, runs rampup for 2 minutes then runs test for 5 minutes with 2 Active VU
```

--------------------------------

### Execute Web Service from Installation Directory

Source: https://www.hammerdb.com/docs/ch10s02.html

Run the hammerdbws executable directly with specific arguments to control startup behavior.

```bash
./hammerdbws
./hammerdbws wait
./hammerdbws nowait
./hammerdbws scgi
```

--------------------------------

### Initialize HammerDB CI Environment

Source: https://www.hammerdb.com/docs/ch01s13.html

Set the temporary directory and start the listener to prepare for pipeline execution.

```bash
ubuntu@ubuntu24:/opt/hammerdb-ci/HammerDB-6.0$ export TMP=/opt/hammerdb-ci/TMP
ubuntu@ubuntu24:/opt/hammerdb-ci/HammerDB-6.0$ ./hammerdbcli

hammerdb>cifix
hammerdb>citmp
hammerdb>cilisten
hammerdb>cistatus
```

--------------------------------

### cilisten

Source: https://www.hammerdb.com/docs/ch09s03.html

Starts the CI GitHub webhook listener and job watcher on Linux/Unix.

```APIDOC
## cilisten

### Description
Starts the CI GitHub webhook listener and job watcher on Linux/Unix. At startup cilisten runs cireset to clear stale blocking CI rows.

### Usage
cilisten
```

--------------------------------

### PostgreSQL/Redshift: Example Table Creation DDL

Source: https://www.hammerdb.com/docs/ch13s03.html

This is an example of a CREATE TABLE statement generated by pg_dump for PostgreSQL or Redshift.

```sql
CREATE TABLE customer (
    c_custkey numeric NOT NULL,
    c_mktsegment character(10),
    c_nationkey numeric,
    c_name character varying(25),
    c_address character varying(40),
    c_phone character(15),
    c_acctbal numeric,
    c_comment character varying(118)
);
```

--------------------------------

### Verify HammerDB Installation Directory

Source: https://www.hammerdb.com/docs/ch01s11.html

Confirm the installation path and default file ownership after installation.

```bash
[root@localhost HammerDB-6.0]# pwd
/opt/HammerDB-6.0
```

```bash
root@localhost HammerDB-6.0]# ls -l
total 31124
drwxr-xr-x. 2 root root       19 Apr  9 14:28 agent
drwxr-xr-x. 3 root root     4096 Apr  9 14:28 config
-rwxr-xr-x. 1 root root 12819442 Mar 24 14:18 hammerdb
-rwxr-xr-x. 1 root root 11022274 Mar 24 14:18 hammerdbcli
-rwxr-xr-x. 1 root root  7981127 Mar 24 14:18 hammerdbws
-rw-r--r--. 1 root root    35149 Mar 24 14:18 LICENSE
drwxr-xr-x. 3 root root       24 Mar 24 14:18 pylib
-rw-r--r--. 1 root root      518 Mar 24 14:18 README.md
drwxr-xr-x. 4 root root       31 Apr  9 14:28 scripts
```

--------------------------------

### Install Xft Font Library

Source: https://www.hammerdb.com/docs/ch01s04.html

Installs the Xft FreeType-based font drawing library required for the HammerDB GUI.

```bash
$ sudo apt-get install libxft-dev
```

```bash
$ yum install libXft
```

--------------------------------

### Oracle Instant Client Filename

Source: https://www.hammerdb.com/docs/ch01s14.html

Example of the Oracle Instant Client zip file naming convention.

```text
instantclient-basic-linux.x64-21.17.0.0.0dbru.zip
```

--------------------------------

### Start HammerDB Web Service

Source: https://www.hammerdb.com/docs/ch01s13.html

Commands to set the environment variable and launch the HammerDB web service executable.

```bash
ubuntu@ubuntu24:/opt/hammerdb-ci/HammerDB-6.0$ export TMP=/opt/hammerdb-ci/TMP

ubuntu@ubuntu24:/opt/hammerdb-ci/HammerDB-6.0$ ./hammerdbws
HammerDB Web Service v6.0
Copyright © HammerDB Ltd hosted by tpc.org 2019-2026
Type "help" for a list of commands
Web Service using /opt/hammerdb-ci/TMP/hammer.DB database
Listening for HTTP requests on TCP port 8080
```

--------------------------------

### Install Cairo Graphics Library

Source: https://www.hammerdb.com/docs/ch01s04.html

Installs the Cairo Graphics library required to support the graphical transaction counter in the HammerDB GUI.

```bash
$ sudo apt-get install libcairo2-dev
```

```bash
$ yum install cairo-devel
```

--------------------------------

### Setting Dictionary Variables

Source: https://www.hammerdb.com/docs/ch09s03.html

Examples of using diset and giset to modify configuration variables for databases and generic settings.

```text
hammerdb>diset tpcc count_ware 10 Changed tpcc:count_ware from 1 to 10 for Oracle.
```

```text
hammerdb>giset commandline keepalive_margin 60 Changed commandline:keepalive_margin from 10 to 60 for generic
```

--------------------------------

### steprun

Source: https://www.hammerdb.com/docs/ch09s03.html

Automatically switches into Primary mode and starts a step workload.

```APIDOC
## steprun

### Description
Automatically switches into Primary mode, creates and connects the multiple Replicas defined in config/steps.xml and starts the Primary and Replica Virtual Users at the defined intervals creating a step workload.

### Usage
steprun
```

--------------------------------

### Run HammerDB Container with Host Network

Source: https://www.hammerdb.com/docs/ch01s12.html

Command to start a container with host network access for database connectivity.

```bash
 docker run --network=host -it --name hammerdb hammerdb-v6.0 bash
```

--------------------------------

### Run HammerDB Workload

Source: https://www.hammerdb.com/docs/ch09s08.html

Commands to start the transaction counter, metrics agent, and execute the benchmark script.

```text
hammerdb>tcstart
Transaction Counter Started
hammerdb>0 MSSQLServer tpm
hammerdb>metstart
Starting Local Metrics Agent on raven
after#244
hammerdb>Initializing HammerDB Metric Agent 6.0
HammerDB Metric Agent active @ id 27768 hostname raven (Ctrl-C to Exit)
Connecting to Agent to Display CPU Metrics
Metric receive port open @ 15748 on raven
Connecting to HammerDB Agent @ raven:27768
Testing Agent Connectivity...OK
Received a new display request from host fe80::a3b7:309e:a58d:3658%11
Metrics Connected
New display accepted @ 15748 raven
Prepared CPU metrics for Intel(R) Core(TM) i9-14900KS
12 MSSQLServer tpm
Started CPU Metrics for Intel(R) Core(TM) i9-14900KS:(32 CPUs)
Sending CPU metrics to 15748 raven ...connection established
hammerdb>vurun
Script loaded, Type "print script" to view
Vuser 1 created MONITOR - WAIT IDLE
Vuser 2 created - WAIT IDLE
Vuser 3 created - WAIT IDLE
Vuser 4 created - WAIT IDLE
Vuser 5 created - WAIT IDLE
Logging activated
to C:/temp/hammerdb.log
5 Virtual Users Created with Monitor VU
Vuser 1:RUNNING
Vuser 1:DBVersion:16.0.1135.2
Vuser 1:Beginning rampup time of 1 minutes
Vuser 2:RUNNING
Vuser 2:Processing 10000000 transactions with output suppressed...
Vuser 3:RUNNING
Vuser 3:Processing 10000000 transactions with output suppressed...
Vuser 4:RUNNING
Vuser 4:Processing 10000000 transactions with output suppressed...
Vuser 5:RUNNING
Vuser 5:Processing 10000000 transactions with output suppressed...
CPU all usr%-0.00 sys%-0.00 irq%-0.00 idle%-0.00
339216 MSSQLServer tpm
CPU all usr%-9.64 sys%-1.23 irq%-0.22 idle%-89.01
707682 MSSQLServer tpm
CPU all usr%-9.48 sys%-1.39 irq%-0.27 idle%-89.25
700632 MSSQLServer tpm
CPU all usr%-9.55 sys%-1.09 irq%-0.15 idle%-88.92
675360 MSSQLServer tpm
CPU all usr%-10.52 sys%-1.29 irq%-0.25 idle%-88.38
759096 MSSQLServer tpm
CPU all usr%-10.14 sys%-1.26 irq%-0.19 idle%-88.48
726372 MSSQLServer tpm
Vuser 1:Rampup 1 minutes complete ...
Vuser 1:Rampup complete, Taking start Transaction Count.
Vuser 1:Timing test period of 3 in minutes
CPU all usr%-10.04 sys%-1.27 irq%-0.23 idle%-88.69
741852 MSSQLServer tpm
CPU all usr%-10.84 sys%-1.30 irq%-0.26 idle%-87.94
738720 MSSQLServer tpm
CPU all usr%-10.26 sys%-1.36 irq%-0.21 idle%-88.16
707208 MSSQLServer tpm
CPU all usr%-10.31 sys%-1.29 irq%-0.19 idle%-87.94
736344 MSSQLServer tpm
CPU all usr%-10.49 sys%-1.31 irq%-0.20 idle%-88.53
798300 MSSQLServer tpm
CPU all usr%-8.60 sys%-1.15 irq%-0.21 idle%-90.32
633126 MSSQLServer tpm
Vuser 1:1 ...,
CPU all usr%-9.63 sys%-1.14 irq%-0.20 idle%-89.01
709704 MSSQLServer tpm
CPU all usr%-9.96 sys%-1.36 irq%-0.23 idle%-88.48
715080 MSSQLServer tpm
CPU all usr%-9.32 sys%-1.37 irq%-0.25 idle%-88.89
696954 MSSQLServer tpm
CPU all usr%-9.82 sys%-1.37 irq%-0.21 idle%-88.90
693246 MSSQLServer tpm
CPU all usr%-10.60 sys%-1.24 irq%-0.28 idle%-88.34
787812 MSSQLServer tpm
CPU all usr%-10.14 sys%-1.62 irq%-0.21 idle%-88.12
705366 MSSQLServer tpm
Vuser 1:2 ...,
CPU all usr%-9.94 sys%-1.30 irq%-0.22 idle%-88.89
724170 MSSQLServer tpm
CPU all usr%-9.21 sys%-1.15 irq%-0.12 idle%-89.04
687822 MSSQLServer tpm
CPU all usr%-9.28 sys%-1.21 irq%-0.19 idle%-89.94
701604 MSSQLServer tpm
CPU all usr%-9.03 sys%-1.15 irq%-0.19 idle%-89.85
709374 MSSQLServer tpm
CPU all usr%-11.77 sys%-1.80 irq%-0.24 idle%-85.23
743028 MSSQLServer tpm
CPU all usr%-9.99 sys%-1.45 irq%-0.18 idle%-89.20
706362 MSSQLServer tpm
Vuser 1:3 ...,
Vuser 1:Test complete, Taking end Transaction Count.
Vuser 1:4 Active Virtual Users configured
Vuser 1:TEST RESULT : System achieved 306939 NOPM from 713241 SQL Server TPM
Vuser 1:FINISHED SUCCESS
Vuser 3:FINISHED SUCCESS
Vuser 5:FINISHED SUCCESS
Vuser 2:FINISHED SUCCESS
Vuser 4:FINISHED SUCCESS
ALL VIRTUAL USERS COMPLETE
Benchmark Run jobid=67FD2A43565C03E223637343
```

--------------------------------

### Python Script for HammerDB CLI

Source: https://www.hammerdb.com/docs/ch09s10.html

Example script demonstrating configuration, loading, and execution of a test sequence with varying virtual user counts.

```python
print("SETTING CONFIGURATION")
dbset('db','mssqls')
diset('tpcc','mssqls_driver','timed')
diset('tpcc','mssqls_rampup',0)
diset('tpcc','mssqls_duration',1)
vuset('logtotemp',1)
loadscript()
print("SEQUENCE STARTED")
for z in [1,2,4]:
 print(z," VU TEST")
 vuset('vu',z)
 vucreate()
 vurun()
 vudestroy()

print("TEST SEQUENCE COMPLETE")
```

--------------------------------

### View Performance Test Results

Source: https://www.hammerdb.com/docs/ch04s08.html

Example output showing NOPM, SQL Server TPM, and client-side transaction metrics for a virtual user.

```text
Vuser 1:2 Active Virtual Users configured
Vuser 1:TEST RESULT : System achieved 26207 NOPM from 180515 SQL Server TPM
Vuser 1:CLIENT SIDE TPM : neworder 78319 payment 78185 delivery 7855 stocklevel 7826 orderstatus 7809
```

--------------------------------

### Configure Db2 db2cli.ini

Source: https://www.hammerdb.com/docs/ch04s02.html

Example configuration settings for the Db2 CLI interface, including timeout and isolation parameters.

```ini
[db2inst1@~/sqllib/cfg]$ more db2cli.ini 
[TPCC]
UID=db2inst1
PWD=ibmdb2
SysSchema=SYSIBM
SchemaList=”’SYSIBM’,’TPCC’”
DeferredPrepare=1
ConnectTimeout=10
ReceiveTimeout=120
LockTimeout=-1
AppendForFetchOnly=0
AutoCommit=1
ConnectType=1
CursorHold=OFF
TxnIsolation=1
StmtConcentrator=OFF
```

--------------------------------

### Create Oracle Tablespace

Source: https://www.hammerdb.com/docs/ch04s02.html

Example SQL command to create a bigfile tablespace in an ASM disk group for Oracle.

```sql
SQL> create bigfile tablespace tpcctab datafile '+DATA' size 100g; 
```

--------------------------------

### Configure and Run Data Generation via CLI

Source: https://www.hammerdb.com/docs/ch13s02.html

Use these commands to set generation parameters and start the data generation process in the HammerDB CLI.

```text
Copyright © HammerDB Ltd hosted by tpc.org 2019-2026
Type "help" for a list of commands
Initialized Jobs on-disk database C:/temp/hammer.DB using existing tables (630,784 bytes)
hammerdb>print datagen
Data Generation set to build a TPC-H schema for MSSQLServer with 1 scale factor with 1 virtual users in C:\temp

hammerdb>dgset scale_fact 10

hammerdb>dgset vu 20
Set virtual users to 20 for data generation

hammerdb>dgset directory C:/temp/TPCHDATA

hammerdb>print datagen
Data Generation set to build a TPC-H schema for MSSQLServer with 10 scale factor with 20 virtual users in C:/temp/TPCHDATA

hammerdb>datagenrun
Ready to generate the data for a 10 Scale Factor MSSQLServer TPROC-H schema
in directory C:/temp/TPCHDATA ?
Enter yes or no: replied yes
Vuser 1 created - WAIT IDLE
Vuser 2 created - WAIT IDLE
Vuser 3 created - WAIT IDLE
Vuser 4 created - WAIT IDLE
Vuser 5 created - WAIT IDLE
Vuser 6 created - WAIT IDLE
Vuser 7 created - WAIT IDLE
Vuser 8 created - WAIT IDLE
Vuser 9 created - WAIT IDLE
Vuser 10 created - WAIT IDLE
Vuser 11 created - WAIT IDLE
Vuser 12 created - WAIT IDLE
Vuser 13 created - WAIT IDLE
Vuser 14 created - WAIT IDLE
Vuser 15 created - WAIT IDLE
Vuser 16 created - WAIT IDLE
Vuser 17 created - WAIT IDLE
Vuser 18 created - WAIT IDLE
Vuser 19 created - WAIT IDLE
Vuser 20 created - WAIT IDLE
Vuser 21 created - WAIT IDLE
Vuser 1:RUNNING
Vuser 1:Monitor Thread
Vuser 1:Generating REGION...
Vuser 1:Opened File C:/temp/TPCHDATA/region_1.tbl
Vuser 1:Generating REGION COMPLETE
Vuser 1:Generating NATION...
Vuser 1:Opened File C:/temp/TPCHDATA/nation_1.tbl
Vuser 1:Generating NATION COMPLETE
Vuser 1:Monitoring Workers...
Vuser 2:RUNNING
Vuser 2:Worker Thread
Vuser 2:Waiting for Monitor Thread...
Vuser 2:Generating SUPPLIER...
Vuser 2:Opened File C:/temp/TPCHDATA/supplier_1.tbl
Vuser 2:SUPPLIER Done Rows 1..5000
Vuser 2:Generating CUSTOMER...
Vuser 2:Opened File C:/temp/TPCHDATA/customer_1.tbl
Vuser 3:RUNNING
Vuser 3:Worker Thread
Vuser 3:Waiting for Monitor Thread...
Vuser 3:Generating SUPPLIER...
Vuser 3:Opened File C:/temp/TPCHDATA/supplier_2.tbl
Vuser 3:Generating SUPPLIER...10000
Vuser 3:SUPPLIER Done Rows 5001..10000
Vuser 3:Generating CUSTOMER...
Vuser 3:Opened File C:/temp/TPCHDATA/customer_2.tbl
Vuser 4:RUNNING
Vuser 4:Worker Thread
Vuser 4:Waiting for Monitor Thread...
Vuser 4:Generating SUPPLIER...
Vuser 4:Opened File C:/temp/TPCHDATA/supplier_3.tbl
Vuser 4:SUPPLIER Done Rows 10001..15000
Vuser 4:Generating CUSTOMER...
Vuser 4:Opened File C:/temp/TPCHDATA/customer_3.tbl
Vuser 5:RUNNING
Vuser 5:Worker Thread
Vuser 5:Waiting for Monitor Thread...
Vuser 5:Generating SUPPLIER...
Vuser 5:Opened File C:/temp/TPCHDATA/supplier_4.tbl
Vuser 5:Generating SUPPLIER...20000
Vuser 5:SUPPLIER Done Rows 15001..20000
Vuser 5:Generating CUSTOMER...
Vuser 5:Opened File C:/temp/TPCHDATA/customer_4.tbl
Vuser 6:RUNNING
Vuser 6:Worker Thread
Vuser 6:Waiting for Monitor Thread...
Vuser 6:Generating SUPPLIER...
Vuser 6:Opened File C:/temp/TPCHDATA/supplier_5.tbl
Vuser 3:Generating CUSTOMER...100000
Vuser 6:SUPPLIER Done Rows 20001..25000
Vuser 6:Generating CUSTOMER...
...
```

--------------------------------

### Manage Web Service via HammerDB CLI

Source: https://www.hammerdb.com/docs/ch10s02.html

Use these commands within the HammerDB CLI to configure, start, check the status of, and stop the Web Service.

```text
hammerdb>wsport
Web Service Port set to 8080

hammerdb>wsstart
HammerDB Web Service v6.0
Copyright © HammerDB Ltd hosted by tpc.org 2019-2026
Type "help" for a list of commands
Starting HammerDB Web Service on port 8080

hammerdb>wsstatus
Web Service running: Service Environment

hammerdb>wsstop
Stopping HammerDB Web Service on port 8080
```

--------------------------------

### Install HammerDB via RPM

Source: https://www.hammerdb.com/docs/ch01s11.html

Use the rpm command to install the HammerDB package on Red Hat-based systems.

```bash
[root@localhost Downloads]# rpm -ivh ./HammerDB-6.0-1.el9.x86_64.rpm
Verifying...                          ################################# [100%]
Preparing...                          ################################# [100%]
Updating / installing...
   1:HammerDB-6.0-1.el9               ################################# [100%]
```

--------------------------------

### Run cifix Command

Source: https://www.hammerdb.com/docs/ch01s13.html

Execute the cifix command to initialize and validate the CI environment, including directory creation and configuration downloads.

```text
hammerdb>cifix

Running cifix...
CI FIX: starting
CI FIX: provider MariaDB
CI FIX: provider PostgreSQL
CI FIX: provider MySQL
CI FIX: directory exists /opt/hammerdb-ci
CI FIX: directory exists /opt/hammerdb-ci/TMP
CI FIX: creating directory /opt/hammerdb-ci/providers/mariadb
CI FIX: creating directory /opt/hammerdb-ci/providers/mariadb/builds
CI FIX: creating directory /opt/hammerdb-ci/providers/mariadb/config
CI FIX: creating directory /opt/hammerdb-ci/providers/mariadb/installs
CI FIX: creating directory /opt/hammerdb-ci/providers/mysql
CI FIX: creating directory /opt/hammerdb-ci/providers/mysql/builds
CI FIX: creating directory /opt/hammerdb-ci/providers/mysql/config
CI FIX: creating directory /opt/hammerdb-ci/providers/mysql/installs
CI FIX: creating directory /opt/hammerdb-ci/providers/postgresql
CI FIX: creating directory /opt/hammerdb-ci/providers/postgresql/builds
CI FIX: creating directory /opt/hammerdb-ci/providers/postgresql/config
CI FIX: creating directory /opt/hammerdb-ci/providers/postgresql/installs
CI FIX WARNING: less than 100GB free under /opt/hammerdb-ci (92GB)
CI FIX: downloading and validating provider configuration files
CI VALIDATE: provider MariaDB
CI VALIDATE: provider PostgreSQL
CI VALIDATE: provider MySQL
CI VALIDATE: PASSED
CI FIX: COMPLETE
```

--------------------------------

### Oracle CREATE TABLE Statement Example

Source: https://www.hammerdb.com/docs/ch13s03.html

This is an example of a generated CREATE TABLE statement for the ORDERS table in Oracle.

```sql
CREATE TABLE "TPCH"."ORDERS"                                                 
("O_ORDERDATE" DATE,                                         
"O_ORDERKEY" NUMBER NOT NULL ENABLE,                            
"O_CUSTKEY" NUMBER NOT NULL ENABLE,                            
"O_ORDERPRIORITY" CHAR(15),                                   
"O_SHIPPRIORITY" NUMBER,                                      
"O_CLERK" CHAR(15),                                           
"O_ORDERSTATUS" CHAR(1),                                       
"O_TOTALPRICE" NUMBER,              
"O_COMMENT" VARCHAR2(79),
 CONSTRAINT "ORDERS_PK" PRIMARY KEY ("O_ORDERKEY")
);
```

--------------------------------

### Print Dictionary Settings

Source: https://www.hammerdb.com/docs/ch09s06.html

Display all current configuration settings for the selected database and workload. This command confirms changes made to parameters like driver, ramp-up, and duration.

```cli
hammerdb>print dict
Dictionary Settings for MSSQLServer
connection {
 mssqls_server             = (local)
 mssqls_linux_server       = localhost
 mssqls_tcp                = false
 mssqls_port               = 1433
 mssqls_azure              = false
 mssqls_authentication     = windows
 mssqls_msi_object_id      = null
 mssqls_linux_authent      = sql
 mssqls_odbc_driver        = ODBC Driver 18 for SQL Server
 mssqls_linux_odbc         = ODBC Driver 18 for SQL Server
 mssqls_uid                = sa
 mssqls_pass               = admin
 mssqls_encrypt_connection = true
 mssqls_trust_server_cert  = true
}
tpcc       {
 mssqls_count_ware       = 10
 mssqls_num_vu           = 4
 mssqls_dbase            = tpcc
 mssqls_imdb             = false
 mssqls_bucket           = 1
 mssqls_durability       = SCHEMA_AND_DATA
 mssqls_use_bcp          = true
 mssqls_total_iterations = 10000000
 mssqls_raiseerror       = false
 mssqls_keyandthink      = false
 mssqls_checkpoint       = false
 mssqls_driver           = timed
 mssqls_rampup           = 1
 mssqls_duration         = 3
 mssqls_allwarehouse     = false
 mssqls_timeprofile      = false
 mssqls_async_scale      = false
 mssqls_async_client     = 10
 mssqls_async_verbose    = false
 mssqls_async_delay      = 1000
 mssqls_connect_pool     = false
}
```

--------------------------------

### Db2 CREATE TABLE Statement Example

Source: https://www.hammerdb.com/docs/ch13s03.html

This is an example of a generated CREATE TABLE statement for the ORDERS table in Db2, including storage and organization clauses.

```sql
CREATE TABLE "DB2INST1"."ORDERS"  (
  "O_ORDERKEY" INTEGER NOT NULL ,
  "O_CUSTKEY" INTEGER NOT NULL ,
  "O_ORDERSTATUS" CHAR(1 OCTETS) NOT NULL ,
  "O_TOTALPRICE" DOUBLE NOT NULL ,
  "O_ORDERDATE" DATE NOT NULL ,
  "O_ORDERPRIORITY" CHAR(15 OCTETS) NOT NULL ,
  "O_CLERK" CHAR(15 OCTETS) NOT NULL ,
  "O_SHIPPRIORITY" INTEGER ,
  "O_COMMENT" VARCHAR(79 OCTETS) NOT NULL )   
IN "USERSPACE1"  
ORGANIZE BY ROW;
```

--------------------------------

### Execute SQL Script in SQL*Plus

Source: https://www.hammerdb.com/docs/ch13s03.html

This example shows how to connect to an Oracle database using SQL*Plus and execute a script named 'tpch_tables.sql' to create tables.

```sql
sqlplus tpch/tpch
SQL*Plus: Release 12.1.0.2.0 Production
Copyright (c) 1982, 2014, Oracle.  All rights reserved.
Connected to:
Oracle Database 12c Enterprise Edition Release 12.1.0.2.0
SQL> @tpch_tables.sql
Table created.
Table created.
Table created.
Table created.
Table created.
Table created.
Table created.
Table created.
SQL>
```

--------------------------------

### Start and Stop Oracle Trace Session

Source: https://www.hammerdb.com/docs/ch14s01.html

Use these SQL commands to interactively start and stop an Oracle trace session with event 10046, level 4, to capture bind variables.

```sql
SQL> connect / as sysdba
Connected.
SQL> alter session set events '10046 trace name context forever, level 4'; 
Session altered.
...
SQL> alter session set events '10046 trace name context off';
Session altered.
SQL> 
```

--------------------------------

### Execute Build Scripts

Source: https://www.hammerdb.com/docs/ch01s17.html

Commands to initiate the build process for Linux and Windows environments.

```bash
./Build-Linux.sh x64 Setup/HammerDB-Linux.bawt update
```

```batch
./Build-Windows.bat x64 vs2022+gcc Setup/HammerDB-Windows.bawt update
```

--------------------------------

### TPROC-H Example Query

Source: https://www.hammerdb.com/docs/ch11s01.html

This SQL query is an example of the ad-hoc queries executed in the TPROC-H workload. It calculates aggregated values from the lineitem table based on ship date and groups the results by return flag and line status.

```sql
-- using 647655760 as a seed to the RNG
 select
 l_returnflag,
 l_linestatus,
 sum(l_quantity) as sum_qty,
 sum(l_extendedprice) as sum_base_price,
 sum(l_extendedprice * (1 - l_discount)) as sum_disc_price,
 sum(l_extendedprice * (1 - l_discount) * (1 + l_tax)) as sum_charge,
 avg(l_quantity) as avg_qty,
 avg(l_extendedprice) as avg_price,
 avg(l_discount) as avg_disc,
 count(*) as count_order 
from
 lineitem 
where
 l_shipdate <= date '1998-12-01' – interval '69' day (3)
group by
 l_returnflag,
 l_linestatus 
order by
 l_returnflag,
 l_linestatus;
```

--------------------------------

### Uninstall HammerDB

Source: https://www.hammerdb.com/docs/ch01s11.html

Remove the installation directory to uninstall HammerDB.

```bash
rm -rf HammerDB-6.0
```

--------------------------------

### Example Output of Use All Warehouses Configuration

Source: https://www.hammerdb.com/docs/ch04s08.html

Displays the distribution of warehouse IDs (WIDs) across multiple virtual users when the Use All Warehouses option is enabled.

```text
Vuser 1:Beginning rampup time of 2 minutes
Vuser 2:Assigned 10 WIDs = 1 4 7 10 13 16 19 22 25 28 based on VU count 3, Warehouses = 10 out of 30
Vuser 2:Processing 10000000 transactions with output suppressed...
Vuser 3:Assigned 10 WIDs = 2 5 8 11 14 17 20 23 26 29 based on VU count 3, Warehouses = 10 out of 30
Vuser 3:Processing 10000000 transactions with output suppressed...
Vuser 4:Assigned 10 WIDs = 3 6 9 12 15 18 21 24 27 30 based on VU count 3, Warehouses = 10 out of 30
Vuser 4:Processing 10000000 transactions with output suppressed...
```

--------------------------------

### Run HammerDB Container

Source: https://www.hammerdb.com/docs/ch01s12.html

Command to start an interactive HammerDB container session.

```bash
	docker run -it --name hammerdb hammerdb-v6.0 bash
```

--------------------------------

### Change HammerDB Ownership

Source: https://www.hammerdb.com/docs/ch01s11.html

Update file ownership to a specific OS user after installation.

```bash
[root@localhost opt]# chown -R redhat:redhat HammerDB-6.0/
[root@localhost opt]# ls -l HammerDB-6.0/
total 31124
drwxr-xr-x. 2 redhat redhat       19 Apr  9 14:36 agent
drwxr-xr-x. 3 redhat redhat     4096 Apr  9 14:36 config
-rwxr-xr-x. 1 redhat redhat 12819442 Mar 24 14:18 hammerdb
-rwxr-xr-x. 1 redhat redhat 11022274 Mar 24 14:18 hammerdbcli
-rwxr-xr-x. 1 redhat redhat  7981127 Mar 24 14:18 hammerdbws
-rw-r--r--. 1 redhat redhat    35149 Mar 24 14:18 LICENSE
drwxr-xr-x. 3 redhat redhat       24 Apr  9 14:36 pylib
-rw-r--r--. 1 redhat redhat      518 Mar 24 14:18 README.md
drwxr-xr-x. 4 redhat redhat       31 Apr  9 14:36 scripts
```

--------------------------------

### Configure Step Testing Replicas

Source: https://www.hammerdb.com/docs/ch04s08.html

XML configuration for defining replicas in the steps.xml file to automate variable load testing.

```xml
<steps>
<replica1>
  <start_after_prev>1</start_after_prev>
  <duration>4</duration>
  <virtual_users>2</virtual_users>
 </replica1>
 <replica2>
  <start_after_prev>1</start_after_prev>
  <duration>3</duration>
  <virtual_users>2</virtual_users>
 </replica2>
 <replica3>
  <start_after_prev>1</start_after_prev>
  <duration>2</duration>
  <virtual_users>2</virtual_users>
 </replica3>
 <replica4>
  <start_after_prev>1</start_after_prev>
  <duration>1</duration>
  <virtual_users>2</virtual_users>
 </replica4>
</steps>
```

--------------------------------

### Query Job Results

Source: https://www.hammerdb.com/docs/ch09s12.html

Retrieve results for a specific job ID after starting a workload.

```text
hammerdb>set jobid [ vurun ]
Benchmark Run jobid=67FD3C792EF803E253533323
hammerdb>jobs 67FD3C792EF803E253533323 result
[
  "67FD3C792EF803E253533323",
  "2026-06-24 10:15:34",
  "32 Active Virtual Users configured",
  "TEST RESULT : System achieved 400301 NOPM from 932861 SQL Server TPM"
]
```

--------------------------------

### Use and Show MySQL Tables

Source: https://www.hammerdb.com/docs/ch04s06.html

Select a MySQL database to use and then list all tables within it. This is useful for verifying schema contents.

```sql
mysql> use tpcc;
Database changed
mysql> show tables;
+----------------+
| Tables_in_tpcc |
+----------------+
| customer       |
| district       |
| history        |
| item           |
| new_order      |
| order_line     |
| orders         |
| stock          |
| warehouse      |
+----------------+
9 rows in set (0.00 sec)
```

--------------------------------

### Identify SQLSTATE 01003 Error

Source: https://www.hammerdb.com/docs/ch12s04.html

Example of the error message encountered if the IgnoreWarnList setting is missing.

```text
Error in Virtual User 3: [IBM][CLI Driver][DB2/NT64] SQLSTATE 01003: Null values were eliminated from the argument of a column function.
```

--------------------------------

### Configuring a Step Workload Driver Script

Source: https://www.hammerdb.com/docs/ch04s08.html

Use the steprun command instead of vurun to initiate a step workload after setting the necessary database and TPC-C parameters.

```tcl
dbset db mssqls
dbset bm TPC-C
diset connection mssqls_server {(local)\SQLDEVELOP}
diset tpcc mssqls_dbase tpcc
diset tpcc mssqls_total_iterations 10000000
diset tpcc mssqls_driver timed
diset tpcc mssqls_rampup 2
diset tpcc mssqls_duration 5
vuset logtotemp 1
vuset vu 2
steprun
```

--------------------------------

### Verify IBM_DB_DIR Environment Variable

Source: https://www.hammerdb.com/docs/ch01s17.html

Check the location of the Db2 installation directory used by the build automation.

```bash
$ echo $IBM_DB_DIR
/home/ibm/sqllib
```

--------------------------------

### print

Source: https://www.hammerdb.com/docs/ch09s03.html

Prints the current configuration.

```APIDOC
## print

### Description
Prints the current configuration (db, bm, dict, generic, script, vuconf, vucreated, vustatus, datagen).

### Usage
print [db|bm|dict|generic|script|vuconf |vucreated|vustatus|datagen]
```

--------------------------------

### Execute Db2 SQL Script

Source: https://www.hammerdb.com/docs/ch13s03.html

This example shows how to execute a Db2 SQL script file named 'tpchcreate.sql' using the 'db2 -tvf' command, which includes CONNECT and CREATE TABLE statements.

```bash
db2 -tvf tpchcreate.sql
CONNECT TO TPCH

   Database Connection Information

 Database server        = DB2/LINUXX8664 11.1.0
 SQL authorization ID   = DB2INST1
 Local database alias   = TPCH2

CREATE SCHEMA "DB2INST1"
DB20000I  The SQL command completed successfully.

CREATE TABLE "DB2INST1"."ORDERS"  ( "O_ORDERKEY" INTEGER NOT NULL , "O_CUSTKEY" INTEGER NOT NULL , "O_ORDERSTATUS" CHAR(1 OCTETS) NOT NULL , "O_TOTALPRICE" DOUBLE NOT NULL , "O_ORDERDATE" DATE NOT NULL , "O_ORDERPRIORITY" CHAR(15 OCTETS) NOT NULL , "O_CLERK" CHAR(15 OCTETS) NOT NULL , "O_SHIPPRIORITY" INTEGER , "O_COMMENT" VARCHAR(79 OCTETS) NOT NULL ) IN "USERSPACE1" ORGANIZE BY ROW
DB20000I  The SQL command completed successfully.
```

--------------------------------

### Configuring CI Environment

Source: https://www.hammerdb.com/docs/ch09s03.html

Initializes and manages CI environment settings and listeners.

```python
hammerdb>>>cifix()
hammerdb>>>citmp()
hammerdb>>>ciset('MariaDB','build','repo_url','https://github.com/MariaDB/server.git')
hammerdb>>>cilisten()
hammerdb>>>cistatus()
hammerdb>>>cistop()
hammerdb>>>cireset()
```
Tokens:
Raw