2.4. What is Included in the VoltDB Distribution

Documentation

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.
Example ApplicationsVoltDB comes with several example applications that demonstrate VoltDB capabilities and performance. They can be found in the /examples subfolder.
VoltDB Web StudioWeb Studio is a browser-based tool for visualizing and querying a running VoltDB database that is bundled with the VoltDB server software. You can start Web Studio by connecting to the HTTP port of a running VoltDB database server. For example, http://voltsvr:8080/studio. Note that the httpd server and JSON interface must be enabled to access Web Studio from the server.
Shell CommandsThe /bin subfolder contains executable scripts to perform common VoltDB tasks, such as compiling application catalogs and starting the VoltDB server. Add the /bin subfolder to your PATH environment variable to use the following shell commands:
csvloader
sqlcmd
voltadmin
voltdb
DocumentationOnline documentation, including the full manuals and javadoc describing the Java programming interface, is available in the /doc subfolder.