exp:expcontentjob

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

Run, list, resume and cancel content jobs: large subtree removes and copies in batches

Usage

./console exp:expcontentjob [options]
php bin/php/expcontentjob.php [options]

Help

The output of ./console help exp:expcontentjob (the script run with --help), without the standard options:

Usage: bin/php/expcontentjob.php [OPTION]...
Content jobs: large subtree removes and copies, run in batches in the background.

  list [--all] [--resume]              the jobs (heartbeat age, stalled); --resume: resume every stalled or failed one
  show <id> [--json]                   one job and the end of its log
  run <id>                             run a job in the foreground
  resume <id> [--background]           resume a failed job or one whose worker died
  cancel <id>                          stop a job after its current batch
  remove <node id>[,...] [--trash|--delete] [--background]
  copy <src node> <dest parent> [--all-versions] [--keep-creator] [--keep-time] [--background]
  move <node> <new parent> | hide <node> | reveal <node> | section <node> <section id> [--scope=...] | state <node> <state id>
  addlocation <target node> <node>[,...] | removelocation <node>[,...]        (all: [--background])



Options:
  --all           list: every job, not only the active and failed ones
  --resume        list: resume every stalled or failed job, each with a worker in the background
  --json          show: the job as JSON
  --background    remove, copy, resume: start a detached worker and return
  --trash         remove: move the objects to the trash (the default of content.ini [RemoveSettings])
  --delete        remove: delete the objects permanently
  --all-versions  copy: copy all versions of each object, not only the current one
  --keep-creator  copy: keep the owner and creator of the copied objects
  --keep-time     copy: keep the creation and modification times
  --scope=VALUE   section: which objects below the node get the section: subtree (the default, all of them), inherited (those that have the section of the node's object, not branches in another section) or object (none)

Options

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/expcontentjob.php, kernel/private/classes/commands/expcontentjob.php

See also

Generated example: exp:expcontentjob

Added to the reference for Exponential 6.0.15.