content.ini [ContentJobSettings] #

The block [ContentJobSettings] of settings/content.ini, with 12 setting(s).

Never edit settings/content.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/content.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/content.ini.append.php for one siteaccess,
• extension/<extension>/settings/content.ini.append.php in an extension (read when the extension is active).

SynchronousLimit #

Content jobs: large subtree removes (content/removeobject, content/removenode) and subtree copies
(content/copysubtree) run in batches in a background worker instead of in the web request, so they
never fail from a request time limit, a memory limit or one huge transaction. Each batch is a
transaction of its own, followed by a checkpoint: a job resumes where it stopped after any
interruption (kill -9 included). Classes in kernel/classes/contentjob/; the command
bin/php/expcontentjob.php (./console exp:expcontentjob list|show|run|resume|cancel|remove|copy).
Jobs live in var/<site var dir>/jobs/content/ (a cluster needs a shared var directory for them).

The user chooses per operation whether it runs now (in the request) or as a background job; this
sets the choice offered first: below this number of nodes "now", from it on "job". 0 = "job" always.

Default: 50.

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
SynchronousLimit=50
*/ ?>

NowLimit #

"Now" is refused above this number of nodes, with a message to run it as a job. 0 = no ceiling.

Default: 1000.

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
NowLimit=1000
*/ ?>

BatchSize #

Nodes per batch (one transaction each). On SQLite (one writer at a time) the worker halves the next batch
while one holds the write lock over 2 s, and grows it back to BatchSize when they are quick again.

Default: 50.

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
BatchSize=50
*/ ?>

BatchPause #

Pause between batches in milliseconds (0 = none), to leave room for other writers.

Default: 0.

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
BatchPause=0
*/ ?>

QueuedGrace #

A queued job whose worker has not started within this many seconds is started by the cronjob
part 'contentjobs' (frequent group); a running job whose worker died is started at once.

Default: 60.

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
QueuedGrace=60
*/ ?>

QueuedTimeout #

A queued job that no worker started within this many seconds (no cronjob runs, the start was lost) fails
and gives back its locks if it has done nothing yet, so it never blocks a subtree; resume it to try again.
A worker that cannot be started at all fails the job at once, with the reason. 0 = never expire.

Default: 600.

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
QueuedTimeout=600
*/ ?>

MaxAttempts #

A job whose worker is started this many times without finishing one batch is failed (with the
last error) instead of being retried for ever. Resume it once the cause is fixed.
It is also how often the cronjob part resumes a job on its own that failed for a temporary database
error (busy, locked, a deadlock); the count starts again after every batch done.

Default: 5.

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
MaxAttempts=5
*/ ?>

BusyRetries #

A batch that fails because the database is busy or locked (SQLite "database is busy" or "locked",
MySQL lock wait timeout 1205 or deadlock 1213) is rolled back and run again from the last checkpoint
up to this many times, after a pause that doubles each time (1, 2, 4 ... seconds). Then the job fails
with a temporary error, which the cronjob part resumes on its own. 0 = fail at the first such error.

Default: 8.

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
BusyRetries=8
*/ ?>

BusyBackoffMax #

The longest pause between two of those tries, in seconds.

Default: 60.

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
BusyBackoffMax=60
*/ ?>

KeepDays #

Finished (done or cancelled) jobs are removed by the cronjob part after this many days. 0 = never.

Default: 30.

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
KeepDays=30
*/ ?>

PhpBinary #

The PHP command line binary for the worker; empty = the PHP running the request (PHP_BINDIR/php).

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
PhpBinary=
*/ ?>

JobTypes #

The job types: JobTypes[<name>]=<class implementing expContentJobType>.
A package install in the background (Setup > Packages > Install, "Install in the background"), doc/eng-us/bc/6.0/package-json-format.md
An export of the audit console in the background (Audit > Export, "Export in the background"), doc/eng-us/bc/6.0/audit.md
The help's manuals built from the Markdown help in the background (a new installation queues it), doc/eng-us/features/6.0/help-content.md
A background run of an import or export tool (Export, CIE ...) when there is no job queue,
doc/eng-us/features/6.0/transfer-runs.md (transfer.ini)
A mass action of Dashboard > Recent content on more than [ModerationSettings] JobThreshold objects, doc/eng-us/features/6.0/moderation.md

Default: a hash of 14: remove=expContentJobRemoveSubtree, copy=expContentJobCopySubtree, move=expContentJobMoveSubtree, hide=expContentJobHideSubtree, reveal=expContentJobRevealSubtree, section=expContentJobSectionSubtree, state=expContentJobStateSubtree, addlocation=expContentJobAddLocation, removelocation=expContentJobRemoveLocation, packageinstall=expContentJobPackageInstall, auditexport=expContentJobAuditExport, helpmanuals=expContentJobHelpManuals ....

<?php /* #?ini charset="utf-8"?
# settings/override/content.ini.append.php
[ContentJobSettings]
# an empty "JobTypes[]" first replaces the shipped list; without it the items are added
JobTypes[]
JobTypes[remove]=expContentJobRemoveSubtree
JobTypes[copy]=expContentJobCopySubtree
JobTypes[move]=expContentJobMoveSubtree
JobTypes[hide]=expContentJobHideSubtree
JobTypes[reveal]=expContentJobRevealSubtree
JobTypes[section]=expContentJobSectionSubtree
JobTypes[state]=expContentJobStateSubtree
JobTypes[addlocation]=expContentJobAddLocation
JobTypes[removelocation]=expContentJobRemoveLocation
JobTypes[packageinstall]=expContentJobPackageInstall
JobTypes[auditexport]=expContentJobAuditExport
JobTypes[helpmanuals]=expContentJobHelpManuals
JobTypes[transfer]=expContentJobTransfer
JobTypes[moderation]=expContentJobModeration
*/ ?>

Related #

• All blocks of content.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/content.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.