sp_addsubscriber (Transact-SQL)
適用対象: SQL Server Azure SQL データベース
パブリッシャーに新しいサブスクライバーを追加し、サブスクライバーがパブリケーションを受け取れるようにします。 このストアド プロシージャは、パブリッシャー側のパブリケーション データベースでスナップショット パブリケーションとトランザクション パブリケーション用に実行されます。リモート ディストリビューターを使用するマージ パブリケーションの場合、このストアド プロシージャはディストリビューターで実行されます。
重要
このストアド プロシージャは非推奨になりました。 パブリッシャーでサブスクライバーを明示的に登録する必要がなくなりました。
構文
sp_addsubscriber
[ @subscriber = ] N'subscriber'
[ , [ @type = ] type ]
[ , [ @login = ] N'login' ]
[ , [ @password = ] N'password' ]
[ , [ @commit_batch_size = ] commit_batch_size ]
[ , [ @status_batch_size = ] status_batch_size ]
[ , [ @flush_frequency = ] flush_frequency ]
[ , [ @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 ]
[ , [ @description = ] N'description' ]
[ , [ @security_mode = ] security_mode ]
[ , [ @encrypted_password = ] encrypted_password ]
[ , [ @publisher = ] N'publisher' ]
[ ; ]
引数
[ @subscriber = ] N'subscriber'
このサーバー上のパブリケーションに有効なサブスクライバーとして追加するサーバーの名前。 @subscriber は sysname で、既定値はありません。
[ @type = ] type
サブスクライバーの種類。 @type は tinyint であり、これらの値のいずれかを指定できます。
値 | 説明 |
---|---|
0 (既定値) |
SQL Server サブスクライバー |
1 |
ODBC データ ソース サーバー |
2 |
Microsoft Jet データベース |
3 |
OLE DB プロバイダー |
[ @login = ] N'login'
SQL Server 認証のログイン ID。 @login は sysname で、既定値は NULL
です。
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @password = ] N'password'
SQL Server 認証のパスワード。 @password は nvarchar(524) で、既定値は NULL
です。
空白のパスワードを使用しないでください。 強力なパスワードを使用してください。
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @commit_batch_size = ] commit_batch_size
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。
値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @status_batch_size = ] status_batch_size
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。
値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @flush_frequency = ] flush_frequency
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。
値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @frequency_type = ] frequency_type
レプリケーション エージェントをスケジュールする頻度を指定します。 @frequency_type は int であり、これらの値のいずれかを指定できます。
値 | 説明 |
---|---|
1 |
指定日時 |
2 |
オン デマンド |
4 |
毎日 |
8 |
週単位 |
16 |
月単位 |
32 |
月単位の相対 |
64 (既定) |
自動開始 |
128 |
定期的 |
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @frequency_interval = ] frequency_interval
@frequency_typeによって設定された頻度に適用される値。 @frequency_interval は int で、既定値は 1
です。
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @frequency_relative_interval = ] frequency_relative_interval
レプリケーション エージェントの日付。 このパラメーターは、 @frequency_type が 32
(毎月の相対) に設定されている場合に使用されます。 @frequency_relative_interval は int であり、これらの値のいずれかを指定できます。
値 | 説明 |
---|---|
1 (既定値) |
最初 |
2 |
Second |
4 |
Third |
8 |
4 番目 |
16 |
最後 |
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @frequency_recurrence_factor = ] frequency_recurrence_factor
@frequency_typeによって使用される繰り返し係数。 @frequency_recurrence_factor は int で、既定値は 0
です。
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @frequency_subday = ] frequency_subday
定義された期間中にスケジュールを変更する頻度。 @frequency_subday は int であり、これらの値のいずれかを指定できます。
値 | 説明 |
---|---|
1 |
1 回。 |
2 |
Second |
4 (既定) |
分 |
8 |
時間 |
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @frequency_subday_interval = ] frequency_subday_interval
frequency_subdayの間隔。 @frequency_subday_interval は int で、既定値は 5
です。
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @active_start_time_of_day = ] active_start_time_of_day
レプリケーション エージェントが最初にスケジュールされ、 HHmmss
形式の時刻。 @active_start_time_of_day は int で、既定値は 0
です。
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @active_end_time_of_day = ] active_end_time_of_day
レプリケーション エージェントのスケジュールが停止した時刻( HHmmss
形式)。 @active_end_time_of_day は int で、既定値は 235959
です。これは、24 時間制で測定される午後 11 時 59 分 59 分を意味します。
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @active_start_date = ] active_start_date
レプリケーション エージェントが最初にスケジュールされた日付。 yyyyMMdd
形式です。 @active_start_date は int で、既定値は 0
です。
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @active_end_date = ] active_end_date
レプリケーション エージェントのスケジュールが停止した日付( yyyyMMdd
形式)。 @active_end_date は int で、既定値は 99991231
で、9999 年 12 月 31 日を意味します。
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @description = ] N'description'
サブスクライバーのテキストの説明。 @description は nvarchar(255) で、既定値は NULL
です。
[ @security_mode = ] security_mode
実装されたセキュリティ モード。 @security_mode は int で、既定値は 1
です。
0
は SQL Server 認証を指定します。1
はWindows 認証を指定します。
Note
このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。
[ @encrypted_password = ] encrypted_password
このパラメーターは非推奨であり、下位互換性のみを目的として提供されています。 @encrypted_passwordを任意の値に設定しますが、0
するとエラーが発生します。
[ @publisher = ] N'publisher'
SQL Server 以外のパブリッシャーを指定します。 @publisher は sysname で、既定値は NULL
です。
SQL Server パブリッシャーから発行する場合、@publisher は使用しないでください。
リターン コードの値
0
(成功) または 1
(失敗)。
解説
sp_addsubscriber
は、スナップショット レプリケーション、トランザクション レプリケーション、マージ レプリケーションで使用されます。
sp_addsubscriber
は、サブスクライバーがパブリケーションをマージするための匿名サブスクリプションのみを持っている場合は必要ありません。
sp_addsubscriber
は、distribution データベース内のMSsubscriber_info テーブルに書き込みます。
アクセス許可
sysadmin固定サーバー ロールのメンバーのみがsp_addsubscriber
を実行できます。