2.4. What is Included in the VoltDB Distribution

Documentation

VoltDB Home » Documentation » Using VoltDB

2.4. What is Included in the VoltDB Distribution

Table 2.2 lists the components that are provided as part of the VoltDB distribution.

Table 2.2. Components Installed by VoltDB

ComponentDescription
VoltDB Software & RuntimeThe VoltDB software comes as Java archives (.JAR files) and a callable library that can be found in the /voltdb subfolder. Other software libraries that VoltDB depends on are included in a separate /lib subfolder.
Volt Management Center

Volt Management Center is a browser-based management tool for monitoring, examining, and querying a running VoltDB database. The Management Center is bundled with the VoltDB server software and runs as a separate process, either on one of the database servers or a separate server. See the Volt Administrator's Guide or Volt Kubernetes Administrator's Guide for instructions on configuring and starting the VMC service.

You start the management console interface by connecting to the HTTP port of the VMC server. For example,

http://voltvmc:8080/. Note that the VMC service must be running to use the Management Center or the HTTP programming interface.
Shell CommandsThe /bin subfolder contains executable scripts to perform common VoltDB tasks, such as starting the VoltDB server process and issuing database queries from the command line using sqlcmd, Add the /bin subfolder to your PATH environment variable to use the following shell commands:
csvloader
jdbcloader
kafkaloader
sqlcmd
voltadmin
voltdb
DocumentationOnline documentation, including the full manuals and javadoc describing the Java programming interface, is available in the /doc subfolder.