Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 2.46 KB

sp-syscollector-upload-collection-set-transact-sql.md

File metadata and controls

77 lines (54 loc) · 2.46 KB
title description author ms.author ms.reviewer ms.date ms.service ms.subservice ms.topic f1_keywords helpviewer_keywords dev_langs
sp_syscollector_upload_collection_set (Transact-SQL)
Starts an upload of collection set data if the collection set is enabled.
markingmyname
maghan
randolphwest
07/04/2023
sql
system-objects
reference
sp_syscollector_upload_collection_set
sp_syscollector_upload_collection_set_TSQL
sp_syscollector_upload_collection_set
data collector [SQL Server], stored procedures
TSQL

sp_syscollector_upload_collection_set (Transact-SQL)

[!INCLUDE SQL Server]

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.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

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

Arguments

[ @collection_set_id = ] collection_set_id

The unique local identifier for the collection set. @collection_set_id is int, and must have a value if @name is NULL.

[ @name = ] N'name'

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 can't 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.

Examples

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';

Related content