Database vacuum tool


rdm-vacuum [OPTION]… db-uri


rdm-vacuum is a command-line utility that vacuums data in the specified RDM database for reducing the amount of disk spaced used. The typical usage would be to vacuum the database in to its smallest disk footprint, for example:

$> rdm-vacuum --all BOOKSHOP

rdm-vacuum is a command-line utility that vacuums data in the specified RDM database for the purpose of reducing the amount of disk spaced used. Specify one of the options '--all', '--schema', or '--table' to do vacuuming. One pack file will be vacuumed for each invocation of this tool. Specifying '--new-pack' or without any of the previous options will honor those options without doing any explicit vacuuming.


-h, --help Display this usage information
--version Display the version information
-q, --quiet Quiet mode. No information will be displayed
--key=key Specify the encryption key for the database ([algorithm:]passcode). The valid algorithms are xor, aes128, aes192 and aes256. The AES algorithms are only available for packages that have strong encryption support. If an algorithm is not specified, the default is aes128 for strong encryption packages and xor otherwise.
--docroot=path The location of the docroot directory. (See Database Storage Location)
-a, --all Vacuum all the pack files. This option implies '--pack=<last-pack-ID>, '--new-pack' and '--sync'.
-p, --pack=ID Vacuum pack file ID and older
-n, --new-pack Force creation of a new pack file prior to vacuuming
-S, --sync Sync the pack file after vacuuming
-s, --schema Vacuum the schema system drawers (incompatible with first, best, and auto)
-t, --table=table_name Vacuum only the specified table. Use this option more than once to vacuum multiple tables. (incompatible with first, best, and auto
--db-size=size Maximum size of all pack files (in bytes)
--pack-file-size=size Maximum size of a pack file (in bytes)
-r, --restore Restore original database settings after vacuuming
--vacuum-percentage=percentage Percentage of in use in a pack file to vacuum
--vacuum-chunk-size=size The number of bytes to write to a pack in one vacuum cycle.
--log-level=level Set the log level (all, error, warning, or info). The default is info.
db-uri An RDM Database URI

Short options can be combined into one string starting with a single '-'. Mandatory arguments to long options are mandatory for short options too. Long option arguments can also be specified in a separate argument.


See Database Vacuuming for more information.