sp_helpdynamicsnapshot_job (Transact-SQL)

フィルタ処理されたデータ スナップショットを生成するエージェント ジョブに関する情報を返します。このストアド プロシージャは、パブリッシャ側でパブリケーション データベースについて実行されます。

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

構文

sp_helpdynamicsnapshot_job [ [ @publication = ] 'publication' ] 
    [ , [ @dynamic_snapshot_jobname = ] 'dynamic_snapshot_jobname' ]
    [ , [ @dynamic_snapshot_jobid = ] 'dynamic_snapshot_jobid' ]

引数

  • [ @publication = ] 'publication'
    パブリケーションの名前を指定します。publication のデータ型は sysname で、既定値は % です。既定値の場合はすべてのパブリケーションが対象となり、指定した dynamic_snapshot_jobid と dynamic_snapshot_jobname に一致する、フィルタ選択されたすべてのデータ スナップショット ジョブに関する情報が返されます。

  • [ @dynamic_snapshot_jobname = ] 'dynamic_snapshot_jobname'
    フィルタ選択されたデータ スナップショット ジョブの名前を指定します。dynamic_snapshot_jobname のデータ型は sysname で、既定値は %' です。既定値の場合は、指定した dynamic_snapshot_jobid のパブリケーションに対するすべての動的ジョブが返されます。ジョブの作成時にジョブ名が明示的に指定されなかった場合、ジョブ名は次の形式になります。

    'dyn_' + <name of the standard snapshot job> + <GUID>
    
  • [ @dynamic_snapshot_jobid = ] 'dynamic_snapshot_jobid'
    フィルタ選択されたデータ スナップショット ジョブの識別子を指定します。dynamic_snapshot_jobid のデータ型は uniqueidentifier で、既定値は NULL です。既定値の場合は、指定した dynamic_snapshot_jobname に一致するすべてのスナップショット ジョブが返されます。

結果セット

列名

データ型

説明

id

int

フィルタ処理されたデータ スナップショット ジョブの識別子。

job_name

sysname

フィルタ処理されたスナップショット ジョブの名前。

job_id

uniqueidentifier

ディストリビュータ側の MicrosoftSQL Server エージェント ジョブの識別子。

dynamic_filter_login

sysname

パブリケーション用に定義されているパラメータ化された行フィルタで、SUSER_SNAME 関数を評価するために使用される値。

dynamic_filter_hostname

sysname

パブリケーション用に定義されているパラメータ化された行フィルタで、HOST_NAME 関数を評価するために使用される値。

dynamic_snapshot_location

nvarchar(255)

パラメータ化された行フィルタを使用する場合、スナップショット ファイルの読み取り元フォルダへのパス。

frequency_type

int

エージェントの予定実行頻度。次のいずれかの値になります。

1 = 1 回

2 = 要求時

4 = 毎日

8 = 毎週

16 = 毎月

32 = 月単位

64 = 自動開始

128 = 定期的

frequency_interval

int

エージェントの実行日。次のいずれかの値になります。

1 = 日曜日

2 = 月曜日

3 = 火曜日

4 = 水曜日

5 = 木曜日

6 = 金曜日

7 = 土曜日

8 = 毎日

9 = 平日

10 = 土日

frequency_subday_type

int

frequency_type が 4 (毎日) の場合に、エージェントの実行頻度を定義する種類。次のいずれかの値をとります。

1 = 指定した時間

2 = 秒

4 = 分

8 = 時間

frequency_subday_interval

int

frequency_subday_type を単位とした、エージェントの予定実行間隔。

frequency_relative_interval

int

frequency_type が 32 (月単位) の場合に、指定された月にエージェントを実行する週。次のいずれかの値をとります。

1 = 第 1 週

2 = 第 2 週

4 = 第 3 週

8 = 第 4 週

16 = 最終週

frequency_recurrence_factor

int

週または月を単位とした、エージェントの予定実行間隔。

active_start_date

int

エージェントの最初の実行予定日。日付の形式は YYYYMMDD です。

active_end_date

int

エージェントの最後の実行予定日。日付の形式は YYYYMMDD です。

active_start_time

int

エージェントの最初の実行予定時刻。時刻の形式は HHMMSS です。

active_end_time

int

エージェントの最後の実行予定時刻。時刻の形式は HHMMSS です。

戻り値

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

説明

sp_helpdynamicsnapshot_job は、マージ レプリケーションで使用します。

すべて既定のパラメータ値を使用する場合は、パブリケーション データベース全体が対象となり、すべてのパーティション データ スナップショット ジョブに関する情報が返されます。

権限

sp_helpdynamicsnapshot_job を実行できるのは、sysadmin 固定サーバー ロール、db_owner 固定データベース ロール、およびパブリケーションのパブリケーション アクセス リストのメンバだけです。