sp_addsubscriber (Transact-SQL)

適用対象:データベースのSQL Server (サポートされているすべてのバージョン) Azure SQL

パブリッシャーに新しいサブスクライバーを追加し、サブスクライバーがパブリケーションを受け取れるようにします。 このストアド プロシージャは、スナップショット パブリケーションとトランザクション パブリケーションのパブリケーション データベースのパブリッシャーで実行されます。リモート ディストリビューターを使用するマージ パブリケーションの場合、このストアド プロシージャはディストリビューターで実行されます。

重要

このストアド プロシージャは非推奨になりました。 パブリッシャーでサブスクライバーを明示的に登録する必要はなくなりました。

Topic link iconTransact-SQL 構文表記規則

構文

  
sp_addsubscriber [ @subscriber = ] 'subscriber'  
    [ , [ @type = ] type ]   
    [ , [ @login = ] 'login' ]  
    [ , [ @password = ] '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 = ] 'description' ]  
    [ , [ @security_mode = ] security_mode ]  
    [ , [ @encrypted_password = ] encrypted_password ]  
    [ , [ @publisher = ] 'publisher' ]  

引数

[ @subscriber = ] 'subscriber' このサーバー上のパブリケーションに有効なサブスクライバーとして追加するサーバーの名前です。 サブスクライバーsysname で、既定値はありません。

[ @type = ] type サブスクライバーの種類です。 tinyint であり、これらの値のいずれかになります。

説明
0 (既定値) Microsoft SQL Server サブスクライバー
1 ODBC データ ソース サーバー
2 Microsoft Jet データベース
3 OLE DB プロバイダー

[ @login = ] 'login'SQL Server認証のログイン ID です。 login のデータ型は sysname で、既定値は NULL です。

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために維持されています。 sp_addsubscriptionの実行時に、サブスクリプションごとに プロパティが指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @password = ] 'password'SQL Server認証のパスワードです。 passwordnvarchar(524)で、既定値は NULL です。

重要

空白のパスワードは使用しないでください。 強力なパスワードを使用してください。

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために維持されています。 sp_addsubscriptionの実行時に、サブスクリプションごとに プロパティが指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @commit_batch_size = ] commit_batch_size このパラメーターは非推奨となり、スクリプトの下位互換性のために維持されています。

Note

値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @status_batch_size = ] status_batch_size このパラメーターは非推奨となり、スクリプトの下位互換性のために維持されています。

Note

値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @flush_frequency = ] flush_frequency このパラメーターは非推奨となり、スクリプトの下位互換性のために維持されています。

Note

値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @frequency_type = ] frequency_type レプリケーション エージェントをスケジュールする頻度を指定します。 frequency_typeint であり、これらの値のいずれかになります。

説明
1 1 回
2 オン デマンド
4 毎日
8 週次
16 月単位
32 月次相対
64 (既定) Autostart
128 繰り返し

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために維持されています。 sp_addsubscriptionの実行時に、サブスクリプションごとに プロパティが指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @frequency_interval = ] frequency_intervalfrequency_typeによって設定された周波数に適用される値です。 frequency_intervalint で、既定値は 1 です。

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために維持されています。 sp_addsubscriptionの実行時に、サブスクリプションごとに プロパティが指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @frequency_relative_interval = ] frequency_relative_interval レプリケーション エージェントの日付です。 このパラメーターは、 frequency_type32 (月単位の相対) に設定されている場合に使用されます。 frequency_relative_intervalint であり、これらの値のいずれかになります。

説明
1 (既定値) First
2 Second
4 Third
8 4 番目
16 末尾

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために維持されています。 sp_addsubscriptionの実行時に、サブスクリプションごとに プロパティが指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @frequency_recurrence_factor = ] frequency_recurrence_factorfrequency_typeで使用される繰り返し係数です。 frequency_recurrence_factorint で、既定値は 0 です

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために保持されています。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @frequency_subday = ] frequency_subday 定義された期間中にスケジュールを変更する頻度を指定します。 frequency_subdayint であり、これらの値のいずれかを指定できます。

説明
1 1 度
2 Second
4 (既定値)
8 時間

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために保持されています。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @frequency_subday_interval = ] frequency_subday_intervalfrequency_subdayの間隔です。 frequency_subday_intervalint で、既定値は 5 です

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために保持されています。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @active_start_time_of_day = ] active_start_time_of_day レプリケーション エージェントが最初にスケジュールされた時刻で、HHMMSS として書式設定されます。 active_start_time_of_dayint で、既定値は 0 です

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために保持されています。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @active_end_time_of_day = ] active_end_time_of_day レプリケーション エージェントのスケジュールが停止した時刻を HHMMSS 形式で指定します。 active_end_time_of_dayint で、既定値は 235959 です。これは、24 時間制で測定された午後 11 時 59 分 59 分を意味します。

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために保持されています。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @active_start_date = ] active_start_date レプリケーション エージェントが最初にスケジュールされた日付を YYYYMMDD として書式設定します。 active_start_dateint で、既定値は 0 です。

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために保持されています。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @active_end_date = ] active_end_date レプリケーション エージェントのスケジュールが停止した日付を YYYYMMDD として書式設定します。 active_end_dateint で、既定値は 99991231 で、9999 年 12 月 31 日を意味します。

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために保持されています。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @description = ] 'description' サブスクライバーのテキストの説明です。 descriptionnvarchar(255)で、既定値は NULL です。

[ @security_mode = ] security_mode 実装されているセキュリティ モードです。 security_modeint で、既定値は 1 です。 0 は認証SQL Server指定します。 1 は Windows 認証を指定します。

Note

このパラメーターは非推奨となり、スクリプトの下位互換性のために保持されています。 このプロパティは、 sp_addsubscriptionの実行時にサブスクリプションごとに指定されるようになりました。 値を指定すると、このサブスクライバーでサブスクリプションを作成するときに既定値として使用され、警告メッセージが返されます。

[ @encrypted_password = ] encrypted_password このパラメーターは非推奨となり、下位互換性のみを目的として提供されています 。encrypted_password を任意の値に設定しますが 、0 の場合はエラーになります。

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

Note

SQL Server パブリッシャーから発行する場合は、パブリッシャーを使用しないでください。

リターン コードの値

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

注釈

sp_addsubscriber は、スナップショット レプリケーション、トランザクション レプリケーション、マージ レプリケーションで使用されます。

サブスクライバー がパブリケーションをマージする匿名サブスクリプションのみを持つ場合、sp_addsubscriberは必要ありません。

sp_addsubscriberディストリビューション データベースのMSsubscriber_info テーブルに書き込みます。

アクセス許可

sp_addsubscriberを実行できるのは、sysadmin 固定サーバー ロールのメンバーだけです。

関連項目

プッシュ サブスクリプションを作成する
Create a Pull Subscription
sp_changesubscriber (Transact-SQL)
sp_dropsubscriber (Transact-SQL)
sp_helpsubscriberinfo (Transact-SQL)