sp_syscollector_delete_collection_item (Transact-SQL)
Область применения: SQL Server
Удаляет элемент сбора из набора сбора.
Соглашения о синтаксисе Transact-SQL
Синтаксис
sp_syscollector_delete_collection_item
[ [ @collection_item_id = ] collection_item_id ]
[ , [ @name = ] N'name' ]
[ ; ]
Аргументы
[ @collection_item_id = ] collection_item_id
Уникальный идентификатор элемента коллекции. @collection_item_id имеет значение int с значением по умолчаниюNULL
. @collection_item_id должно иметь значение, если @name NULL
.
[ @name = ] N'name'
Имя элемента сбора. @name — sysname, по умолчанию — пустая строка. @name должно иметь значение, если @collection_item_id NULL
.
Значения кода возврата
0
(успешно) или 1
(сбой).
Замечания
sp_syscollector_delete_collection_item
должен выполняться в контексте msdb
системной базы данных. Элементы коллекции нельзя удалить из системных наборов коллекций.
Во время этой операции набор сбора, содержащий элемент сбора, останавливается и перезапускается.
Разрешения
Для выполнения этой процедуры требуется членство в предопределенных ролевые роли базы данных dc_admin (с разрешением EXECUTE).
Примеры
В следующем примере удаляется элемент сбора с именем MyCollectionItem1
.
USE msdb;
GO
EXEC sp_syscollector_delete_collection_item @name = 'MyCollectionItem1';