1. Sitecore CLI command reference

The CLI dbcleanup command

The Sitecore CLI Database Cleanup plugin performs database cleanup according to the provided tasks.

Warning

This command triggers a full cache cleanup, and it can cause performance degradation. It should be executed during a maintenance window.

Usage

The dbcleanup command requires elevated permissions.

You can use the dbcleanup command as follows:

bash
sitecore dbcleanup [options]

Options

The dbcleanup command has the following options:

  • --db <list-of-databases>, --database <list-of-databases> - Comma-separated list of databases targeted for cleanup tasks.
  • --cf, --clean-fields - Clean up fields. Deletes data from shared, unversioned, and versioned fields that have no related items.
  • --cof, --clean-orphanfields - Clean up orphaned fields. Cleans the field data from the orphans removed in items with no parent.
  • --cb, --clean-blobs - Clean up blobs. Deletes blob fields that have no related field.
  • -c, --config - Path to root sitecore.config directory. Default: current working directory.
  • -n, --environment-name - Named Sitecore environment to use. Default: default.
  • -v, --verbose - Write some additional diagnostic and performance data.
  • -t, --trace - Write more additional diagnostic and performance data.
  • -?, -h, --help - Display developer help and usage information about the command.

Examples

The following examples show how to use the dbcleanup subcommand.

Run all cleanup tasks on all databases

Command:

bash
sitecore dbcleanup

Result:

text
Performed all cleanup tasks on all databases.
[Task][core] clean-fields completed
[Task][core] clean-blobs completed
[Task][core] clean-orphanfields completed
[Task][master] clean-fields completed
[Task][master] clean-blobs completed
[Task][master] clean-orphanfields completed

Run the clean-blobs task on the Master database

Command:

bash
sitecore dbcleanup --db master --cb

Result:

text
Performed the clean-blobs task for the Master database.
[Task][master] clean-blobs completed
If you have suggestions for improving this article, let us know!