Léigh i mBéarla Cuir in eagar

Comhroinn trí

sp_syscollector_delete_collection_set (Transact-SQL)

  • Alt

Applies to: SQL Server

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

Transact-SQL syntax conventions

Syntax

syntaxsql 
sp_syscollector_delete_collection_set
    [ [ @collection_set_id = ] collection_set_id ]
    [ , [ @name = ] N'name' ]
[ ; ]

Arguments

[ @collection_set_id = ] collection_set_id

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

[ @name = ] N'name'

The name of the collection set. @name is sysname, with a default of NULL. @name 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 can't be NULL. To obtain these values, query the syscollector_collection_set system view.

System-defined collection sets can't 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.

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

Related content