PHPackages                             samynw/pimcore-maintenance-toolbox - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. samynw/pimcore-maintenance-toolbox

ActivePimcore-bundle

samynw/pimcore-maintenance-toolbox
==================================

This provides a set of usefull tools for the Pimcore maintenance

v2.0.0(4y ago)36.6k↓50%[1 issues](https://github.com/samynw/pimcore-maintenance-toolbox/issues)MITPHP

Since Nov 13Pushed 4y ago1 watchersCompare

[ Source](https://github.com/samynw/pimcore-maintenance-toolbox)[ Packagist](https://packagist.org/packages/samynw/pimcore-maintenance-toolbox)[ RSS](/packages/samynw-pimcore-maintenance-toolbox/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)Dependencies (3)Versions (8)Used By (0)

Pimcore maintenance toolbox
===========================

[](#pimcore-maintenance-toolbox)

This provides a set of usefull tools for the Pimcore maintenance

Features include following console commands:

- [maintenance:list](#task-overview): get a list of maintenance tasks and whether they are locked or not
- [maintenance:release-lock](#unlock-maintenance-tasks): manually unlock a maintenance task (for example after the process got killed)

Installation
------------

[](#installation)

```
# Add package to composer dependencies
composer require samynw/pimcore-maintenance-toolbox

# Enable and install bundle
php bin/console pimcore:bundle:enable MaintenanceToolboxBundle
php bin/console pimcore:bundle:install MaintenanceToolboxBundle
```

Configuration
-------------

[](#configuration)

The bundle can be configured through the extension manager in the Pimcore admin interface.

[![Configuration form](docs/img/configuration_form.png)](docs/img/configuration_form.png)

Features
--------

[](#features)

### Task overview

[](#task-overview)

This command will print a table with all registered maintenance tasks and their locked status. If possible also the lock expiration and current duration of the task is shown.

#### Options:

[](#options)

- `--locked`: flag to only show the locked tasks (optional)
- `--sort` (`-s`): sort the table by either task name or by lock (optional)
    - supported values: `name`, `lock`
    - default value: `name`

#### Example full list

[](#example-full-list)

```
$ php bin/console maintenance:list

+----------------------------------+--------+---------------------+-----------+
| Maintenance task                 | Locked | Lock expiration     | Duration  |
+----------------------------------+--------+---------------------+-----------+
| archiveLogEntries                | ❌      |                     |           |
| asset_document_convert           | ❌      |                     |           |
| checkerrorlogsdb                 | ✔      | 2020-11-14 11:22:55 | 00h10m13s |
| cleanupBrickTables               | ❌      |                     |           |
| ...                              | ...    | ...                 | ...       |
| scheduledtasks                   | ❌      |                     |           |
| tmpstorecleanup                  | ❌      |                     |           |
| versioncleanup                   | ✔      | 2020-11-14 11:16:25 | 00h16m43s |
| versioncompress                  | ❌      |                     |           |
| VersionsCleanupStackTraceDb      | ❌      |                     |           |
+----------------------------------+--------+---------------------+-----------+
```

(note: sample output was shorted for readability)

#### Example list limited to locked tasks

[](#example-list-limited-to-locked-tasks)

```
$ php bin/console maintenance:list --locked

+------------------+--------+---------------------+-----------+
| Maintenance task | Locked | Lock expiration     | Duration  |
+------------------+--------+---------------------+-----------+
| checkerrorlogsdb | ✔      | 2020-11-14 11:22:55 | 00h12m20s |
| versioncleanup   | ✔      | 2020-11-14 11:16:25 | 00h18m50s |
+------------------+--------+---------------------+-----------+
```

#### Example list sorted by duration

[](#example-list-sorted-by-duration)

```
$ php bin/console maintenance:list --sort=lock

+----------------------------------+--------+---------------------+-----------+
| Maintenance task                 | Locked | Lock expiration     | Duration  |
+----------------------------------+--------+---------------------+-----------+
| versioncleanup                   | ✔      | 2020-11-14 11:16:25 | 00h20m01s |
| checkerrorlogsdb                 | ✔      | 2020-11-14 11:22:55 | 00h13m31s |
| archiveLogEntries                | ❌      |                     |           |
| asset_document_convert           | ❌      |                     |           |
| ...                              | ❌      |                     |           |
| versioncompress                  | ❌      |                     |           |
| VersionsCleanupStackTraceDb      | ❌      |                     |           |
+----------------------------------+--------+---------------------+-----------+
```

(note: sample output was shorted for readability)

### Unlock maintenance tasks

[](#unlock-maintenance-tasks)

The bundle includes a command to release the lock from a maintenance task.

However the locks are set to prevent concurring executions and therefor should not be removed manually. In some cases however this might be usefull, for example if the maintenance process got killed and the lock got stuck untill the expiration key ends.

To prevent reckless unlocking the following are made:

- feature is disabled by default (enable in module cofiguration)
- user first gets a warning and has to confirm the action

#### Example of manually releasing a job lock

[](#example-of-manually-releasing-a-job-lock)

```
$ php bin/console maintenance:release-lock versioncleanup

 !
 ! [CAUTION] THIS MIGHT BE AN UNSAFE OPERATION.
 !

 ! [NOTE] You've requested to remove the lock from a maintenance job.
 !        In normal circumstances this should never be done manually.
 !        Removing a job lock, might lead to concurring processes and unexpected behaviour.
 !        Do not continue unless you fully comprehend the possible consequences of this action.

 Are you sure you want to release the job lock for "versioncleanup"? (y/n)  (yes/no) [no]:
 > yes

 [OK] Job "versioncleanup" has been unlocked
```

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance13

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~52 days

Total

5

Last Release

1805d ago

Major Versions

v1.1.0 → v2.0.02021-06-08

### Community

Maintainers

![](https://www.gravatar.com/avatar/bf3ead68225716ef3d31b7801dd54e934b318f76ce03bf64383485fd54bb7359?d=identicon)[samynw](/maintainers/samynw)

---

Top Contributors

[![samynw](https://avatars.githubusercontent.com/u/11783803?v=4)](https://github.com/samynw "samynw (86 commits)")

---

Tags

pimcorepimcore-bundle

### Embed Badge

![Health badge](/badges/samynw-pimcore-maintenance-toolbox/health.svg)

```
[![Health](https://phpackages.com/badges/samynw-pimcore-maintenance-toolbox/health.svg)](https://phpackages.com/packages/samynw-pimcore-maintenance-toolbox)
```

###  Alternatives

[pimcore/data-hub

Pimcore Datahub

1351.3M9](/packages/pimcore-data-hub)[pimcore/admin-ui-classic-bundle

171.1M46](/packages/pimcore-admin-ui-classic-bundle)[pimcore/data-importer

Adds a comprehensive import functionality to Pimcore Datahub

44763.4k2](/packages/pimcore-data-importer)[pimcore/studio-backend-bundle

Pimcore Studio Backend Bundle

19112.5k3](/packages/pimcore-studio-backend-bundle)[pimcore/studio-ui-bundle

Pimcore Studio Ui Bundle

2751.3k2](/packages/pimcore-studio-ui-bundle)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
