voltdb

Documentation

VoltDB Home » Documentation » Using VoltDB

voltdb

voltdb — Performs management tasks on the current server, such as starting and recovering the database.

Synopsis

voltdb collect [args] voltdbroot-directory

voltdb mask [args] source-deployment-file [new-deployment-file]

voltdb init [args]

voltdb start [args]

Description

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

  • Hiding passwords in the deployment 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. The only required argument to the collect command is the path to the voltdbroot directory where the database was run. By default, the root directory is a subfolder, voltdbroot, in the current working directory where the database was started.

  • mask — the mask option disguises the passwords associated with user accounts in the security section of the deployment file. The output of the voltdb mask command is either a new deployment 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 and/or automated snapshots, 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:

    export VOLTDB_OPTS="-DmyApp.DebugFlag=true"

Log Collection (voltdb collect) Arguments

The following arguments apply specifically to the collect action.

--days={integer}

Specifies the number of days of log files to collect. For example, using --days=1 will collect data from the last 24 hours. By default, VoltDB collects 14 days (2 weeks) worth of logs.

--dry-run

Lists the actions that will be taken, including the files that will be collected, but does not actually perform the collection or upload.

--no-prompt

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.

--prefix={file-prefix}

Specifies the prefix for the resulting output file. The default prefix is "voltdb_logs".

--skip-heap-dump

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.

--upload={host}

Specifies a host server to which the output file will uploaded using SFTP.

--username={account-name}

Specifies the SFTP account to use when using the --upload option. If you specify --upload but not --username, you will be prompted for the account name.

--password={password}

Specifies the password to use when using the --upload option. If you specify --upload but not --password, you will be prompted for the password.

Initialization (voltdb init) Arguments

The following arguments apply to the voltdb init command.

-C --config={configuration-file}

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, Deployment 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.

-D --dir={directory}

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 directory.

-f, --force

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.

Database Startup (voltdb start) Arguments

The following arguments apply to the voltdb start command.

-D --dir={directory}

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.

-H, --host={ host-id [,...] }

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.

-c, --count={number-of-nodes}

Specifies the number of nodes in the database cluster.

--add

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.

-B, --background

Starts the server process in the background (as a daemon process).

-g, --placement-group={group-string}

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-string, which is any set of alphanumeric names separated by periods. The names might represent physical servers, racks, switches, or anything meaningful to the user to avoid multiple copies failing at the same time. For example, the string might be "row6.rack5.server3", to ensure that in a virtualized environment copies of the same partition do not get placed on the same physical server or rack if possible. The group strings for all nodes of the cluster are compared so matches of the rightmost name will be avoided first, then matches of the two rightmost names, and so on.

--ignore=thp

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.

-l, --license={license-file}

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.

--pause

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.

-r, --replica

For the create and recover operations only, specifies that the database starts in read-only mode as a replica for database replication (DR). To create or recover a replica database, the deployment file must configure DR appropriately, including a <connection> tag identifying the source, or master database, for replication. See Chapter 11, Database Replication for more information.

Network Configuration Arguments

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.

--externalinterface={ip-address}

Specifies the default network interface to use for external ports, such as the admin and client ports.

--internalinterface ={ip-address}

Specifies the default network interface to use for internal communication, such as the internal port.

--publicinterface={ip-address}

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.

--admin=[ip-address:]{port-number}

Specifies the admin port. The --admin flag overrides the admin port setting in the deployment file.

--client=[ip-address:]{port-number}

Specifies the client port.

--http=[ip-address:]{port-number}

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 deployment file.

--internal=[ip-address:]{port-number}

Specifies the internal port used to communicate between cluster nodes.

--replication=[ip-address:]{port-number}

Specifies the replication port used for database replication. The --replication flag overrides the replication port setting in the deployment file.

--zookeeper=[ip-address:]{port-number}

Specifies the zookeeper port. By default, the zookeeper port is bound to the server's internal interface (127.0.0.1).

Examples

The first example shows the commands for initializing and starting a three-node database cluster using a custom configuration file, 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 deployment 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