sp_help_downloadlist (Transact-SQL)

  • [アーティクル]

sysdownloadlist システム テーブルにある、指定したジョブに関するすべての行が一覧表示されます。ジョブを指定しない場合はテーブルのすべての行が一覧表示されます。

トピック リンク アイコン Transact-SQL 構文表記規則

構文

sp_help_downloadlist { [ @job_id = ] job_id | [ @job_name = ] 'job_name' } 
     [ , [ @operation = ] 'operation' ] 
     [ , [ @object_type = ] 'object_type' ] 
     [ , [ @object_name = ] 'object_name' ] 
     [ , [ @target_server = ] 'target_server' ] 
     [ , [ @has_error = ] has_error ] 
     [ , [ @status = ] status ] 
     [ , [ @date_posted = ] date_posted ]

引数

  • [ @job_id= ] job_id
    情報を返すジョブの識別番号を指定します。 job_id のデータ型は uniqueidentifier で、既定値は NULL です。

  • [ @job_name= ] 'job_name'
    ジョブの名前を指定します。 job_name のデータ型は sysname で、既定値は NULL です。

    注意注

    job_id または job_name のいずれかを指定する必要があります。両方を指定することはできません。

  • [ @operation= ] 'operation'
    指定したジョブに有効な操作を指定します。 operation のデータ型は varchar(64) で、既定値は NULL です。次のいずれかの値を指定できます。

    値

    説明

    DEFECT

    対象サーバーに対し、マスター SQLServerAgent サービスへの参加解除を要求するサーバー操作。

    DELETE

    ジョブ全体を削除するジョブ操作。

    INSERT

    ジョブ全体の追加、または既存のジョブの更新を行うジョブ操作。 場合によっては、この操作にはすべてのジョブ ステップとスケジュールが含まれます。

    RE-ENLIST

    対象サーバーで参加情報の再送信を行うためのサーバー操作。この情報にはマルチサーバー ドメインの呼び出し間隔やタイム ゾーンも含まれます。 対象サーバーでは MSXOperator の詳細の再ダウンロードも行われます。

    SET-POLL

    対象サーバーがマルチサーバー ドメインを呼び出す間隔を秒単位で設定するサーバー操作。 この値を指定した場合、value は必要な間隔として解釈されます。10 ～ 28,800 の値を指定できます。

    START

    ジョブ実行の開始を要求するジョブ操作。

    STOP

    ジョブ実行の停止を要求するジョブ操作。

    SYNC-TIME

    対象サーバーでシステム クロックとマルチサーバー ドメインとの同期化を行うためのサーバー操作。 これは非常に時間のかかる操作なので、頻繁に実行しないでください。限られた場合にだけ、実行するようにしてください。

    UPDATE

    ジョブ ステップやスケジュールではなく、ジョブの sysjobs 情報だけを更新するジョブ操作。 これは、sp_update_job により自動的に呼び出されます。

  • [ @object_type= ] 'object_type'
    指定したジョブのオブジェクトの種類を指定します。 object_type のデータ型は varchar(64) で、既定値は NULL です。 object_type の値は JOB または SERVER です。 有効な object_type値の詳細については、「sp_add_category (Transact-SQL)」を参照してください。

  • [ @object_name= ] 'object_name'
    オブジェクト名です。 object_name のデータ型は sysname で、既定値は NULL です。 object_type が JOB の場合、object_name はジョブ名になります。 object_type が SERVER の場合、object_name はサーバー名になります。

  • [ @target_server= ] 'target_server'
    対象サーバーの名前です。 target_server のデータ型は nvarchar(128) で、既定値は NULL です。

  • [ @has_error= ] has_error
    ジョブでエラーを肯定するかどうかを指定します。 has_error のデータ型は tinyint で、既定値は NULL です。これはエラーを肯定しないことを示します。 1 は、すべてのエラーを肯定することを示します。

  • [ @status= ] status
    ジョブの状態を指定します。 status のデータ型は tinyint で、既定値は NULL です。

  • [ @date_posted= ] date_posted
    結果セットに含めるエントリの日付と時刻を指定します。指定した日付と時刻以降に作成されたエントリが結果セットに含まれます。 date_posted のデータ型は datetime で、既定値は NULL です。

戻り値

0 (成功) または 1 (失敗)

結果セット

列名

データ型

説明

instance_id

int

命令の一意な整数識別番号。

source_server

nvarchar(30)

命令を実行したサーバーのコンピューター名。 Microsoft SQL Server Version 7.0 では、これは常にマスター (MSX) サーバーのコンピューター名です。

operation_code

nvarchar(4000)

命令の操作コード。

object_name

sysname

命令対象のオブジェクト。

object_id

uniqueidentifier

命令対象のオブジェクトの識別番号 (ジョブ オブジェクトの場合は job_id、サーバー オブジェクトの場合は 0x00)、または、operation_code に固有のデータ値。

target_server

nvarchar(30)

命令をダウンロードする対象サーバー。

error_message

nvarchar(1024)

命令の処理中に問題が発生した場合の、対象サーバーからのエラー メッセージ。

注意注

エラー メッセージが送信されると、対象サーバーではそれ以上ダウンロードが行われません。

date_posted

datetime

命令をテーブルに記録した日付。

date_downloaded

datetime

対象サーバーが命令をダウンロードした日付。

status

tinyint

ジョブのステータス。

0 = 未ダウンロード

1 = ダウンロード済み

権限

このプロシージャの実行権限は、既定では sysadmin 固定サーバー ロールのメンバーに与えられています。

使用例

次の例では、sysdownloadlist 内の NightlyBackups ジョブに関する行を一覧表示します。

USE msdb ;
GO

EXEC dbo.sp_help_downloadlist
    @job_name = N'NightlyBackups',
    @operation = N'UPDATE', 
    @object_type = N'JOB', 
    @object_name = N'NightlyBackups',
    @target_server = N'SEATTLE2', 
    @has_error = 1, 
    @status = NULL, 
    @date_posted = NULL ;
GO

関連項目

参照

システム ストアド プロシージャ (Transact-SQL)