sp_addpullsubscription_agent (Transact-SQL)
適用対象: 
SQL ServerAzure SQL Managed Instance
トランザクション パブリケーションに対するプル サブスクリプションの同期で使用される、スケジュールされたエージェント ジョブを追加します。 このストアド プロシージャは、サブスクリプション データベースのサブスクライバーで実行されます。
構文
sp_addpullsubscription_agent
[ @publisher = ] N'publisher'
[ , [ @publisher_db = ] N'publisher_db' ]
, [ @publication = ] N'publication'
[ , [ @subscriber = ] N'subscriber' ]
[ , [ @subscriber_db = ] N'subscriber_db' ]
[ , [ @subscriber_security_mode = ] subscriber_security_mode ]
[ , [ @subscriber_login = ] N'subscriber_login' ]
[ , [ @subscriber_password = ] N'subscriber_password' ]
[ , [ @distributor = ] N'distributor' ]
[ , [ @distribution_db = ] N'distribution_db' ]
[ , [ @distributor_security_mode = ] distributor_security_mode ]
[ , [ @distributor_login = ] N'distributor_login' ]
[ , [ @distributor_password = ] N'distributor_password' ]
[ , [ @optional_command_line = ] N'optional_command_line' ]
[ , [ @frequency_type = ] frequency_type ]
[ , [ @frequency_interval = ] frequency_interval ]
[ , [ @frequency_relative_interval = ] frequency_relative_interval ]
[ , [ @frequency_recurrence_factor = ] frequency_recurrence_factor ]
[ , [ @frequency_subday = ] frequency_subday ]
[ , [ @frequency_subday_interval = ] frequency_subday_interval ]
[ , [ @active_start_time_of_day = ] active_start_time_of_day ]
[ , [ @active_end_time_of_day = ] active_end_time_of_day ]
[ , [ @active_start_date = ] active_start_date ]
[ , [ @active_end_date = ] active_end_date ]
[ , [ @distribution_jobid = ] distribution_jobid OUTPUT ]
[ , [ @encrypted_distributor_password = ] encrypted_distributor_password ]
[ , [ @enabled_for_syncmgr = ] N'enabled_for_syncmgr' ]
[ , [ @ftp_address = ] N'ftp_address' ]
[ , [ @ftp_port = ] ftp_port ]
[ , [ @ftp_login = ] N'ftp_login' ]
[ , [ @ftp_password = ] N'ftp_password' ]
[ , [ @alt_snapshot_folder = ] N'alt_snapshot_folder' ]
[ , [ @working_directory = ] N'working_directory' ]
[ , [ @use_ftp = ] N'use_ftp' ]
[ , [ @publication_type = ] publication_type ]
[ , [ @dts_package_name = ] N'dts_package_name' ]
[ , [ @dts_package_password = ] N'dts_package_password' ]
[ , [ @dts_package_location = ] N'dts_package_location' ]
[ , [ @reserved = ] N'reserved' ]
[ , [ @offloadagent = ] N'offloadagent' ]
[ , [ @offloadserver = ] N'offloadserver' ]
[ , [ @job_name = ] N'job_name' ]
[ , [ @job_login = ] N'job_login' ]
[ , [ @job_password = ] N'job_password' ]
[ ; ]
引数
[ @publisher = ] N'publisher'
パブリッシャーの名前。 @publisherは sysname で、既定値はありません。
Note
サーバー名は次のように <Hostname>,<PortNumber>指定できます。 SQL Server がカスタム ポートを使用して Linux または Windows にデプロイされ、ブラウザー サービスが無効になっている場合に、接続のポート番号を指定します。 リモート ディストリビューターのカスタム ポート番号の使用は、SQL Server 2019 (15.x) 以降のバージョンに適用されます。
[ @publisher_db = ] N'publisher_db'
パブリッシャー データベースの名前。 @publisher_dbは sysname で、既定値は NULL. @publisher_dbは Oracle パブリッシャーによって無視されます。
[ @publication = ] N'publication'
出版物の名前。 @publicationは sysname で、既定値はありません。
[ @subscriber = ] N'subscriber'
サブスクライバー データベースが可用性グループ内にある場合は、サブスクライバー インスタンスの名前または AG リスナーの名前。
@subscriberは sysname で、既定値は NULL.
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のためにメイン含まれています。
AG の一部であるサブスクライバーに対して実行sp_addpullsubscription_agentする場合は、@subscriberを AG リスナー名に設定します。 SQL Server 2016 (13.x) 以前のバージョンまたは CU 16 より前の SQL Server 2017 (14.x) を実行した場合、ストアド プロシージャはエラーを返さずに実行されますが、レプリケーション ディストリビューション エージェントの @subscriber パラメーターは AG リスナー名を参照しません。パラメーターは、コマンドが実行されるサブスクライバー サーバー名で作成されます。 この問題を修正するには、ディストリビューション エージェント job@subscriber パラメーターを AG リスナー名の値で手動で更新します。
[ @subscriber_db = ] N'subscriber_db'
サブスクリプション データベースの名前。 @subscriber_dbは sysname で、既定値は NULL.
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のためにメイン含まれています。
[ @subscriber_security_mode = ] subscriber_security_mode
同期時にサブスクライバーに接続するときに使用するセキュリティ モード。 @subscriber_security_modeは int で、既定値は NULL.
0は SQL Server 認証を指定します1Windows 認証を指定します
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のためにメイン含まれています。 ディストリビューション エージェントは、常に Windows 認証を使用してローカル サブスクライバーに接続します。 このパラメーター以外 NULL の値が 1 指定されている場合は、警告メッセージが返されます。
[ @subscriber_login = ] N'subscriber_login'
同期時にサブスクライバーに接続するときに使用するサブスクライバー ログイン。 @subscriber_loginは sysname で、既定値は NULL.
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のためにメイン含まれています。 このパラメーターに値を指定すると、警告メッセージが返されますが、値は無視されます。
[ @subscriber_password = ] N'subscriber_password'
サブスクライバーのパスワード。 subscriber_security_modeが % に設定0されている場合は、subscriber_passwordが必要です。 @subscriber_passwordは sysname で、既定値は NULL. サブスクライバー パスワードが使用されている場合は、自動的に暗号化されます。
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のためにメイン含まれています。 このパラメーターに値を指定すると、警告メッセージが返されますが、値は無視されます。
[ @distributor = ] N'distributor'
ディストリビューターの名前。 @distributorは sysname であり、既定値は @publisher で指定された値です。
[ @distribution_db = ] N'distribution_db'
ディストリビューション データベースの名前。 @distribution_dbは sysname で、既定値は NULL.
[ @distributor_security_mode = ] distributor_security_mode
Note
Microsoft Entra ID は、以前は Azure Active Directory (Azure AD) と呼ばれていました。
同期時にディストリビューターに接続するときに使用するセキュリティ モード。 @distributor_security_modeは int で、既定値は 1. 次の値は、セキュリティ モードを定義します。
0は SQL Server 認証を指定します。1はWindows 認証を指定します。2は、SQL Server 2022 (16.x) CU 6 以降の Microsoft Entra パスワード認証を指定します。3は、SQL Server 2022 (16.x) CU 6 以降の Microsoft Entra 統合認証を指定します。4は、SQL Server 2022 (16.x) CU 6 以降の Microsoft Entra トークン認証を指定します。
重要
可能な場合は、Windows 認証を使用します。
[ @distributor_login = ] N'distributor_login'
同期時にディストリビューターに接続するときに使用するディストリビューター ログイン。 @distributor_loginは sysname で、既定値は NULL. @distributor_security_modeが に0設定されている場合は、@distributor_loginが必要です。
[ @distributor_password = ] N'distributor_password'
ディストリビューターのパスワード。 distributor_security_modeが に0設定されている場合は、distributor_passwordが必要です。 @distributor_passwordは sysname で、既定値は NULL.
重要
空白のパスワードは使用しないでください。 強力なパスワードを使用してください。 可能であれば、実行時、ユーザーに対してセキュリティ資格情報の入力を要求します。 スクリプト ファイルに資格情報を格納する必要がある場合は、不正アクセスを防ぐために、ファイルを保護します。
[ @optional_command_line = ] N'optional_command_line'
ディストリビューション エージェントに提供される省略可能なコマンド プロンプト。 たとえば、-DefinitionFile C:\Distdef.txt または -CommitBatchSize 10 です。 @optional_command_lineは nvarchar(4000) で、既定値は空の文字列です。
[ @frequency_type = ] frequency_type
ディストリビューション エージェントをスケジュールする頻度。 @frequency_typeは int であり、次のいずれかの値を指定できます。
| Value | 説明 |
|---|---|
1 |
指定日時 |
2 (既定値) |
オンデマンド |
4 |
毎日 |
8 |
週単位 |
16 |
月単位 |
32 |
月単位の相対 |
64 |
Autostart |
128 |
定期的 |
Note
値64を指定すると、ディストリビューション エージェントが連続モードで実行されます。 これは、エージェントのパラメーターの -Continuous 設定に対応します。 詳細については、「 Replication Distribution Agent」を参照してください。
[ @frequency_interval = ] frequency_interval
@frequency_typeによって設定された頻度に適用する値。 @frequency_intervalは int で、既定値は 1.
[ @frequency_relative_interval = ] frequency_relative_interval
ディストリビューション エージェントの日付。 このパラメーターは、@frequency_typeが (月単位の相対) に設定されている場合に32使用されます。 @frequency_relative_intervalは int であり、次のいずれかの値を指定できます。
| Value | 説明 |
|---|---|
1 (既定値) |
最初 |
2 |
Second |
4 |
Third |
8 |
4 番目 |
16 |
Last (最後へ) |
[ @frequency_recurrence_factor = ] frequency_recurrence_factor
@frequency_typeによって使用される 繰り返し係数。 @frequency_recurrence_factorは int で、既定値は 1.
[ @frequency_subday = ] frequency_subday
定義された期間中にスケジュールを変更する頻度を指定します。 @frequency_subdayは int であり、次のいずれかの値を指定できます。
| Value | 説明 |
|---|---|
1 (既定値) |
1 回。 |
2 |
Second |
4 |
分 |
8 |
時間 |
[ @frequency_subday_interval = ] frequency_subday_interval
@frequency_subdayの間隔。 @frequency_subday_intervalは int で、既定値は 1.
[ @active_start_time_of_day = ] active_start_time_of_day
ディストリビューション エージェントが最初にスケジュールされる時刻。次のようにHHmmss書式設定されます。 @active_start_time_of_dayは int で、既定値は 0.
[ @active_end_time_of_day = ] active_end_time_of_day
ディストリビューション エージェントのスケジュールが終了した時刻。次のようにHHmmss書式設定されます。 @active_end_time_of_dayは int で、既定値は 0.
[ @active_start_date = ] active_start_date
ディストリビューション エージェントが最初にスケジュールされた日付。形式yyyyMMddは .. @active_start_dateは int で、既定値は 0.
[ @active_end_date = ] active_end_date
ディストリビューション エージェントのスケジュールが終了した日付。次のようにyyyyMMdd書式設定されます。 @active_end_dateは int で、既定値は 0.
[ @distribution_jobid = ] distribution_jobid OUTPUT
このジョブのディストリビューション エージェントの ID。 @distribution_jobid は binary(16) 型の OUTPUT パラメーターで、既定値は NULL.
[ @encrypted_distributor_password = ] encrypted_distributor_password
@encrypted_distributor_passwordはビットで、既定値は 0.
Note
@encrypted_distributor_passwordの設定はサポートされなくなりました。 この ビット パラメーター 1 を設定しようとすると、エラーが発生します。
[ @enabled_for_syncmgr = ] N'enabled_for_syncmgr'
Microsoft Synchronization Manager を使用してサブスクリプションを同期できるかどうかを指定します。 @enabled_for_syncmgrは nvarchar(5) で、既定値は false.
- サブスクリプションが同期マネージャーに登録されていない場合
false。 - の場合
true、サブスクリプションは同期マネージャーに登録され、SQL Server Management Studio を起動せずに同期できます。
[ @ftp_address = ] N'ftp_address'
このパラメーターは非推奨であり、スクリプトの下位互換性のためにメイン含まれています。
[ @ftp_port = ] ftp_port
このパラメーターは非推奨であり、スクリプトの下位互換性のためにメイン含まれています。
[ @ftp_login = ] N'ftp_login'
このパラメーターは非推奨であり、スクリプトの下位互換性のためにメイン含まれています。
[ @ftp_password = ] N'ftp_password'
このパラメーターは非推奨であり、スクリプトの下位互換性のためにメイン含まれています。
[ @alt_snapshot_folder = ] N'alt_スナップショット_folder'
スナップショットの代替フォルダーの場所を指定します。 @alt_スナップショット_folderは nvarchar(255) で、既定値は NULL.
[ @working_directory = ] N'working_directory'
パブリケーションのデータ ファイルとスキーマ ファイルを格納するために使用される作業ディレクトリの名前。 @working_directoryは nvarchar(255) で、既定値は NULL. 名前は UNC 形式で指定する必要があります。
[ @use_ftp = ] N'use_ftp'
通常のプロトコルの代わりに FTP を使用してスナップショットを取得することを指定します。 @use_ftpは nvarchar(5) で、既定値は false.
[ @publication_type = ] publication_type
パブリケーションのレプリケーションの種類を指定します。 @publication_typeは tinyint で、既定値は 0.
- パブリケーションがトランザクションの種類の場合
0。 - パブリケーションがスナップショット型の場合
1。 - パブリケーションがマージ型の場合
2。
[ @dts_package_name = ] N'dts_package_name'
DTS パッケージの名前を指定します。 @dts_package_nameは sysname で、既定値は NULL. たとえば、DTSPub_Package というパッケージを指定するには、パラメーターを @dts_package_name = N'DTSPub_Package' と設定します。
[ @dts_package_password = ] N'dts_package_password'
パッケージにパスワードがある場合は、そのパスワードを指定します。 @dts_package_passwordは sysname で、既定値はNULLパッケージにパスワードが含まれていないことを意味します。
Note
@dts_package_nameが指定されている場合は、パスワードを指定する必要があります。
[ @dts_package_location = ] N'dts_package_location'
パッケージの場所を指定します。 @dts_package_locationは nvarchar(12) で、既定値は subscriber. パッケージの場所は、次subscriberのいずれかになりますdistributor。
[ @reserved = ] N'reserved'
単に情報を示すためだけに特定されます。 サポートされていません。 将来の互換性は保証されません。
[ @offloadagent = ] N'offloadagent'
このパラメーターは非推奨であり、スクリプトの下位互換性のためにメイン含まれています。 このパラメーターに値を指定すると、警告メッセージが返されますが、値は無視されます。 @offloadagentを値以外falseに設定すると、エラーが発生します。
[ @offloadserver = ] N'offloadserver'
このパラメーターは非推奨であり、スクリプトの下位互換性のためにメイン含まれています。 このパラメーターに値を指定すると、警告メッセージが返されますが、値は無視されます。 @offloadserverを値以外falseに設定すると、エラーが発生します。
[ @job_name = ] N'job_name'
既存のエージェント ジョブの名前。 @job_nameは sysname で、既定値は NULL. このパラメーターは、新しく作成されたジョブ (既定値) ではなく、既存のジョブを使用してサブスクリプションが同期されている場合にのみ指定されます。 sysadmin 固定サーバー ロールのメンバーでない場合は、@job_nameを指定するときに@job_loginと@job_passwordを指定する必要があります。
[ @job_login = ] N'job_login'
エージェントが実行される Windows アカウントのログイン。 @job_loginは nvarchar(257)で、既定値はありません。 この Windows アカウントはサブスクライバーへのエージェント接続で常に使用されます。
[ @job_password = ] N'job_password'
エージェントが実行される Windows アカウントのパスワード。 @job_passwordは sysname で、既定値はありません。
重要
空白のパスワードは使用しないでください。 強力なパスワードを使用してください。 可能であれば、実行時、ユーザーに対してセキュリティ資格情報の入力を要求します。 スクリプト ファイルに資格情報を格納する必要がある場合は、不正アクセスを防ぐために、ファイルを保護します。
リターン コードの値
0 (成功) または 1 (失敗)。
解説
sp_addpullsubscription_agentは、スナップショット レプリケーションとトランザクション レプリケーションで使用されます。
例
-- This script uses sqlcmd scripting variables. They are in the form
-- $(MyVariable). For information about how to use scripting variables
-- on the command line and in SQL Server Management Studio, see the
-- "Executing Replication Scripts" section in the topic
-- "Programming Replication Using System Stored Procedures".
-- Execute this batch at the Subscriber.
DECLARE @publication AS sysname;
DECLARE @publisher AS sysname;
DECLARE @publicationDB AS sysname;
SET @publication = N'AdvWorksProductTran';
SET @publisher = $(PubServer);
SET @publicationDB = N'AdventureWorks2022';
-- At the subscription database, create a pull subscription
-- to a transactional publication.
USE [AdventureWorks2022Replica]
EXEC sp_addpullsubscription
@publisher = @publisher,
@publication = @publication,
@publisher_db = @publicationDB;
-- Add an agent job to synchronize the pull subscription.
EXEC sp_addpullsubscription_agent
@publisher = @publisher,
@publisher_db = @publicationDB,
@publication = @publication,
@distributor = @publisher,
@job_login = $(Login),
@job_password = $(Password);
GO
アクセス許可
sysadmin 固定サーバー ロールまたは固定データベース ロールdb_ownerメンバーのみが実行sp_addpullsubscription_agentできます。
関連するコンテンツ
フィードバック
近日公開予定: 2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub イシューを段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、以下を参照してください: https://aka.ms/ContentUserFeedback。
フィードバックの送信と表示