sp_syscollector_run_collection_set (Transact-SQL)
適用対象: SQL Server
コレクターが既に有効になっていて、コレクション セットがキャッシュされていないコレクション モード用に構成されている場合は、コレクション セットを開始します。
Note
キャッシュ コレクション モード用に構成されているコレクション セットに対して実行すると、このプロシージャは失敗します。
sp_syscollector_run_collection_set
を使用すると、ユーザーはオンデマンドのデータ スナップショットを取得できます。
構文
sp_syscollector_run_collection_set
[ [ @collection_set_id = ] collection_set_id ]
[ , [ @name = ] N'name' ]
[ ; ]
引数
[ @collection_set_id = ] collection_set_id
コレクション セットの一意のローカル識別子。 @collection_set_id は int で、既定値は NULL
で、 @name が NULL
場合は値を持つ必要があります。
[ @name = ] N'name'
コレクション セットの名前。 @name は sysname で、既定値は NULL
で、 @collection_set_id が NULL
場合は値を持つ必要があります。
リターン コードの値
0
(成功) または 1
(失敗)。
解説
@collection_set_idまたは@nameには値が必要です。両方をNULL
することはできません。
この手順では、指定したコレクション セットのコレクション ジョブとアップロード ジョブを開始し、コレクション セットの @collection_mode が非キャッシュ (1
) に設定されている場合は、すぐにコレクション エージェント ジョブを開始します。 詳細については、「 sp_syscollector_create_collection_set」を参照してください。
sp_sycollector_run_collection_set
を使用して、スケジュールのないコレクション セットを実行することもできます。
アクセス許可
このプロシージャを実行するには、(EXECUTE 権限を持つ) dc_operator 固定データベース ロールのメンバーシップが必要です。
例
対応する ID を使ってコレクション セットを開始します。
USE msdb;
GO
EXEC sp_syscollector_run_collection_set
@collection_set_id = 1;