sp_add_log_shipping_primary_database (Transact-SQL)sp_add_log_shipping_primary_database (Transact-SQL)

適用対象: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse APPLIES TO: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

バックアップ ジョブ、ローカル監視レコード、リモート監視レコードを含め、ログ配布構成のプライマリ データベースを設定します。Sets up the primary database for a log shipping configuration, including the backup job, local monitor record, and remote monitor record.

トピック リンク アイコン Transact-SQL 構文表記規則Topic link icon Transact-SQL Syntax Conventions


sp_add_log_shipping_primary_database [ @database = ] 'database',   
[ @backup_directory = ] 'backup_directory',   
[ @backup_share = ] 'backup_share',   
[ @backup_job_name = ] 'backup_job_name',   
[, [ @backup_retention_period = ] backup_retention_period]  
[, [ @monitor_server = ] 'monitor_server']  
[, [ @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_job_id = ] backup_job_id OUTPUT ]  
[, [ @primary_id = ] primary_id OUTPUT]  
[, [ @backup_compression = ] backup_compression_option ]  


[ @database = ] 'database' ログ配布プライマリ データベースの名前です。[ @database = ] 'database' Is the name of the log shipping primary database. データベースsysname、既定値はありません、NULL にすることはできません。database is sysname, with no default, and cannot be NULL.

[ @backup_directory = ] 'backup_directory' プライマリ サーバー上のバックアップ フォルダーのパスです。[ @backup_directory = ] 'backup_directory' Is the path to the backup folder on the primary server. backup_directorynvarchar (500) 、既定値はありません、NULL にすることはできません。backup_directory is nvarchar(500), with no default, and cannot be NULL.

[ @backup_share = ] 'backup_share' プライマリ サーバー上のバックアップ ディレクトリへのネットワーク パスです。[ @backup_share = ] 'backup_share' Is the network path to the backup directory on the primary server. backup_sharenvarchar (500) 、既定値はありません、NULL にすることはできません。backup_share is nvarchar(500), with no default, and cannot be NULL.

[ @backup_job_name = ] 'backup_job_name' バックアップ フォルダーに、バックアップをコピーするプライマリ サーバー上の SQL Server エージェント ジョブの名前です。[ @backup_job_name = ] 'backup_job_name' Is the name of the SQL Server Agent job on the primary server that copies the backup into the backup folder. backup_job_namesysname NULL にすることはできません。backup_job_name is sysname and cannot be NULL.

[ @backup_retention_period = ] backup_retention_period プライマリ サーバー上のバックアップ ディレクトリにログ バックアップ ファイルを保持する分単位の時間の長さです。[ @backup_retention_period = ] backup_retention_period Is the length of time, in minutes, to retain the log backup file in the backup directory on the primary server. backup_retention_periodint、既定値はありません、NULL にすることはできません。backup_retention_period is int, with no default, and cannot be NULL.

[ @monitor_server = ] 'monitor_server' 監視サーバーの名前です。[ @monitor_server = ] 'monitor_server' Is the name of the monitor server. Monitor_serversysname、既定値はありません、NULL にすることはできません。Monitor_server is sysname, with no default, and cannot be NULL.

[ @monitor_server_security_mode = ] monitor_server_security_mode 監視サーバーへの接続に使用されるセキュリティ モード。[ @monitor_server_security_mode = ] monitor_server_security_mode The security mode used to connect to the monitor server.

1 = Windows 認証。1 = Windows Authentication.

0 =SQL ServerSQL Server認証します。0 = SQL ServerSQL Server Authentication. monitor_server_security_modeビットNULL にすることはできません。monitor_server_security_mode is bit and cannot be NULL.

[ @monitor_server_login = ] 'monitor_server_login' 監視サーバーへのアクセスに使用するアカウントの username です。[ @monitor_server_login = ] 'monitor_server_login' Is the username of the account used to access the monitor server.

[ @monitor_server_password = ] 'monitor_server_password' 監視サーバーへのアクセスに使用するアカウントのパスワードです。[ @monitor_server_password = ] 'monitor_server_password' Is the password of the account used to access the monitor server.

[ @backup_threshold = ] backup_threshold 前に前回のバックアップ後の分の時間の長さ、 threshold_alertエラーが発生します。[ @backup_threshold = ] backup_threshold Is the length of time, in minutes, after the last backup before a threshold_alert error is raised. backup_thresholdint、既定値は 60 分です。backup_threshold is int, with a default of 60 minutes.

[ @threshold_alert = ] threshold_alert アラートが、バックアップのしきい値を超えたときに発生します。[ @threshold_alert = ] threshold_alert Is the alert to be raised when the backup threshold is exceeded. threshold_alertint、既定値は 14,420 です。threshold_alert is int, with a default of 14,420.

[ @threshold_alert_enabled = ] threshold_alert_enabled アラートがあるかどうかを指定する場合に発生しますbackup_thresholdを超過します。[ @threshold_alert_enabled = ] threshold_alert_enabled Specifies whether an alert will be raised when backup_threshold is exceeded. 値 0 (既定値) を指定すると、警告が無効になり、生成されなくなります。The value of zero (0), the default, means that the alert is disabled and will not be raised. threshold_alert_enabledビットします。threshold_alert_enabled is bit.

