| title | sp_syscollector_stop_collection_set (Transact-SQL) | Microsoft Docs | ||
|---|---|---|---|
| ms.custom | |||
| ms.date | 03/14/2017 | ||
| ms.prod | sql-non-specified | ||
| ms.reviewer | |||
| ms.suite | |||
| ms.technology |
|
||
| ms.tgt_pltfrm | |||
| ms.topic | language-reference | ||
| f1_keywords |
|
||
| dev_langs |
|
||
| helpviewer_keywords |
|
||
| ms.assetid | 4668cfb7-462f-40d0-948c-8f740a792a4d | ||
| caps.latest.revision | 16 | ||
| author | JennieHubbard | ||
| ms.author | jhubbard | ||
| manager | jhubbard |
[!INCLUDEtsql-appliesto-ss2008-xxxx-xxxx-xxx_md]
Stops a collection set.
| Applies to: [!INCLUDEssNoVersion] ([!INCLUDEssKatmai] through current version). |
Transact-SQL Syntax Conventions
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
Is the unique local identifier for the collection set. collection_set_id is int with a default value of NULL. collection_set_id must have a value if name is NULL.
[ @name = ] 'name'
Is the name of the collection set. name is sysname with a default value of NULL. name must have a value if collection_set_id is NULL.
[ @stop_collection_job = ] stop_collection_job
Specifies that the collection job for the collection set be stopped if it is running. stop_collection_job is bit with a default of 1.
stop_collection_job applies only to collection sets with collection mode set to cached. For more information, see sp_syscollector_create_collection_set (Transact-SQL).
0 (success) or 1 (failure)
sp_syscollector_create_collection_set must be run in the context of the msdb system database.
Requires membership in the dc_operator (with EXECUTE permission) fixed database role to execute this procedure.
The following example stops a collection set using its identifier.
USE msdb;
GO
EXEC sp_syscollector_stop_collection_set @collection_set_id = 1;
Data Collection
Data Collector Stored Procedures (Transact-SQL)