Ice Docs

IceGrid Database Utility

4 min read

4 min read

4 min read

4 min read

4 min read

4 min read

4 min read

4 min read

4 min read

The icegriddb utility is a command-line tool for importing and exporting an IceGrid registry database.

The IceGrid Database utility supports the following command-line options:

Usage: icegriddb <options>
Options:
 -h, --help             Show this message.
 -v, --version          Display version.
 --import FILE          Import database from FILE.
 --export FILE          Export database to FILE.
 --dbpath DIR           Source or target database environment.
 --mapsize VALUE        Set LMDB map size in MB (optional, import only).
 --server-version VER   Set Ice version for IceGrid servers (optional, import only).
 -d, --debug            Print debug messages.

To export an IceGrid registry database, use the --export option to specify the output file and the --dbpath option to specify the path name of the registry's database directory. To discover the location of your database, review the registry's configuration and look for the setting of IceGrid.Registry.LMDB.Path. For example, the IceGrid sample programs typically use this setting:

Properties
IceGrid.Registry.LMDB.Path=db/registry

Run the following command to export the database:

Shell
icegriddb --export registry.ixp --dbpath db/registry

To import an IceGrid registry database, use the --import option to specify the input file and the --dbpath option to specify the path name of the registry's database directory. For example, use the following command to import a database into the dbNew/registry directory from a file named registry.ixp:

Shell
icegriddb --import registry.ixp --dbpath dbNew/registry

The target directory must be empty.

The --mapsize option allows you to set the map size of the new LMDB database. See IceGrid.Registry.LMDB.MapSize for additional information.

IceGrid allows you to assign an Ice version to each server it manages. IceGrid uses this information to generate configuration files for this server that are compatible with the specified Ice version. When a server has no associated Ice version, IceGrid assumes this server uses the same version of Ice, for example, IceGrid 3.8.2 assumes such a server also uses Ice 3.8.2.

By default, icegriddb does not change this ice-version attribute when importing IceGrid databases: an unset attribute remains unset, and a set attribute keeps the same value. You can make icegriddb change all unset ice-version attributes to a specific version with the --server-version option, as shown in the example below:

Shell
icegriddb --server-version 3.7.1 --import registry.ixp --dbpath dbNew/registry

Besides importing files that it creates itself, icegriddb can also import the files exported by older versions of this utility.