sp_helppublication_snapshot (Transact-SQL)

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

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

構文

sp_helppublication_snapshot [ @publication = ] 'publication'
    [ , [ @publisher = ] 'publisher' ]

引数

  • [ @publication = ] 'publication'
    パブリケーションの名前を指定します。publication のデータ型は sysname で、既定値はありません。

  • [ @publisher = ] 'publisher'
    SQL Server 以外のパブリッシャを指定します。publisher のデータ型は sysname で、既定値は NULL です。

    注意注意

    アーティクルを SQL Server パブリッシャに追加するときは、publisher を使用しないでください。

結果セット

列名

データ型

説明

id

int

スナップショット エージェントの ID です。

name

nvarchar(100)

スナップショット エージェント名です。

publisher_security_mode

smallint

パブリッシャに接続するときにエージェントが使用するセキュリティ モードです。次のいずれかの値をとります。

0 = SQL Server 認証

1 = Windows 認証

publisher_login

sysname

パブリッシャに接続するときに使用するログイン名です。

publisher_password

nvarchar(524)

セキュリティ上の理由から、常に ********** という値が返されます。

job_id

uniqueidentifier

エージェント ジョブの一意の ID です。

job_login

nvarchar(512)

スナップショット エージェントが実行する Windows アカウントです。これは、DOMAIN\username 形式で返されます。

job_password

sysname

セキュリティ上の理由から、********** の値が常に返されます。

schedule_name

sysname

このエージェント ジョブに使用されるスケジュールの名前です。

frequency_type

int

スケジュールに組み込まれているエージェントの実行の頻度です。次のいずれかの値をとります。

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_help_publication_snapshot は、すべての種類のレプリケーションで使用します。

権限

sp_help_publication_snapshot を実行できるのは、パブリッシャの固定サーバー ロール sysadmin またはパブリケーション データベースの固定データベース ロール db_owner のメンバだけです。