sp_change_log_shipping_secondary_database (Transact-SQL)

セカンダリ データベースの設定を変更します。

トピック リンク アイコンTransact-SQL 構文表記規則

構文

sp_change_log_shipping_secondary_database
[ @secondary_database = ] 'secondary_database',
[, [ @restore_delay = ] 'restore_delay']
[, [ @restore_all = ] 'restore_all']
[, [ @restore_mode = ] 'restore_mode']
[, [ @disconnect_users = ] 'disconnect_users']
[, [ @block_size = ] 'block_size']
[, [ @buffer_count = ] 'buffer_count']
[, [ @max_transfer_size = ] 'max_transfer_size']
[, [ @restore_threshold = ] 'restore_threshold'] 
[, [ @threshold_alert = ] 'threshold_alert'] 
[, [ @threshold_alert_enabled = ] 'threshold_alert_enabled'] 
[, [ @history_retention_period = ] 'history_retention_period']

引数

  • [ @restore_delay = ] 'restore_delay'
    バックアップ ファイルを復元するまでにセカンダリ サーバーが待機する時間を、分単位で指定します。restore_delay のデータ型は int で、NULL 値は許可されません。既定値は 0 です。

  • [ @restore_all = ] 'restore_all'
    1 に設定すると、セカンダリ サーバーでは復元ジョブの実行時にすべてのトランザクション ログ バックアップが復元されます。1 以外の場合は、1 つのファイルが復元された後セカンダリ サーバーは停止します。restore_all のデータ型は bit で、NULL 値は許可されません。

  • [ @restore_mode = ] 'restore_mode'
    セカンダリ データベースの復元モードを指定します。

    0 = NORECOVERY でログを復元。

    1 = STANDBY でログを復元。

    restore のデータ型は bit で、NULL 値は許可されません。

  • [ @disconnect_users = ] 'disconnect_users'
    1 に設定すると、復元操作の実行時、ユーザーはセカンダリ データベースから切断されます。既定値は 0 です。disconnect_users のデータ型は bit で、NULL 値は許可されません。

  • [ @block_size = ] 'block_size'
    バックアップ デバイスのブロック サイズとして使用するサイズを、バイト単位で指定します。block_size のデータ型は int で、既定値は -1 です。

  • [ @buffer_count = ] 'buffer_count'
    バックアップまたは復元操作で使用するバッファーの総数を指定します。buffer_count のデータ型は int で、既定値は -1 です。

  • [ @max_transfer_size = ] 'max_transfer_size'
    SQL Server からバックアップ デバイスに送信される入力要求または出力要求の最大サイズを、バイト数で指定します。max_transfersize のデータ型は int で、NULL 値は許可されます。

  • [ @restore_threshold = ] 'restore_threshold'
    復元操作の間の許容経過時間を分単位で指定します。この時間を超えると警告が発生します。restore_threshold のデータ型は int で、NULL 値は許可されません。

  • [ @threshold_alert = ] 'threshold_alert'
    バックアップのしきい値を超過したときに生成する警告を指定します。threshold_alert のデータ型は int で、既定値は 14420 です。

  • [ @threshold_alert_enabled = ] 'threshold_alert_enabled'
    backup_threshold を超過したときに警告を生成するかどうかを指定します。1 = 有効、0 = 無効です。threshold_alert_enabled のデータ型は bit で、NULL 値は許可されません。

  • [ @history_retention_period = ] 'history_retention_period'
    履歴を保持する期間を分単位で指定します。history_retention_period のデータ型は int です。何も指定しない場合は、値 1440 が使用されます。

リターン コード値

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

結果セット

なし

説明

sp_change_log_shipping_secondary_database は、セカンダリ サーバーの master データベースから実行する必要があります。このストアド プロシージャでは次の処理が行われます。

  1. 必要に応じて、log_shipping_secondary_database の設定を変更する。

  2. 必要に応じて、指定した引数を使用して、セカンダリ サーバー上の log_shipping_monitor_secondary にあるローカル監視レコードを変更する。

権限

このプロシージャを実行できるのは、sysadmin 固定サーバー ロールのメンバーだけです。

この例では、sp_change_log_shipping_secondary_database を使用して、データベース LogShipAdventureWorks2008R2 のセカンダリ データベースのパラメーターを更新します。

EXEC master.dbo.sp_change_log_shipping_secondary_database 
 @secondary_database =  'LogShipAdventureWorks2008R2'
,  @restore_delay = 0
,  @restore_all = 1
,  @restore_mode = 0
,  @disconnect_users = 0
,  @threshold_alert = 14420
,  @threshold_alert_enabled = 1
,  @history_retention_period = 14420