Documentation Center

Purging queues

SDL Tridion Sites maintains a number of queues for publishing, deploying, searching, Workflow, and batches. These queues also contain messages. You can purge messages in these queues to free up space in your database.

Before you begin

To purge these queues, you must have system administration rights. You must also have the DLL for purging loaded in Windows PowerShell.

Procedure

From the PowerShell command prompt, enter the command Remove-TcmQueueMessages, applying the following parameters:
Queue

An optional array of Strings listing which queues to purge messages from. If not specified, messages are purged in all queues. The array can contain the following strings:

PublishQueue
Purge publish queue messages.
DeployQueue
Purge content deployment messages.
SearchQueue
Purge search queue messages.
WorkflowAgentQueue
Purge workflow queue messages.
BatchQueue
Purge batch queue messages.

Queue is a positional argument at position 0: you do not need to supply the -Queue switch and as a result, can pass this value from the previous command in a pipeline command.

SDL Tridion Sites purges the messages in the queues you specified (or in all queues if you specified nothing). There is no return value.

You can also obtain information about the various queues using the Get-TcmQueueInfo command, which returns a list of QueueData objects as an IEnumerable.