HELP: Prune (cleanup) archive TYPE: OBJECT SYNTAX: PRUNE(NET.{},STORE/SAVE.{},LOGGING.{},MESSAGE(),NORUN)
The PRUNE subcommand can be used to cleanup a FLAM archive. When an archive version is deleted, it is no longer referenced, but the data still exists in storage. Pruning an archive will delete all segments or objects which are no longer referenced from the archive.
Depending on the storage backend, pruning may take a long time and the amount of released space may vary. When the flatfile backend is used, pruning will rewrite the whole file, only taking into account the data segments that are still referenced. Hence, the disk space required by the archive might temporarily double during prune. For object-based storage backends (which includes the FOLDER backend), pruning is performed much quicker by simply deleting unreferenced objects.
To get syntax information, please use:
flcl SYNTAX ARCHIVE.PRUNE
To get help for a parameter, please use:
flcl HELP ARCHIVE.PRUNE.parameter[.parameter[...]]
To read the manual page for a parameter, please use:
flcl MANPAGE ARCHIVE.PRUNE.parameter[.parameter[...]] or flcl HELP ARCHIVE.PRUNE.parameter[.parameter[...]] MAN
To generate the user manual for the command, please use:
flcl GENDOCU ARCHIVE.PRUNE=filename
Parameters can be defined via command line (directly or by parameter file) or via properties taken from the corresponding property file.
SWITCH: NORUN - Don't run the command, only show parsed parameter