sp_changesubscriber (Transact-SQL)

適用対象: SQL Server Azure SQL Managed Instance

サブスクライバーのオプションを変更します。 このパブリッシャーのサブスクライバーに対するディストリビューション タスクはすべて更新されます。 このストアド プロシージャは、ディストリビューション データベースの MSsubscriber_info テーブルに書き込みます。 このストアド プロシージャは、パブリッシャー側のパブリケーション データベースで実行されます。

Transact-SQL 構文表記規則

構文

sp_changesubscriber
    [ @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 ]
    [ , [ @publisher = ] N'publisher' ]
[ ; ]

引数

[ @subscriber = ] N'subscriber'

オプションを変更するサブスクライバーの名前。 @subscribersysname で、既定値はありません。

[ @type = ] type

サブスクライバーの種類。 @typetinyint で、既定値は NULL です。

  • 0 は SQL Server サブスクライバーを示します。
  • 1 は、SQL Server 以外または他の ODBC データ ソース サーバー サブスクライバーを指定します。

[ @login = ] N'login'

SQL Server 認証ログイン ID。 @loginsysname で、既定値は NULL です。

[ @password = ] N'password'

SQL Server 認証パスワード。 @passwordsysname で、既定値は % で、パスワード プロパティに変更がないことを示します。

[ @commit_batch_size = ] commit_batch_size

このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。

[ @status_batch_size = ] status_batch_size

このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。

[ @flush_frequency = ] flush_frequency

このパラメーターは非推奨であり、スクリプトの下位互換性のために保持されます。

[ @frequency_type = ] frequency_type

配布タスクをスケジュールする頻度を指定します。 @frequency_typeint であり、これらの値のいずれかを指定できます。

Value 説明
1 指定日時
2 オン デマンド
4 毎日
8 週単位
16 月単位
32 月単位の相対
64 自動開始
128 定期的

[ @frequency_interval = ] frequency_interval

@frequency_typeの間隔。 @frequency_intervalint で、既定値は NULL です。

[ @frequency_relative_interval = ] frequency_relative_interval

配布タスクの日付。 このパラメーターは、 @frequency_type32 (毎月の相対) に設定されている場合に使用されます。 @frequency_relative_intervalint であり、これらの値のいずれかを指定できます。

Value 説明
1 最初
2 Second
4 Third
8 4 番目
16 最後

[ @frequency_recurrence_factor = ] frequency_recurrence_factor

定義された @frequency_type中に配布タスクを繰り返す頻度を指定します。 @frequency_recurrence_factorint で、既定値は NULL です。

[ @frequency_subday = ] frequency_subday

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

Value 説明
1 1 回。
2 Second
4
8 時間

[ @frequency_subday_interval = ] frequency_subday_interval

@frequence_subdayの間隔。 @frequency_subday_intervalint で、既定値は NULL です。

[ @active_start_time_of_day = ] active_start_time_of_day

配布タスクが最初にスケジュールされ、 HHmmss形式の時刻。 @active_start_time_of_dayint で、既定値は NULL です。

[ @active_end_time_of_day = ] active_end_time_of_day

配布タスクのスケジュールが停止した時刻( HHmmss形式)。 @active_end_time_of_dayint で、既定値は NULL です。

[ @active_start_date = ] active_start_date

配布タスクが最初にスケジュールされた日付で、 yyyyMMddとして書式設定されます。 @active_start_dateint で、既定値は NULL です。

[ @active_end_date = ] active_end_date

配布タスクのスケジュールが停止した日付。 yyyyMMdd形式。 @active_end_dateint で、既定値は NULL です。

[ @description = ] N'description'

オプションの説明テキスト。 @descriptionnvarchar(255) で、既定値は NULL です。

[ @security_mode = ] security_mode

実装されたセキュリティ モード。 @security_modeint であり、これらの値のいずれかを指定できます。

Value 説明
0 SQL Server 認証
1 Windows 認証

[ @publisher = ] N'publisher'

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

SQL Server パブリッシャーでアーティクルのプロパティを変更する場合は、@publisher を使用しないでください。

リターン コードの値

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

解説

sp_changesubscriber は、すべての種類のレプリケーションで使用されます。

アクセス許可

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