sp_syscollector_stop_collection_set (Transact-SQL)

  • 项目

适用于：SQL Server

停止收集集。

Transact-SQL 语法约定

语法

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

参数

[ @collection_set_id = ] collection_set_id

集合集的唯一本地标识符。 @collection_set_id为 int，默认值为 NULL. 如果@name，NULL@collection_set_id必须具有值。

[ @name = ] N'name'

收集组的名称。 @name为 sysname，默认值为 NULL. 如果@collection_set_idNULL，@name必须具有值。

[ @stop_collection_job = ] stop_collection_job

指定在集合集运行时应停止集合的收集作业。 @stop_collection_job 为 位，默认值为 1.

@stop_collection_job仅适用于收集模式设置为缓存的集合集。 有关详细信息，请参阅sp_syscollector_create_collection_set（Transact-SQL）。

返回代码值

0（成功）或 1（失败）。

注解

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

权限

要求dc_operator（具有 EXECUTE 权限）固定数据库角色的成员身份才能执行此过程。

示例

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

USE msdb;
GO
EXEC sp_syscollector_stop_collection_set
    @collection_set_id = 1;

相关内容