sp_addsubscriber (Transact-SQL)

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

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

Transact-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'
  有効なサブスクライバとして、このサーバーのパブリケーションに追加するサーバーの名前を指定します。subscriber のデータ型は sysname で、既定値はありません。

• [ @type=] type
  サブスクライバの種類を指定します。type のデータ型は tinyint で、次のいずれかの値を指定できます。

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

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

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [ @password=] 'password'
  SQL Server 認証のパスワードを指定します。password のデータ型は nvarchar(524) で、既定値は NULL です。

  セキュリティに関する注意
  パスワードは空白のままにしないでください。また複雑なパスワードを使用してください。

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、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	定期的

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [@frequency_interval= ] frequency_interval
  frequency_type によって設定された頻度に適用される値を指定します。frequency_interval のデータ型は int で、既定値は 1 です。

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [ @frequency_relative_interval=] frequency_relative_interval
  レプリケーション エージェントを実行する日付を指定します。frequency_type を 32 (月単位) に設定したときにこのパラメータを使用します。frequency_relative_interval のデータ型は int で、次のいずれかの値を指定できます。

  値	説明
  1 (既定値)	第 1
  2	第 2
  4	第 3
  8	第 4
  16	最終

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [ @frequency_recurrence_factor=] frequency_recurrence_factor
  frequency_type で使用される定期実行係数を指定します。frequency_recurrence_factor のデータ型は int で、既定値は 0 です。

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [ @frequency_subday=] frequency_subday
  定義した期間にスケジュールを組み直す頻度を指定します。frequency_subday のデータ型は int で、次のいずれかの値を指定できます。

  値	説明
  1	1 回のみ
  2	秒
  4 (既定値)	分
  8	時

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [ @frequency_subday_interval=] frequency_subday_interval
  frequency_subday の間隔を指定します。frequency_subday_interval のデータ型は int で、既定値は 5 です。

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [ @active_start_time_of_day=] active_start_time_of_day
  レプリケーション エージェントを最初にスケジュール設定する時刻を HHMMSS 形式で指定します。active_start_time_of_day のデータ型は int で、既定値は 0 です。

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [ @active_end_time_of_day=] active_end_time_of_day
  レプリケーション エージェントのスケジュール設定を停止する時刻を HHMMSS 形式で指定します。active_end_time_of_day のデータ型は int で、既定値は 235959 です。235959 は、24 時間制の午後 11 時 59 分 59 秒を意味します。

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [ @active_start_date=] active_start_date
  レプリケーション エージェントを最初にスケジュール設定する日付を YYYYMMDD 形式で指定します。active_start_date のデータ型は int で、既定値は 0 です。

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [ @active_end_date=] active_end_date
  レプリケーション エージェントのスケジュール設定を停止する日付を YYYYMMDD 形式で指定します。active_end_date のデータ型は int で、既定値は 9999 年 12 月 31 日です。

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [ @description=] 'description'
  サブスクライバのテキスト形式の説明を指定します。description のデータ型は nvarchar(255) で、既定値は NULL です。

• [ @security_mode=] security_mode
  実装するセキュリティ モードを指定します。security_mode のデータ型は int で、既定値は 1 です。0 は SQL Server 認証を表します。1 は Windows 認証を表します。

  注意
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。現在このプロパティは、sp_addsubscription の実行時にサブスクリプションごとに指定されます。値を指定した場合、その値はサブスクライバでのサブスクリプションの作成時に既定値として使用され、警告メッセージが返されます。

• [ @encrypted_password=] encrypted_password
  このパラメータは、スクリプトの下位互換性を確保するために用意されているものであり、使用は推奨されません。encrypted_password を 0 以外の値に設定すると、エラーが発生します。

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

  注意
  SQL Server パブリッシャからパブリッシュする場合は、publisher は使用しないでください。

戻り値

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

説明

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

サブスクライバにマージ パブリケーションへの匿名サブスクリプションだけが含まれている場合、sp_addsubscriber は必要ありません。

sp_addsubscriber では、distribution データベースの MSsubscriber_info テーブルに書き込みが行われます。

権限

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

関連項目

タスク

プッシュ サブスクリプションを作成する方法 (レプリケーション Transact-SQL プログラミング)

プル サブスクリプションを作成する方法 (レプリケーション Transact-SQL プログラミング)

参照

sp_changesubscriber (Transact-SQL)

sp_dropsubscriber (Transact-SQL)

sp_helpsubscriberinfo (Transact-SQL)