sp_syscollector_upload_collection_set (Transact-SQL)

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

Starts an upload of collection set data if the collection set is enabled.

Important

This stored procedure can only be used for collection sets that are configured for cached mode data collection and upload.

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

Topic link icon Transact-SQL Syntax Conventions

Syntax


sp_syscollector_upload_collection_set [[ @collection_set_id = ] collection_set_id ]  
          , [[ @name = ] 'name' ]   

Arguments

[ @collection_set_id = ] collection_set_id
Is the unique local identifier for the collection set. collection_set_id is int and must have a value if name is NULL.

[ @name = ] 'name'
Is the name of the collection set. name is sysname and must have a value if collection_set_id is NULL.

Return Code Values

0 (success) or 1 (failure)

Remarks

Either collection_set_id or name must have a value; both cannot be NULL.

This procedure can be used for starting an on-demand upload for a running collection set. It can only be used for collection sets that are configured for cached mode data collection and upload. This enables a user to obtain data to analyze without having to wait for a scheduled upload.

Permissions

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

Example

Does an on-demand upload of a collection set named Simple Collection Set.

USE msdb;  
GO  
EXEC sp_syscollector_upload_collection_set @name = 'Simple Collection Set' ;  

See Also

System Stored Procedures (Transact-SQL)
Data Collection