Skip to content

sp-syscollector-delete-collection-set-transact-sql.md

Latest commit

 

History

History
78 lines (54 loc) · 2.47 KB

sp-syscollector-delete-collection-set-transact-sql.md

File metadata and controls

78 lines (54 loc) · 2.47 KB
title sp_syscollector_delete_collection_set (Transact-SQL)
description Deletes a user-defined collection set and all its collection items.
author markingmyname
ms.author maghan
ms.reviewer randolphwest
ms.date 06/23/2025
ms.service sql
ms.subservice system-objects
ms.topic reference
f1_keywords
sp_syscollector_delete_collection_set_TSQL
sp_syscollector_delete_collection_set
helpviewer_keywords
data collector [SQL Server], stored procedures
sp_syscollector_delete_collection_set
dev_langs
TSQL

sp_syscollector_delete_collection_set (Transact-SQL)

[!INCLUDE SQL Server]

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

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

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.

USE msdb;
GO

EXECUTE dbo.sp_syscollector_delete_collection_set @collection_set_id = 4;

Related content