sp_syscollector_stop_collection_set (Transact-SQL)

停止收集组。

适用范围:SQL Server(SQL Server 2008 到当前版本)。

主题链接图标 Transact-SQL 语法约定

语法

sp_syscollector_stop_collection_set 
    [ [ @collection_set_id = ] collection_set_id ]
    , [ [ @name = ] 'name' ]
    , [ [ @stop_collection_job = ] stop_collection_job ]

参数

  • [ @collection\_set\_id = ] collection_set_id
    收集组的唯一本地标识符。 collection_set_id 的数据类型为 int,默认值为 NULL。 如果 name 为 NULL,则 collection_set_id 必须包含值。

  • [ @name = ] 'name'
    收集组的名称。 name 的数据类型为 sysname,默认值为 NULL。 如果 collection_set_id 为 NULL,则 name 必须包含值。

  • [ @stop\_collection\_job = ] stop_collection_job
    指定应停止收集组的收集作业(如果正在运行)。 stop_collection_job 的数据类型为 bit,默认值为 1。

    stop_collection_job 仅应用于收集模式设置为缓存的收集组。 有关详细信息,请参阅 sp_syscollector_create_collection_set (Transact-SQL)

返回代码值

0 (成功)或 1(失败)

注释

必须在 msdb 系统数据库的上下文中运行 sp_syscollector_create_collection_set。

权限

需要具有 dc_operator(拥有 EXECUTE 权限)固定数据库角色的成员身份才能执行此过程。

示例

以下示例使用收集组的标识符停止此收集组。

USE msdb;
GO
EXEC sp_syscollector_stop_collection_set @collection_set_id = 1;

请参阅

参考

数据收集器存储过程 (Transact-SQL)

概念

数据收集