sp_change_log_shipping_primary_database (Transact-SQL)

  • [アーティクル]

適用対象:SQL Server

プライマリ データベースの設定を変更します。

Transact-SQL 構文表記規則

構文

sp_change_log_shipping_primary_database
    [ @database = ] 'database'
    [ , [ @backup_directory = ] N'backup_directory' ]
    [ , [ @backup_share = ] N'backup_share' ]
    [ , [ @backup_retention_period = ] 'backup_retention_period' ]
    [ , [ @monitor_server_security_mode = ] 'monitor_server_security_mode' ]
    [ , [ @monitor_server_login = ] 'monitor_server_login' ]
    [ , [ @monitor_server_password = ] 'monitor_server_password' ]
    [ , [ @backup_threshold = ] 'backup_threshold' ]
    [ , [ @threshold_alert = ] 'threshold_alert' ]
    [ , [ @threshold_alert_enabled = ] 'threshold_alert_enabled' ]
    [ , [ @history_retention_period = ] 'history_retention_period' ]
    [ , [ @backup_compression = ] backup_compression_option ]
[ ; ]

引数

[ @database = ] 'database'

プライマリ サーバー上のデータベースの名前。 @primary_databaseは sysname で、既定値はありません。

[ @backup_directory = ] N'backup_directory'

プライマリ サーバー上のバックアップ フォルダーへのパス。 @backup_directoryは nvarchar(500) で、既定値はなく、NULL にすることはできません。

[ @backup_share = ] N'backup_share'

プライマリ サーバー上のバックアップ ディレクトリへのネットワーク パス。 @backup_shareは nvarchar(500) で、既定値はなく、NULL にすることはできません。

[ @backup_retention_period = ] 'backup_retention_period'

プライマリ サーバーのバックアップ ディレクトリにログ バックアップ ファイルを保持する時間 (分)。 @backup_retention_periodは int で、既定値はなく、NULL にすることはできません。

[ @monitor_server_security_mode = ] 'monitor_server_security_mode'

監視サーバーへの接続に使用されるセキュリティ モード。

  • 1 = Windows 認証
  • 0 = SQL Server 認証

@monitor_server_security_modeはビットであり、既定値は NULL です。

[ @monitor_server_login = ] 'monitor_server_login'

監視サーバーへのアクセスに使用するアカウントのユーザー名。

[ @monitor_server_password = ] 'monitor_server_password'

監視サーバーへのアクセスに使用するアカウントのパスワード。

[ @backup_threshold = ] 'backup_threshold'

@threshold_alert エラーが発生するまでの最後のバックアップ後の時間 (分単位)。 @backup_thresholdは int で、既定値は 60 分です。

[ @threshold_alert = ] 'threshold_alert'

バックアップのしきい値を超えたときに発生するアラート。 @threshold_alertは int であり、NULL にすることはできません。

[ @threshold_alert_enabled = ] 'threshold_alert_enabled'

@backup_thresholdを超えたときにアラートを発生するかどうかを指定します。

  • 1：有効
  • 0：無効

threshold_alert_enabledはビットであり、NULL にすることはできません。

[ @history_retention_period = ] 'history_retention_period'

履歴が保持される時間 (分単位)。 @history_retention_periodは int です。値 14420 は、何も指定されていない場合に使用されます。

[ @backup_compression = ] backup_compression_option

ログ配布構成でバックアップ圧縮を使用するかどうかを指定します。 このパラメーターは、SQL Server 2008 (10.0.x) (以降のバージョン) および SQL Server 2016 (13.x) Service Pack 1 (以降のバージョン) のすべてのエディションの Enterprise Edition でサポートされています。

リターン コードの値

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

結果セット

ありません。

解説

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

  1. 必要に応じて、レコードの設定を log_shipping_primary_database 変更します。

  2. 必要に応じて、指定された引数を使用して、プライマリ サーバーのローカル レコード log_shipping_monitor_primary を変更します。

  3. モニター・サーバーがプライマリ・サーバーと異なる場合は、必要に応じて、指定された引数を使用してモニター・サーバー上のレコード log_shipping_monitor_primary を変更します。

アクセス許可

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

例

この例では、プライマリ データベースAdventureWorks2022に関連付けられている設定を更新する方法sp_change_log_shipping_primary_databaseを示します。

EXEC master.dbo.sp_change_log_shipping_primary_database
    @database = N'AdventureWorks',
    @backup_directory = N'c:\LogShipping',
    @backup_share = N'\\tribeca\LogShipping',
    @backup_retention_period = 1440,
    @backup_threshold = 60,
    @threshold_alert = 0,
    @threshold_alert_enabled = 1,
    @history_retention_period = 1440,
    @monitor_server_security_mode = 1,
    @backup_compression = 1;

関連するコンテンツ