3.2. Initializing the Database Root Directory


VoltDB Home » Documentation » Administrator's Guide

3.2. Initializing the Database Root Directory

Once you create the configuration file, you are ready to initialize the database root directory, using the voltdb init command. You issue this command on each node of the cluster, specifying the configuration file and the location for the root directory. For example:

$ voltdb init --dir=~/database          1
              --config=deployment.xml   2

On the command line, you specify two arguments:


The location where the root directory will be created


The configuration file, which enables and sets attributes for specific VoltDB features

When you initialize the root directory, VoltDB:

  1. Creates the root directory (voltdbroot) as a subfolder of the specified parent directory

  2. Saves the configuration options in the new root directory

Note that you only need to initialize the root directory once. Once the root directory is initialized, you can start and stop the database as needed. VoltDB uses the root directory to manage the current configuration options and backups of the data — if those features are selected — in command logs and snapshots.

If the root directory already exists or has been initialized before, you cannot re-initialize the directory unless you include the --force argument. This is to protect you against accidentally deleting data from a previous database session.