sp_add_log_shipping_secondary_primary (Transact-SQL)sp_add_log_shipping_secondary_primary (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 information, adds local and remote monitor links, and creates copy and restore jobs on the secondary server for the specified primary database.

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

構文Syntax

  
sp_add_log_shipping_secondary_primary  
 [ @primary_server = ] 'primary_server',   
[ @primary_database = ] 'primary_database',  
[ @backup_source_directory = ] 'backup_source_directory' ,   
[ @backup_destination_directory = ] 'backup_destination_directory'  
[ @copy_job_name = ] 'copy_job_name'  
[ @restore_job_name = ] 'restore_job_name'  
[, [ @file_retention_period = ] 'file_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']  
[, [ @copy_job_id = ] 'copy_job_id' OUTPUT ]  
[, [ @restore_job_id = ] 'restore_job_id' OUTPUT ]  
[, [ @secondary_id = ] 'secondary_id' OUTPUT]  

[引数]Arguments

ログ配布構成の MicrosoftMicrosoft SQL Server データベース エンジンSQL Server Database Engine のプライマリインスタンスの名前 [ @primary_server = ] 'primary_server' ます。[ @primary_server = ] 'primary_server' The name of the primary instance of the MicrosoftMicrosoft SQL Server データベース エンジンSQL Server Database Engine in the log shipping configuration. primary_serversysname NULL にすることはできません。primary_server is sysname and cannot be NULL.

[ @primary_database = ] 'primary_database' は、プライマリサーバー上のデータベースの名前です。[ @primary_database = ] 'primary_database' Is the name of the database on the primary server. primary_databasesysname,、既定値はありません。primary_database is sysname, with no default.

プライマリサーバーからのトランザクションログバックアップファイルが格納されているディレクトリを [ @backup_source_directory = ] 'backup_source_directory' します。[ @backup_source_directory = ] 'backup_source_directory' The directory where transaction log backup files from the primary server are stored. backup_source_directorynvarchar (500) であり、NULL にすることはできません。backup_source_directory is nvarchar(500) and cannot be NULL.

バックアップファイルのコピー先となるセカンダリサーバー上のディレクトリを [ @backup_destination_directory = ] 'backup_destination_directory' します。[ @backup_destination_directory = ] 'backup_destination_directory' The directory on the secondary server where backup files are copied to. backup_destination_directorynvarchar (500) であり、NULL にすることはできません。backup_destination_directory is nvarchar(500) and cannot be NULL.

トランザクションログバックアップをセカンダリサーバーにコピーするために作成される SQL ServerSQL Server エージェントジョブに使用する名前を [ @copy_job_name = ] 'copy_job_name' します。[ @copy_job_name = ] 'copy_job_name' The name to use for the SQL ServerSQL Server Agent job being created to copy transaction log backups to the secondary server. copy_job_namesysname NULL にすることはできません。copy_job_name is sysname and cannot be NULL.

[ @restore_job_name = ] 'restore_job_name' は、セカンダリデータベースにバックアップを復元するセカンダリサーバー上の SQL ServerSQL Server エージェントジョブの名前です。[ @restore_job_name = ] 'restore_job_name' Is the name of the SQL ServerSQL Server Agent job on the secondary server that restores the backups to the secondary database. restore_job_namesysname NULL にすることはできません。restore_job_name is sysname and cannot be NULL.

@backup_destination_directory パラメーターで指定されたパスにおいて、バックアップファイルがセカンダリサーバー上で保持される時間 (分単位) を [ @file_retention_period = ] 'file_retention_period' します。この時間を経過すると、削除されます。[ @file_retention_period = ] 'file_retention_period' The length of time, in minutes, that a backup file is retained on the secondary server in the path specified by the @backup_destination_directory parameter before being deleted. 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.

[ @monitor_server = ] 'monitor_server' 監視サーバーの名前を指定します。[ @monitor_server = ] 'monitor_server' Is the name of the monitor server. Monitor_serverの型はsysnameで、既定値はありません。 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' は、監視サーバーへのアクセスに使用するアカウントのユーザー名です。[ @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.

セカンダリサーバー上のコピージョブに関連付けられている ID [ @copy_job_id = ] 'copy_job_id' OUTPUT ます。[ @copy_job_id = ] 'copy_job_id' OUTPUT The ID associated with the copy job on the secondary server. copy_job_iduniqueidentifierであり、NULL にすることはできません。copy_job_id is uniqueidentifier and cannot be NULL.

セカンダリサーバー上の復元ジョブに関連付けられている ID [ @restore_job_id = ] 'restore_job_id' OUTPUT ます。[ @restore_job_id = ] 'restore_job_id' OUTPUT The ID associated with the restore job on the secondary server. restore_job_iduniqueidentifierであり、NULL にすることはできません。restore_job_id is uniqueidentifier and cannot be NULL.

ログ配布構成のセカンダリサーバーの ID を [ @secondary_id = ] 'secondary_id' OUTPUT します。[ @secondary_id = ] 'secondary_id' OUTPUT The ID for the secondary server in the log shipping configuration. secondary_iduniqueidentifierであり、NULL にすることはできません。secondary_id is uniqueidentifier and cannot be NULL.

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

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

結果セットResult Sets

[InclusionThresholdSetting]None

備考Remarks

sp_add_log_shipping_secondary_primaryは、セカンダリサーバーのmasterデータベースから実行する必要があります。sp_add_log_shipping_secondary_primary must be run from the master database on the secondary server. このストアド プロシージャでは次の処理が行われます。This stored procedure does the following:

  1. 指定したプライマリ サーバーとプライマリ データベースのセカンダリ ID を生成する。Generates a secondary ID for the specified primary server and primary database.

  2. では、次のことが行われます。Does the following:

    1. 指定された引数を使用して、 log_shipping_secondaryにセカンダリ ID のエントリを追加します。Adds an entry for the secondary ID in log_shipping_secondary using the supplied arguments.

    2. 無効になったセカンダリ ID のコピー ジョブを作成する。Creates a copy job for the secondary ID that is disabled.

    3. Log_shipping_secondaryエントリのコピージョブ id をコピージョブのジョブ id に設定します。Sets the copy job ID in the log_shipping_secondary entry to the job ID of the copy job.

    4. セカンダリ ID に対して無効になっている復元ジョブを作成します。Creates a restore job for the secondary ID that is disabled.

    5. Log_shipping_secondaryエントリの復元ジョブ id を、復元ジョブのジョブ id に設定します。Set the restore job ID in the log_shipping_secondary entry to the job ID of the restore job.

PermissionsPermissions

このプロシージャを実行できるのは、 sysadmin固定サーバーロールのメンバーだけです。Only members of the sysadmin fixed server role can run this procedure.

使用例Examples

この例では、 sp_add_log_shipping_secondary_primaryストアドプロシージャを使用して、セカンダリサーバー上のプライマリデータベース AdventureWorks2012AdventureWorks2012 の情報を設定する方法を示します。This example illustrates using the sp_add_log_shipping_secondary_primary stored procedure to set up information for the primary database AdventureWorks2012AdventureWorks2012 on the secondary server.

EXEC master.dbo.sp_add_log_shipping_secondary_primary   
@primary_server = N'TRIBECA'   
,@primary_database = N'AdventureWorks'   
,@backup_source_directory = N'\\tribeca\LogShipping'   
,@backup_destination_directory = N''   
,@copy_job_name = N''   
,@restore_job_name = N''   
,@file_retention_period = 1440   
,@monitor_server = N'ROCKAWAY'   
,@monitor_server_security_mode = 1   
,@copy_job_id = @LS_Secondary__CopyJobId OUTPUT   
,@restore_job_id = @LS_Secondary__RestoreJobId OUTPUT   
,@secondary_id = @LS_Secondary__SecondaryId OUTPUT ;  
GO  

See Also

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