voltdb — Performs management tasks on the current server, such as starting and recovering the database.
voltdb collect [args]
voltdb get classes [args]
voltdb get deployment [args]
voltdb get schema [args]
voltdb mask [args] source-configuration-file [new-configuration-file]
voltdb init [args]
voltdb start [args]
The voltdb command performs local management functions on the current system, including:
Initializing the database root directory and setting configuration options
Starting the database process
Collecting log files into a single compressed file
Retrieving the classes, deployment, or schema from a database root directory
Hiding passwords in the configuration file
The action that is performed depends on which start action you specify to the voltdb command:
collect — the collect option collects system and process logs related to the VoltDB database process on the current system and compresses them into a single file. This command is helpful when reporting problems to VoltDB support.
get — the get option retrieves the current configuration, procedure classes, or schema
from the database root directory. The requested item is then written to a file. This command can be used whether the
database is running or not. You can use options to specify either or both the parent of the root directory
--dir) or the name and location of the output file (
--output). Note that the get
option can only be used on databases created using init and start.
mask — the mask option disguises the passwords associated with user accounts in the security section of the configuration file. The output of the voltdb mask command is either a new configuration file with hashed passwords or, if you do not specify an output file, the original input file is modified in place.
init — the init option initializes the root directory VoltDB uses for storing the configuration, logs, and other disk-based information (such as snapshots and command logs) for the database process. You only need to initialize the root directory once. After that, VoltDB manages the content and selecting the appropriate start actions to maintain the database state. If you choose to re-initialize an existing root directory, you can use the --force argument to delete any previous data.
start — the starts option starts the database process after the root directory has been initialized. The actual action that VoltDB takes depends on the current state of the database cluster:
If this is the first time the database has started, it creates a new database.
If the database has run before and is configured to use command logs or there is at least one snapshot in the snapshots directory, the database is restarted and previous data recovered.
If the cluster is already running and a server is missing (assuming the use of K-safety) the current node will rejoin the running cluster.
If the cluster is already running with all servers present, the current node will be added to expand the size of the cluster — as long as you use the --add argument on the start command.
The voltdb start command uses Java to instantiate the process. It is possible to customize the Java environment, if necessary, by passing command line arguments to Java through the following environment variables:
LOG4J_CONFIG_PATH — Specifies an alternate Log4J configuration file.
VOLTDB_HEAPMAX — Specifies the maximum heap size for the Java process. Specify the value as an integer number of megabytes. By default, the maximum heap size is set to 2048.
VOLTDB_OPTS — Specifies all other Java command line arguments. You must include both the command line flag and argument. For example, this environment variable can be used to specify system properties using the -D flag:
The following arguments apply specifically to the collect action.
Specifies the parent location for the database root directory from which to collect information. The default, if you do not specify a directory, is the current working directory.
Specifies the number of days of log files to collect. For example, using
collect data from the last 24 hours. By default, VoltDB collects 14 days (2 weeks) worth of logs.
Lists the actions that will be taken, including the files that will be collected, but does not actually perform the collection or upload.
Specifies that the process will not prompt for input, such as whether to delete the output file after uploading is complete. This argument is useful when starting the collect action from within a script.
Specifies the name and location of the resulting output file. The default output file name starts with "voltdb_collect_" and includes the current server IP or hostname, with a file extension of ".zip" saved to the current working directory.
Specifies that the heap dump not be included in the collection. The heap dump is usually significantly larger than the other log files and can be excluded to save space.
The following arguments apply specifically to the get classes, get deployment, and get schema actions.
Specifies the parent location for the database root directory. The default, if you do not specify a directory, is the current working directory.
Allows the command to overwrite an existing file. By default, the get actions will not overwrite existing files.
Specifies the name and, optionally, location for the resulting output file. The default location is the current working directory. The default file depends on the resource being requested:
procedures.jar for get classes
deployment.xml for get deployment
schema.sql for get schema
The following arguments apply to the voltdb init command.
Specifies the location of the database configuration file. The configuration file is an XML file that defines the database configuration, including which options to enable when the database starts. See Appendix E, Configuration File (deployment.xml) for a complete description of the syntax of the configuration file.
The default, if you do not specify a configuration file, is a default configuration that includes command logging (where available), no K-safety, and eight sites per host.
Specifies the parent location for the database root directory. The root directory is named
voltdbroot and is created if it does not already exist in the specified location. If a
voltdbroot directory does already exist, you must use the --force argument
to override any existing data. The default, if you do not specify a directory, is the current working
Initializes the database root directory, even if files (such as command logs or snapshots) already exist in the specified directory. Initializing the root directory after previously running a database could overwrite and therefore erase old command logs. Therefore, VoltDB will not, by default, initialize the database if such files exist. If you do not need the files from the previous session, you can use the --force argument to overwrite these files.
Specifies the location of one or more JAR files containing classes used to declare user-defined stored procedures. The JAR files (and any schema definitions included with the --schema argument) are loaded automatically when the database starts. Separate multiple file names with commas. You can also use asterisk (*) as a wildcard character in the file specification. If durability is enabled (through command logs or a shutdown snapshot) the classes specified on the init command are loaded only the first time the database starts and the command logs are used for subsequent starts. If no durability is provided, the initialized classes are loaded on every start.
Specifies the location of the license file, which is required when using the VoltDB Enterprise Edition. The argument is ignored when using the community edition.
Specifies the maximum number of snapshot directories to save when performing a
--force. When initializing a root directory with
--force, VoltDB deletes all previous
files in the directory except the snapshot subfolder, which is renamed
snapshots.1, snapshots.2, and so on. By default, VoltDB saves
only two older snapshot folders. The
--retain argument lets you specify a different maximum number
of folders to save.
Specifies the location of one or more files containing database definition language (DDL) statements. The DDL statements (and any classes included with the --classes argument) are loaded automatically when the database starts. Separate multiple file names with commas. You can also use asterisk (*) as a wildcard character in the file specification. If durability is enabled (through command logs or a shutdown snapshot) the schema specified on the init command is loaded only the first time the database starts and the command logs are used for subsequent starts. If no durability is provided, the initialized schema is loaded on every start.
The following arguments apply to the voltdb start command.
Specifies the parent location for the database root directory. This is the same directory specified on the voltdb init command. (You must initialize the root directory before you can start the database.) The default, if you do not specify a directory, is the current working directory.
Specifies the network address of one or more nodes in the database cluster. VoltDB selects one of these nodes to coordinate the start of the database or the adding or rejoining of servers. When starting a database, all nodes must specify the same list of host addresses. Note that once the database starts and the cluster is complete, the role of the host node is complete and all nodes become peers.
When rejoining or adding a server to a running cluster, you can specify any node(s) still in the cluster. The host for an add or rejoin operation does not have to be the same node specified when the database started.
The default if you do not specify a host when creating or recovering the database is
localhost. In other words, a single node cluster running on the current system. You must specify a
host on the command line when adding or rejoining a node or when starting a cluster.
If the host node is using an internal port other than the default (3021), you must specify the port as part of the host string, in the format host:port.
When used in conjunction with the --missing flag, the first host in the list must be one of the current hosts, not one of the missing nodes.
Specifies the number of nodes in the database cluster.
When joining a running cluster, specifies that the new node can be "added", elastically expanding the size of the cluster. The --add flag only takes affect when a node is joining a complete, running cluster. If the cluster is starting or if a node is missing from a K-safe cluster, the current node will join the cluster as normal. But if the cluster is already running and has its full complement of members, you must specify --add if you want to increase the size of the cluster.
Starts the server process in the background (as a daemon process).
Specifies the location of the server. When the K-safety value is greater than zero, VoltDB uses this argument to assist in rack-aware partitioning. The cluster will attempt to place multiple copies of each partition on different nodes to keep them physically as far apart as possible. The physical location is specified by the group-name, which is an alphanumeric name. The names might represent physical servers, racks, switches, or anything meaningful to the user to avoid multiple copies failing at the same time.
To be effective, placement groups must adhere to the following rules:
There must be more than one placement group specified for the cluster
The same number of nodes must be included in each placement group
The number of partition copies (that is, K+1) must be a multiple of the number of placement groups
Otherwise, VoltDB issues a warning on startup and there are no guarantees the partitions will be evenly distributed.
For Linux systems, allows the database to start even if the server is configured to use Transparent Huge Pages (THP). THP is a known problem for memory-intense applications like VoltDB. So under normal conditions VoltDB will not start if the use of THP is enabled. This flag allows you to ignore that restriction for test purposes. Do not use this flag on production systems.
Allows a K-safe cluster to start without the full complement of nodes. This argument specifies how many nodes
are missing from the cluster at startup. For example, if the arguments are
--missing=2, then the database will start once three nodes join the cluster, assuming those nodes can support at least
one copy of each partition. Note that use of the
--missing option means that the cluster is
not fully K-safe until the specified number of missing nodes rejoin the cluster after the
database starts. Also, the --hosts flag should list currently available hosts, not the missing nodes.
For the create and recover operations only, starts the database in admin mode. Admin mode stops applications from performing write operations to the database through the client interface. This is useful when performing administrative functions such as restoring a snapshot before allowing client access. Once all administrative operations are complete, you can use the voltadmin resume command to resume normal operation for the database. If any nodes in the cluster start with the --pause switch, the entire cluster starts paused.
When using command logs to recover an existing database that cannot recover under normal circumstances, the --safemode argument recovers the database to the last valid transaction. This argument should only be used when troubleshooting a failed recovery. See the description of safe mode recovery in the VoltDB Administrator's Guide for details.
In addition to the arguments listed above for the voltdb start command, there are additional arguments that specify the network configuration for server ports and interfaces when starting a VoltDB database. In most cases, the default values can and should be accepted for these settings. The exceptions are the external and internal interfaces that should be specified whenever there are multiple network interfaces on a single machine.
You can also, optionally, specify a unique network interface for individual ports by preceding the port number with the interface's IP address (or hostname) followed by a colon. Specifying the network interface as part of an individual port setting overrides the default interface for that port set by --externalinterface or --internalinterface.
The network configuration arguments to the voltdb start command are listed below. See the appendix on server configuration options in the VoltDB Administrator's Guide for more information about network configuration options.
Specifies the default network interface to use for external ports, such as the admin and client ports.
Specifies the default network interface to use for internal communication, such as the internal port.
Specifies the public network interface. This argument is useful for hosted systems where the internal and external interfaces may not be generally reachable from the Internet. In which case, specifying the public interface helps the VoltDB Management Center provide publicly accessible links for the cluster nodes.
Specifies the publicly advertised network interface and, optionally, port number for database replication (DR) communication. This is the address that is sent from the producer cluster to consumers. This argument is useful for hosted systems where the internal interfaces are not reachable from outside the hosted environment and the producer cluster must return an externally mapped port as the public DR interface to remote consumers.
Specifies the admin port. The --admin flag overrides the admin port setting in the configuration file.
Specifies the client port.
Specifies the http port. The --http flag both sets the port number (and optionally the interface) and enables the http port, overriding the http setting, if any, in the configuration file.
Specifies the internal port used to communicate between cluster nodes.
Specifies the replication port used for database replication. The --replication flag overrides the replication port setting in the configuration file.
Specifies the zookeeper port. By default, the zookeeper port is bound to the server's internal interface (127.0.0.1).
The first example shows the commands for initializing and starting a three-node database cluster using a custom
deploy.xml, and the node zeus as the host.
$ voltdb init --dir=~/mydb --config=deploy.xml $ voltdb start --dir=~/mydb --count=3 --host=zeus
The second example takes advantage of the defaults for the host and configuration arguments to initialize and start a single-node database in the current directory.
$ voltdb init $ voltdb start
The next example shows the use of the --force argument to re-initialize the directory used in the first example, to delete old data and set new configuration options from a different configuration file.
$ voltdb init --dir=~/mydb --config=newdeploy.xml --force
 The init --force command deletes command logs and overflow subfolders within the database
root directory. However, to avoid accidentally deleting backups, the snapshots subfolder is renamed rather than
deleted. This way, it is possible to restore a snapshot in case of an unintended re-initialization. On the other
hand, this means you should periodically check your database root directories and purge any archived snapshots
snapshots.nn) that are no longer needed.