sp_syscollector_stop_collection_set (Transact-SQL)
適用於:SQL Server
停止收集組。
語法
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_id 為 NULL
,@name就必須有值。
[ @stop_collection_job = ] stop_collection_job
指定當收集組正在執行時,應該停止收集組的收集作業。 @stop_collection_job為位,預設值為 1
。
@stop_collection_job僅適用於收集模式設定為快取的收集組。 如需詳細資訊,請參閱 sp_syscollector_create_collection_set。
傳回碼值
0
(成功) 或 1
(失敗)。
備註
sp_syscollector_create_collection_set
必須在系統資料庫的內容 msdb
中執行。
權限
需要dc_operator的成員資格(具有 EXECUTE 許可權)固定資料庫角色才能執行此程式。
範例
下列範例會使用其標識碼停止收集組。
USE msdb;
GO
EXEC sp_syscollector_stop_collection_set
@collection_set_id = 1;