• [アーティクル]

sp_change_log_shipping_primary_database (Transact-SQL)

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

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

構文

sp_change_log_shipping_primary_database [ @database = ] 'database'
[, [ @backup_directory = ] 'backup_directory'] 
[, [ @backup_share = ] '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 = ] 'backup_directory'
    プライマリ サーバー上のバックアップ フォルダーのパスを指定します。backup_directory のデータ型は nvarchar(500) で、既定値はありません。NULL 値は許可されません。

  • [ @backup_share = ] '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 のデータ型は bit で、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 のデータ型は bit で、NULL 値は許可されません。

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

  • [ @backup_compression = ] backup_compression_option
    ログ配布構成でバックアップの圧縮を使用するかどうかを指定します。このパラメーターは SQL Server 2008 Enterprise (またはそれ以降のバージョン) でのみサポートされます。

    0 = 無効。ログ バックアップは圧縮されません。

    1 = 有効。ログ バックアップを常に圧縮します。

    2 = backup compression default サーバー構成オプションの設定を使用します。これは既定値です。

リターン コード値

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 固定サーバー ロールのメンバーだけです。

例

次の例では、sp_change_log_shipping_primary_database を使用して、プライマリ データベース AdventureWorks2008R2 に関連付けられている設定を更新します。

EXEC master.dbo.sp_change_log_shipping_primary_database 
 @database = N'AdventureWorks2008R2' 
, @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