sp_syscollector_delete_collection_set (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Deletes a user-defined collection set and all its collection items.

||
|-|
|Applies to: SQL Server ( SQL Server 2008 through current version).|

Topic link icon Transact-SQL Syntax Conventions

Syntax


sp_syscollector_delete_collection_set [[ @collection_set_id = ] collection_set_id OUTPUT ]  
    , [[ @name = ] 'name' ]  

Arguments

[ @collection_set_id = ] collection_set_id
Is the unique identifier for the collection set. collection_set_id is int and must have a value if name is NULL.

[ @name = ] 'name'
Is the name of the collection set. name is sysname and must have a value if collection_set_id is NULL.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_syscollector_delete_collection_set must be run in the context of the msdb system database.

Either collection_set_id or name must have a value, both cannot be NULL. To obtain these values, query the syscollector_collection_set system view.

System-defined collection sets cannot be deleted.

Permissions

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

Examples

The following example deletes a user-defined collection set specifying the collection_set_id.

USE msdb;  
GO  
EXEC dbo.sp_syscollector_delete_collection_set  
    @collection_set_id = 4;  

See Also

Data Collector Stored Procedures (Transact-SQL)
Data Collection
syscollector_collection_sets (Transact-SQL)