sp_syscollector_stop_collection_set (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Stops a collection set.

||
|-|
|Applies to: SQL Server ( SQL Server 2008 through current version).|

Topic link icon Transact-SQL Syntax Conventions

Syntax


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

Arguments

[ @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).

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_syscollector_create_collection_set must be run in the context of the msdb system database.

Permissions

Requires membership in the dc_operator (with EXECUTE permission) fixed database role to execute this procedure.

Examples

The following example stops a collection set using its identifier.

USE msdb;  
GO  
EXEC sp_syscollector_stop_collection_set @collection_set_id = 1;  

See Also

Data Collection
Data Collector Stored Procedures (Transact-SQL)