purgeCollection

Available for: Search Engine Server

Task: This command empties a collection by removing all indexed documents from it. The collection itself, however, is preserved.

Syntax

purgeCollection collectionName

Function parameters

  • collectionName: The name of the collection to purge. For switchable collections this command refers to the offline collection.

Return value: The command has no return value. If the specified collection does not exist, the error message "The collection ’collectionName’ does not exist." is displayed. If the command fails, the message "Purging collection ’collectionName’ failed." is displayed.

Example

SES>purgeCollection sportsNews