sp_addqreader_agent (Transact-SQL)

適用対象: SQL Server Azure SQL Managed Instance

特定のディストリビューターのキュー リーダー エージェントを追加します。 このストアド プロシージャは、ディストリビューション データベースのディストリビューターまたはパブリケーション データベースのパブリッシャーで実行されます。

Transact-SQL 構文表記規則

構文

sp_addqreader_agent
    [ [ @job_login = ] N'job_login' ]
    [ , [ @job_password = ] N'job_password' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @frompublisher = ] frompublisher ]
[ ; ]

引数

[ @job_login = ] N'job_login'

エージェントが実行される Microsoft Windows アカウントのログイン。 @job_loginnvarchar(257) で、既定値は NULL です。 この Windows アカウントは、ディストリビューターへのエージェント接続に常に使用されます。

[ @job_password = ] N'job_password'

エージェントが実行される Windows アカウントのパスワード。 @job_passwordsysname で、既定値はありません。

重要

認証情報はスクリプト ファイルに格納しないでください。 セキュリティを最大限に高めるには、実行時にログイン名とパスワードを指定する必要があります。

[ @job_name = ] N'job_name'

既存のエージェント ジョブの名前。 @job_namesysname で、既定値は NULL です。 このパラメーターは、新しく作成されたジョブ (既定値) ではなく、既存のジョブを使用してエージェントを作成する場合にのみ指定されます。

[ @frompublisher = ] frompublisher

プロシージャをパブリッシャーで実行するかどうかを指定します。 @frompublisherビットで、既定値は 0 です。

1値は、プロシージャがパブリッシャーからパブリケーション データベース上で実行されていることを意味します。

リターン コードの値

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

解説

sp_addqreader_agent はトランザクション レプリケーションで使用されます。

sp_addqreader_agent は、 sp_adddistributiondb 後、 sp_addpublication前のキュー更新をサポートするディストリビューターで少なくとも 1 回実行する必要があります。

キュー リーダー エージェント ジョブは、 sp_dropdistributiondbの実行時に削除されます。

アクセス許可

sysadmin固定サーバー ロールのメンバーのみがsp_addqreader_agentを実行できます。