clusterpurge.php

Summary

eZ Publish cluster files purge.

Location

./bin/php/clusterpurge.php

Parameters

allow-root-user
colors
debug
dry-run
expiry
help
iteration-limit
iteration-sleep
logfiles
memory-monitoring
no-colors
no-logfiles
quiet
scopes
siteaccess
verbose

-r,--allow-root-user

Allows your root user to run the clusterpurge.php script. The usage of this parameter is only recommended for advanced users. With great power comes great responsibility.

-c, --colors

Use ANSI colors when generating debug output (default).

-d[<option>[,<option2>...]], --debug[=<option>[,<option2>...]]

Output debug information. The following options can be used to control what the debug output should include: "all" (everything), "accumulator" (accumulators), "include" (included files), "timing" (timing points), "error" (errors), "warning" (warnings), "notice" (notices).

--dry-run

Test mode, output the list of affected files without removing them.

--expiry=VALUE

Number of days since the file was expired. Only files older than this will be purged. Default is 30, minimum is 1.

-h, --help

Output information about the script and supported parameters.

--iteration-limit=VALUE

Amount of items to remove in each iteration when performing a purge operation. Default is 100.

--iteration-sleep=VALUE

Amount of seconds to sleep between each iteration when performing a purge operation, can be a float. Default is one second.

--logfiles

Generate log files. This parameter must be used together with the debug parameter ("-d" or "--debug"). The log files (for example "warning.log") will be stored in the "var/log" directory of the eZ Publish installation.

--memory-monitoring

Generates memory monitoring output. If set, memory usage will be logged in var/log/clusterpurge.log.

--no-colors

Do not use ANSI colors when generating debug output.

--no-logfiles

Do not generate log files (default).

-q, --quiet

Run the script in "quiet" mode. No output will be generated.

--scopes=VALUE

Comma separated list of file types to purge. Possible values are: classattridentifiers, classidentifiers, content, expirycache, statelimitations, user-info-cache, viewcache, wildcard-cache-index, image, binaryfile, media.

-s <siteaccess>, --siteaccess=<siteaccess>

The siteaccess to run the script for. If omitted, the default siteaccess will be used.

-v, --verbose

Output verbose / additional information.

Description

Physically purges files.

php bin/php/clusterpurge.php [OPTION]

Examples

Example 1

php bin/php/clusterpurge.php

Example 2

php bin/php/clusterpurge.php --scopes=user-info-cache,viewcache --expiry=20

Example 3

php bin/php/clusterpurge.php --scopes=user-info-cache,viewcache, --expiry=30 --memory-monitoring