1.2. Understanding the VoltDB Utilities

Documentation

Home » Documentation » Administrator's Guide

1.2. Understanding the VoltDB Utilities

VoltDB provides several command line utilities, each with a different function. Familiarizing yourself with these utilities and their uses can make managing VoltDB databases easier. The three primary command line tools for creating, managing, and testing VoltDB databases are:

voltdb

Compiles application catalogs and starts the VoltDB database process. The voltdb command can also collect log files for analyzing possible system errors (see Section 6.3.1, “Collecting Log Files Using the Command Line” for details).

The voltdb command runs locally and does not require a running database.

voltadmin

Issues administrative commands to a running VoltDB database. You can use voltadmin to save and restore snapshots, pause and resume admin mode, and to shutdown the database, among other tasks.

The voltadmin command can be run remotely, performs cluster-wide operations and requires a running database to connect to.

sqlcmd

Lets you issue SQL queries and invoke stored procedures interactively. The sqlcmd command is handy for testing database access without having to write a client application.

The sqlcmd command can be run remotely and requires a running database to connect to.

In addition to the preceding general-purpose tools, VoltDB provides several other tools for specific tasks:

csvloader

Loads records from text files into an existing VoltDB database. The command's primary use is for importing data into VoltDB from CSV and other text-based data files that were exported from other data utilities,

The csvloader command can be run remotely and requires a running database to connect to.

dragent

Starts the database replication agent, initiating replication between a master and a replica database.

The dragent command is run separately from the database servers but requires both a running master database and replica database.

snapshotconvert

Converts native snapshot files to csv or tabbed text files. The snapshotconvert command is useful when exporting a snapshot in native format to text files for import into another data utility. (This utility is provided for legacy purposes. It is now possible to write snapshots directly to CSV format without post-processing, which is the recommended approach.)

The snapshotconvert command runs locally and does not require a running database.

snapshotverify

Verifies that a set of native snapshot files are complete and valid.

The snapshotverify command runs locally and does not require a running database.