[ @history_retention_period = ] history_retention_period 分の履歴を保持する時間の長さです。[ @history_retention_period = ] history_retention_period Is the length of time in minutes in which the history will be retained. history_retention_periodint、既定値は NULL です。history_retention_period is int, with a default of NULL. 指定されていない場合、値 14420 が使用されます。A value of 14420 will be used if none is specified.

[ @backup_job_id = ] backup_job_id OUTPUT SQL ServerSQL Serverプライマリ サーバー上のバックアップ ジョブに関連付けられているエージェント ジョブの ID。[ @backup_job_id = ] backup_job_id OUTPUT The SQL ServerSQL Server Agent job ID associated with the backup job on the primary server. backup_job_iduniqueidentifier NULL にすることはできません。backup_job_id is uniqueidentifier and cannot be NULL.

[ @primary_id = ] primary_id OUTPUT ログ配布構成におけるプライマリ データベースの ID。[ @primary_id = ] primary_id OUTPUT The ID of the primary database for the log shipping configuration. primary_iduniqueidentifier NULL にすることはできません。primary_id is uniqueidentifier and cannot be NULL.

[ @backup_compression = ] backup_compression_option ログ配布構成を使用するかどうかを指定バックアップの圧縮します。[ @backup_compression = ] backup_compression_option Specifies whether a log shipping configuration uses backup compression. このパラメーターは SQL Server 2008 EnterpriseSQL Server 2008 Enterprise (またはそれ以降のバージョン) でのみサポートされます。This parameter is supported only in SQL Server 2008 EnterpriseSQL Server 2008 Enterprise (or a later version).

0 = 無効になっています。0 = Disabled. ログ バックアップは圧縮されません。Never compress log backups.

1 = 有効にします。1 = Enabled. 常にログ バックアップを圧縮します。Always compress log backups.

2 = の設定を使用して、 backup compression default サーバー構成オプションの構成を表示またはします。2 = Use the setting of the View or Configure the backup compression default Server Configuration Option. これは既定値です。This is the default value.

リターン コードの値Return Code Values

0 (成功) または 1 (失敗)0 (success) or 1 (failure)

結果セットResult Sets



sp_add_log_shipping_primary_databaseから実行する必要があります、マスタープライマリ サーバー上のデータベース。sp_add_log_shipping_primary_database must be run from the master database on the primary server. このストアド プロシージャは、次の関数を実行します。This stored procedure performs the following functions:

  1. プライマリ ID を生成し、テーブル内のプライマリ データベースのエントリを追加log_shipping_primary_databases指定された引数を使用します。Generates a primary ID and adds an entry for the primary database in the table log_shipping_primary_databases using the supplied arguments.

  2. 無効になっているプライマリ データベースのバックアップ ジョブを作成します。Creates a backup job for the primary database that is disabled.

  3. バックアップ ジョブの ID を設定、 log_shipping_primary_databasesバックアップ ジョブのジョブ ID を入力します。Sets the backup job ID in the log_shipping_primary_databases entry to the job ID of the backup job.

  4. ローカル監視レコードをテーブルの追加log_shipping_monitor_primaryプライマリ サーバーを使用して引数を指定します。Adds a local monitor record in the table log_shipping_monitor_primary on the primary server using supplied arguments.

  5. 監視サーバーがプライマリ サーバーと異なる場合は、監視レコードを追加します。 log_shipping_monitor_primaryモニターでサーバーを使用して引数を指定します。If the monitor server is different from the primary server, adds a monitor record in log_shipping_monitor_primary on the monitor server using supplied arguments.


メンバーのみ、 sysadmin固定サーバー ロールは、この手順を実行できます。Only members of the sysadmin fixed server role can run this procedure.


次の例では、ログ配布構成のプライマリ データベースとして、データベース AdventureWorks2012AdventureWorks2012 を追加します。This example adds the database AdventureWorks2012AdventureWorks2012 as the primary database in a log shipping configuration.

DECLARE @LS_BackupJobId AS uniqueidentifier ;  
DECLARE @LS_PrimaryId AS uniqueidentifier ;  
EXEC master.dbo.sp_add_log_shipping_primary_database   
@database = N'AdventureWorks'   
,@backup_directory = N'c:\lsbackup'   
,@backup_share = N'\\tribeca\lsbackup'   
,@backup_job_name = N'LSBackup_AdventureWorks'   
,@backup_retention_period = 1440  
,@monitor_server = N'rockaway'   
,@monitor_server_security_mode = 1   
,@backup_threshold = 60   
,@threshold_alert = 0   
,@threshold_alert_enabled = 0   
,@history_retention_period = 1440   
,@backup_job_id = @LS_BackupJobId OUTPUT   
,@primary_id = @LS_PrimaryId OUTPUT   
,@overwrite = 1   
,@backup_compression = 0;  

関連項目See Also

ログ配布について (SQL Server) About Log Shipping (SQL Server)
システム ストアド プロシージャ (Transact-SQL)System Stored Procedures (Transact-SQL)