Preliminary documentation for Ice 3.7.1 Beta. Do not use in production applications. Refer to the space directory for other releases.

The icestormdb utility is a command-line tool for importing and exporting IceStorm databases.

On this page:

Usage

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

Usage: icestormdb <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).
 -d, --debug            Print debug messages.

Exporting an IceStorm Database

To export an IceStorm database, use the --export option to specify the output file and the --dbpath option to specify the path name of the database. For example, use the following command to export a database found in the db directory to a file named db.ixp:

$ icestormdb --export db.ixp --dbpath db

You can export an IceStorm database while IceStorm is actively using this database. Write operations to the IceStorm database will block while icestormdb is reading the database.

If you want to back-up the IceStorm database while IceStorm is running, we recommend using the mdb_copy tool.

Importing an IceStorm Database

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

$ icestormdb --import db.ixp --dbpath dbNew

The target directory must be empty.

mapsize Option

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

Compatibility

Besides importing files that it creates itself, icestormdb can also import the files exported by the Ice 3.5 (icestormdb35) and Ice 3.6 versions of this utility.

  • No labels