sp_helppublication_snapshot (Transact-SQL)

適用対象: SQL Server Azure SQL Managed Instance

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

Transact-SQL 構文表記規則

構文

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

引数

[ @publication = ] N'publication'

出版物の名前。 @publicationsysname で、既定値はありません。

[ @publisher = ] N'publisher'

SQL Server 以外のパブリッシャーを指定します。 @publishersysname で、既定値は NULL です。

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

結果セット

列名 データ型 説明
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 つを指定できます。

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_type4 (日単位) のときにエージェントを実行する頻度を定義する型で、これらの値のいずれかを指定できます。

1 = 指定した時刻
2 = 秒
4 = 分
8 = 時間
frequency_subday_interval int エージェントのスケジュールされた実行の間に発生する frequency_subday_type の間隔の数。
frequency_relative_interval int frequency_type32 (月単位の相対値) である場合、エージェントが特定の月に実行される週です。これらの値のいずれかを指定できます。

1 = First
2 = Second
4 = 3 番目
8 = 4 番目
16 = Last
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 は、すべての種類のレプリケーションで使用されます。

アクセス許可

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