4.3. Using the Example Applications to Learn VoltDB

The examples can be very helpful in learning how to develop applications in VoltDB. In particular:

  • Performance — The primary focus of VoltDB is on best-in-class throughput performance. All of the samples in the examples folder are designed to demonstrate outstanding performance. These samples use convenience classes and methods to produce an application that integrates benchmarking and automated throttling, which helps optimize throughput and latency. See the README file for each application for additional information on running the application in different configurations.

  • Build Process — The run.sh file for each example shows how the application is constructed from its various parts. If you plan on using shell scripts to build your applications, you can use the examples as a template for writing your own script file.

  • Sample Code — Each example comes complete with source code for the stored procedures, client application, database schema, and project definition file. In addition to the example applications, the doc/tutorials folder contains source code for other examples (Hello World and Auction) that demonstrate use of the basic VoltDB Java API.