sp_syscollector_run_collection_set (Transact-SQL)

适用于SQL Server

如果收集器已启用,并且为非缓存的收集模式配置了收集集,则启动收集集。

注意

如果针对为缓存的收集模式配置的收集集运行此过程,此过程将失败。

sp_syscollector_run_collection_set 使用户能够拍摄按需数据快照。

Transact-SQL 语法约定

语法

sp_syscollector_run_collection_set
    [ [ @collection_set_id = ] collection_set_id ]
    [ , [ @name = ] N'name' ]
[ ; ]

参数

[ @collection_set_id = ] collection_set_id

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

[ @name = ] N'name'

收集组的名称。 @name是 sysname,默认值NULL为 ,并且如果@collection_set_idNULL值,则必须具有值。

返回代码值

0(成功)或 1(失败)。

注解

@collection_set_id@name必须有一个值,两者都NULL不能。

此过程启动指定集合集的集合并上传作业,如果集合集的 @collection_mode 设置为非缓存(1),则立即启动收集代理作业。 有关详细信息,请参阅sp_syscollector_create_collection_set(Transact-SQL)。

sp_sycollector_run_collection_set 还可用于运行没有计划的收集集。

权限

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

示例

使用收集组的标识符启动收集组。

USE msdb;
GO
EXEC sp_syscollector_run_collection_set
    @collection_set_id = 1;