NewBrowse the v6.1 Documentation below or jump to earlier versions.

HammerDB Documentation

Find install guides, quick start, workload details, GUI, CLI, metrics and more.

Open v6.1 Docs Quick Start

Table of Contents (v6.1)

Table of Contents

1. Installation and Configuration
1. Release Notes
1.1. HammerDB v6.1 Overview
1.2. Upgrading Directly from HammerDB v5.0
2. Linux Wayland Display Server Has Slow Refresh on Ubuntu
3. Known Third-Party Driver Issues
3.1. Oracle on Windows: Oracle Bug 12733000 OCIStmtRelease Crashes or Hangs if Called After Freeing the Service Context Handle
3.2. SQL Server on Linux: unixODBC Handle Validation May Become a Performance Bottleneck
3.3. MySQL on Linux: C++ Runtime Library Load Issue
3.4. Db2 Driver is Not Included in the HammerDB Docker Image or Build
4. Linux Xft Font and Cairo Graphics Pre-Installation Requirements
5. Documentation License, Copyright and Contribution
6. HammerDB v6.1 New Features
6.1. Native Linux ARM64 (aarch64) Support
6.2. VillageSQL TPROC-C, TPROC-H and CI
6.3. MySQL-Family TLS Connections
6.4. MariaDB Transactional Workload Improvements
6.5. Web Service, CI and Benchmark Profiles
6.6. PostgreSQL Azure Citus and Other Compatibility Changes
6.7. Pull Request Summary
7. Test Matrix
8. Downloading HammerDB
9. Checksum Verification
10. HammerDB Interfaces: Web Service, Desktop GUI & CLI
11. Installing and Starting HammerDB on Windows
11.1. Self-Extracting Installer
11.2. tar.gz File
11.3. Starting HammerDB
11.4. Uninstalling HammerDB
12. Installing and Starting HammerDB on Linux
12.1. Install and Uninstall Red Hat .rpm file
12.2. Install and Uninstall Ubuntu .deb file
12.3. Install and Uninstall the Tar.gz File
12.4. Starting HammerDB
13. HammerDB Multi-Architecture Docker Images
13.1. Pulling and Running a Published Image
13.2. Building and Publishing Images
14. HammerDB CI and Pipeline Automation
14.1. CI Test Environment Layout
14.2. HammerDB CI Commands
14.3. Initialise the CI Environment with cifix
14.4. Review and Update CI Configuration
14.5. Start the CI Listener
14.6. Start the HammerDB Web Service
14.7. Running a Benchmark from the Pipelines Page
14.8. Jobs and Reports Created by CI
14.9. Running Profiles and Comparisons
14.10. Running Pipelines in the CLI
14.11. Running Pipelines with a Webhook
15. Verifying the Installation of Database Client Libraries
15.1. Oracle Client
15.2. SQL Server
15.3. Db2
15.4. MySQL
15.5. MariaDB
15.6. VillageSQL
15.7. PostgreSQL
16. SSL/TLS Connections for MySQL, MariaDB and VillageSQL in 6.1
17. XML & Persistent Configuration
18. Themes and Scalable Graphics
19. Building HammerDB from Source
19.1. Building HammerDB Natively on Linux ARM64 (aarch64)
19.2. Compiler & Dependency Install on Linux
19.3. Compiler & Dependency Install on Windows
19.4. Download HammerDB Source
19.5. Running the Build
19.6. HammerDB License
2. Quick Start
1. Building the Schema
2. Checking the Schema
3. Run a Test Workload
4. Run a Timed Workload
5. Using the Transaction Counter
6. Browsing Results
7. Deleting the Schema
3. Introduction to OLTP Testing (TPROC-C derived from TPC-C)
1. What is a Transactional Workload
2. What is the TPC and the TPROC-C workload derived from TPC-C?
3. HammerDB TPROC-C workload
4. Comparing HammerDB results
5. Understanding the TPROC-C workload derived from TPC-C
6. TPROC-C key similarities and differences from TPC-C
7. How many warehouses to create for the TPROC-C test
8. Publishing database performance results
4. How to Run a TPROC-C Workload
1. Test Network Configuration
1.1. SUT Database Server Configuration
1.2. Load Generation Server Configuration
1.3. CPU Single-Threaded Performance Calibration
2. Installation and Configuration
2.1. Oracle
2.2. Microsoft SQL Server
2.3. Db2
2.4. MySQL
2.5. VillageSQL TPROC-C (MySQL-Compatible)
2.6. MariaDB
2.7. PostgreSQL
3. Configuring Schema Build Options
3.1. Oracle Schema Build Options
3.2. Microsoft SQL Server Schema Build Options
3.2.1. In-Memory Optimized Tables
3.2.2. Build Options
3.3. Db2 Schema Build Options
3.4. MySQL Schema Build Options
3.5. VillageSQL Schema Build Options
3.6. MariaDB Schema Build Options
3.7. PostgreSQL Schema Build Options
4. Creating the Schema
5. Checking the Schema
6. Deleting the Schema
6.1. Deleting or Verifying the Oracle Schema
6.2. Deleting or Verifying the SQL Server Schema and In-memory Schema
6.3. Deleting or Verifying the Db2 Schema
6.4. Deleting or Verifying the MySQL Schema
6.5. Deleting or Verifying the MariaDB Schema
6.6. Deleting or Verifying the PostgreSQL Schema
7. Configuring Driver Script options
8. Advanced Driver Script Options
8.1. Use All Warehouses for increased I/O
8.2. Time Profile for measuring Response Times
8.3. Fixed Throughput and Scaling to thousands of sessions
8.4. Cluster Connect Pool for Cluster Testing
8.5. Step Testing with Variable Load
9. Additional Driver Script Options for Stored Procedures and Server Side Reports: PostgreSQL, MySQL, MariaDB, Oracle, Db2 and EnterpriseDB PostgreSQL
9.1. PostgreSQL Stored Procedures
9.2. MySQL Prepare Statements
9.3. MariaDB Prepare Statements
9.4. MariaDB Set-Based New Order and Delivery in 6.1
9.5. No Stored Procedures Option for MySQL and MariaDB
9.6. MariaDB Purge when complete
9.7. Oracle AWR Reports
9.8. Db2 MONREPORT
10. Loading the Driver Script
11. Configure Virtual Users
12. Create and Run Virtual Users
5. Autopilot for Automated Testing
1. Configure and Run Autopilot
2. Autopilot Troubleshooting
3. Extending Autopilot to start automatically
6. Transactions
1. Oracle Transaction Counter
2. SQL Server Transaction Counter
3. Db2 Transaction Counter
4. MySQL Transaction Counter
5. MariaDB Transaction Counter
6. PostgreSQL Transaction Counter
7. Running the Transaction Counter
8. Logging Transaction Counter Output
7. System Discovery, CPU, I/O and Database Metrics
1. Start the Agent Manually
2. Configure Metrics Manually
3. Configure Metrics Automatically
4. Monitor Metrics
5. Viewing Job Metrics Data
6. Oracle Database Metrics - Active Session History
7. PostgreSQL Database Metrics - Active Session History
8. MySQL and MariaDB Database Metrics
8. Remote Primary and Replica Modes
1. Primary Mode
2. Replica Mode
3. Primary Distribution
9. Command Line Interface (CLI)
1. Start the CLI
2. Start the CLI in Python
3. CLI Commands
3.1. CLI commands in Python
4. Configure Schema Build
5. Building the Schema
6. Configure Driver
7. Configure Virtual Users
8. Run the workload
9. CLI Scripting in Tcl
10. CLI Scripting in Python
11. CLI Example Scripts Driven by Bash and PowerShell
12. CLI Jobs Interface
10. Viewing Jobs with the Web Service Interface (WS)
1. Web Service Configuration
2. Starting and Stopping the Web Service
3. Jobs Home Page
4. Benchmark Report
5. Submitting a Benchmark Report
6. Charts, Timing, Metrics and Profiles
7. Pipelines from the Web Service
8. Using Web Service Output for Automation
11. Introduction to Analytic Testing (TPROC-H derived from TPC-H) and Cloud Queries
1. What is TPROC-H derived from TPC-H?
2. Running the Power and Throughput Test and Calculating the Geometric Mean
3. Choosing a Database for running TPROC-H workloads
3.1. Oracle
3.2. Microsoft SQL Server
3.3. Db2
3.4. PostgreSQL
3.5. MySQL
3.6. VillageSQL TPROC-H (MySQL-Compatible)
3.7. MariaDB
4. Benchmarking Database Cloud Services
4.1. Redshift Cloud Analytic Workload
12. How to Run an Analytic Workload
1. SUT Database Server Configuration
2. Installation and Configuration
2.1. Oracle
2.2. SQL Server
2.3. Db2
2.4. PostgreSQL
2.5. MySQL
2.6. MariaDB
3. Configuring Schema Build Options
3.1. Oracle Schema Build Options
3.2. SQL Server Schema Build Options
3.3. Db2 Schema Build Options
3.4. MySQL Schema Build Options
3.5. VillageSQL TPROC-H Schema Build Options
3.6. MariaDB Schema Build Options
3.7. PostgreSQL Schema Build Options
4. Creating the Schema
4.1. Verifying and Backing-Up the Oracle Schema
4.2. Verifying and Backing Up the SQL Server Schema
4.3. Verifying and Backing up the Db2 Schema
4.4. Verifying and Backing up the MySQL Schema
4.5. Verifying and Backing up the MariaDB Schema
4.6. Verifying and Backing up the PostgreSQL Schema
5. Checking the Schema
6. Configuring Driver Script Options
7. Loading the Driver Script
8. Configure Virtual Users
9. Run a Single Virtual User Test
9.1. Changing the Query Order
10. Run a Power Test
11. Run a Throughput Test
11.1. SQL Server Snapshot Isolation
12. Calculate the Geometric Mean
13. Generating and Loading Bulk Datasets
1. Generate the Dataset
2. Generate the Dataset with the CLI
3. Generate the template database
3.1. Capture and run the table creation DDL
3.1.1. Oracle
3.1.2. SQL Server
3.1.3. Db2
3.1.4. MySQL
3.1.5. PostgreSQL/Amazon Redshift
4. Run the bulk data load
4.1. Oracle
4.2. SQL Server
4.3. Db2
4.4. MySQL
4.5. MariaDB
4.6. PostgreSQL/Amazon Redshift
14. Oracle Trace File Replay
1. Generating Trace Files
2. Converting Oracle Trace Files
3. Replaying Oracle Trace Files
4. Capturing Errors from Trace File Workloads
15. GNU Free Documentation License
Versioned Documentation Index