title | description | author | ms.author | ms.reviewer | ms.date | ms.service | ms.subservice | ms.topic | f1_keywords | helpviewer_keywords | dev_langs | |||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sp_syscollector_run_collection_set (Transact-SQL) |
Starts a collection set if the collector is already enabled, and the collection set is configured for non-cached collection mode. |
markingmyname |
maghan |
randolphwest |
07/04/2023 |
sql |
system-objects |
reference |
|
|
|
[!INCLUDE SQL Server]
Starts a collection set if the collector is already enabled, and the collection set is configured for non-cached collection mode.
Note
This procedure fails if it is run against a collection set that is configured for cached collection mode.
sp_syscollector_run_collection_set
enables a user to take on-demand data snapshots.
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions
sp_syscollector_run_collection_set
[ [ @collection_set_id = ] collection_set_id ]
[ , [ @name = ] N'name' ]
[ ; ]
The unique local identifier for the collection set. @collection_set_id is int, with a default of NULL
, and must have a value if @name is NULL
.
The name of the collection set. @name is sysname, with a default of NULL
, and must have a value if @collection_set_id is NULL
.
0
(success) or 1
(failure).
Either @collection_set_id or @name must have a value, both can't be NULL
.
This procedure starts the collection and upload jobs for the specified collection set, and immediately starts the collection agent job if the collection set has its @collection_mode set to non-cached (1
). For more information, see sp_syscollector_create_collection_set (Transact-SQL).
sp_sycollector_run_collection_set
can also be used to run a collection set that doesn't have a schedule.
Requires membership in the dc_operator (with EXECUTE permission) fixed database role to execute this procedure.
Start a collection set using its identifier.
USE msdb;
GO
EXEC sp_syscollector_run_collection_set
@collection_set_id = 1;