Edit

sp_syscollector_delete_collection_item (Transact-SQL)

  • Article

Applies to: SQL Server

Deletes a collection item from a collection set.

Transact-SQL syntax conventions

Syntax

sp_syscollector_delete_collection_item
    [ [ @collection_item_id = ] collection_item_id ]
    [ , [ @name = ] N'name' ]
[ ; ]

Arguments

[ @collection_item_id = ] collection_item_id

The unique identifier for the collection item. @collection_item_id is int, with a default of NULL. @collection_item_id must have a value if @name is NULL.

[ @name = ] N'name'

The name of the collection item. @name is sysname, with a default of an empty string. @name must have a value if @collection_item_id is NULL.

Return code values

0 (success) or 1 (failure).

Remarks

sp_syscollector_delete_collection_item must be run in the context of the msdb system database. Collection items can't be deleted from system collection sets.

The collection set that contains the collection item is stopped and restarted during this operation.

Permissions

Requires membership in the dc_admin (with EXECUTE permission) fixed database role to execute this procedure.

Examples

The following example deletes a collection item named MyCollectionItem1.

USE msdb;
GO
EXEC sp_syscollector_delete_collection_item @name = 'MyCollectionItem1';

Related content