Administrator's Guide


VoltDB Home » Documentation » Administrator's Guide

Administrator's Guide


The text and illustrations in this document are licensed under the terms of the GNU Affero General Public License Version 3 as published by the Free Software Foundation. See the GNU Affero General Public License ( for more details.

Many of the core VoltDB database features described herein are part of the VoltDB Community Edition, which is licensed under the GNU Affero Public License 3 as published by the Free Software Foundation. Other features are specific to the VoltDB Enterprise Edition, which is distributed by VoltDB, Inc. under a commercial license. Your rights to access and use VoltDB features described herein are defined by the license you received when you acquired the software.


This books explains how to create and manage VoltDB databases and the clusters that run them.

Table of Contents

1. Structure of This Book
2. Related Documents
1. Managing VoltDB Databases
1.1. Getting Started
1.2. Understanding the VoltDB Utilities
1.3. Management Tasks
2. Preparing the Servers
2.1. Server Checklist
2.2. Install Required Software
2.3. Configure Memory Management
2.3.1. Disable Swapping
2.3.2. Disable Transparent Huge Pages
2.3.3. Enable Virtual Memory Mapping and Overcommit
2.4. Turn off TCP Segmentation
2.5. Configure NTP
2.6. Configure the Network
2.7. Assign Network Ports
3. Starting and Stopping the Database
3.1. Configuring the Cluster and Database
3.2. Initializing the Database Root Directory
3.3. Starting the Database
3.4. Loading the Database Definition
3.5. Stopping the Database
3.6. Restarting the Database
3.7. Starting and Stopping Individual Servers
4. Maintenance and Upgrades
4.1. Backing Up the Database
4.2. Updating the Database Schema
4.2.1. Performing Live Schema Updates
4.2.2. Performing Updates Using Save and Restore
4.3. Upgrading the Cluster
4.3.1. Performing Server Upgrades
4.3.2. Performing Rolling Hardware Upgrades on K-Safe Clusters
4.3.3. Adding Servers to a Running Cluster with Elastic Scaling
4.3.4. Reconfiguring the Cluster During a Maintenance Window
4.4. Upgrading VoltDB Software
4.4.1. Upgrading VoltDB on a Single Database Cluster
4.4.2. Using a DR Replica to Upgrade VoltDB With Reduced Downtime
4.4.3. Using Cross Data Center Replication (XDCR) to Upgrade VoltDB Without Downtime
5. Deploying Clusters with the VoltDB Deployment Manager
5.1. Starting the VoltDB Deployment Manager
5.1.1. Starting the Deployment Manager Manually
5.1.2. Starting the Deployment Manager as a Service
5.2. What the Deployment Manager Does
5.3. How the Deployment Manager Works
5.4. Using the VoltDB Deployment Manager Web Interface
5.5. Using the VoltDB Deployment Manager REST API
6. Monitoring VoltDB Databases
6.1. Monitoring Overall Database Activity
6.1.1. VoltDB Management Center
6.1.2. System Procedures
6.2. Setting the Database to Read-Only Mode When System Resources Run Low
6.2.1. Monitoring Memory Usage
6.2.2. Monitoring Disk Usage
6.3. Integrating VoltDB with Other Monitoring Systems
6.3.1. Integrating with Nagios
6.3.2. Integrating with New Relic
7. Logging and Analyzing Activity in a VoltDB Database
7.1. Introduction to Logging
7.2. Creating the Logging Configuration File
7.3. Enabling Logging for VoltDB
7.4. Changing the Timezone of Log Messages
7.5. Changing the Configuration on the Fly
8. What to Do When Problems Arise
8.1. Where to Look for Answers
8.2. Handling Errors When Restoring a Database
8.2.1. Logging Constraint Violations
8.2.2. Safe Mode Recovery
8.3. Collecting the Log Files
A. Server Configuration Options
A.1. Server Configuration Options
A.1.1. Network Configuration (DNS)
A.1.2. Time Configuration (NTP)
A.2. Process Configuration Options
A.2.1. Maximum Heap Size
A.2.2. Other Java Runtime Options (VOLTDB_OPTS)
A.3. Database Configuration Options
A.3.1. Sites per Host
A.3.2. K-Safety
A.3.3. Network Partition Detection
A.3.4. Read Level Consistency
A.3.5. Automated Snapshots
A.3.6. Import and Export
A.3.7. Command Logging
A.3.8. Heartbeat
A.3.9. Temp Table Size
A.3.10. Query Timeout
A.4. Path Configuration Options
A.4.1. VoltDB Root
A.4.2. Snapshots Path
A.4.3. Export Overflow Path
A.4.4. Command Log Path
A.4.5. Command Log Snapshots Path
A.5. Network Ports
A.5.1. Client Port
A.5.2. Admin Port
A.5.3. Web Interface Port (httpd)
A.5.4. Internal Server Port
A.5.5. Replication Port
A.5.6. Zookeeper Port
B. Snapshot Utilities
snapshotconvert — Converts the tables in a VoltDB snapshot into text files.
snapshotverify — Verifies that the contents of one or more snapshot files are complete and usable.