The
clean task manually removes stale generations of records
from a specified Record Store instance.
By default, the
clean task runs automatically as a background process,
at time intervals specified by the
cleanerInterval configuration property. The
clean task automatically removes record generations
that exceed the
generationRetentionTime configuration property.
The task syntax is:
recordstore-cmd clean -a RecordStoreInstanceName [-h HostName] [-l true|false] [-p PortNumber]
where:
-a (or --instanceName) specifies the name of a Record Store instance. Required.
-h (or --host) specifies the host where the CAS Service is running. If the flag is omitted, the default is the value of the
com.endeca.itl.cas.server.hostproperty incommandline.properties. If the property is not set, the value then defaults to localhost. Optional.-l (or --isPortSsl) specifies whether to communicate with the service using an HTTPS connection. A value of true uses HTTPS and treats the
com.endeca.itl.cas.server.portproperty as an SSL port. A value of false uses HTTP and treatscom.endeca.itl.cas.server.portas a non-SSL port. Specify false if you enabled redirects from a non-SSL port to an SSL port. Optional.-p (or --port) specifies the port of the CAS Service. If the flag is omitted, the default is the value of the
com.endeca.itl.cas.server.portproperty incommandline.properties. If the property is not set, the value then defaults to 8500. Optional.
Note that only one
clean process can run at a time, and a
clean task cannot run when other transactions are
running. If a
clean task is running when you issue this command, an
exception is thrown and the second
clean process does not run.
There are several cases where the
clean task does not remove eligible generations in a
Record Store instance:
