sp_syscollector_run_collection_set (Transact-SQL)
Applies to:
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's 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.
Transact-SQL syntax conventions
Syntax
sp_syscollector_run_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, with a default of NULL
, and must have a value if @name is NULL
.
[ @name = ] N'name'
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
.
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 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.
sp_sycollector_run_collection_set
can also be used to run a collection set that doesn't have a schedule.
Permissions
Requires membership in the dc_operator (with EXECUTE permission) fixed database role to execute this procedure.
Examples
Start a collection set using its identifier.
USE msdb;
GO
EXEC sp_syscollector_run_collection_set
@collection_set_id = 1;