sp_add_log_shipping_primary_secondary (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

This stored procedure adds an entry for a secondary database on the primary server.

||
|-|
|Applies to: SQL Server ( SQL Server 2008 through current version).|

Topic link icon Transact-SQL Syntax Conventions

Syntax


sp_add_log_shipping_primary_secondary  
[ @primary_database = ] 'primary_database',  
[ @secondary_server = ] 'secondary_server',   
[ @secondary_database = ] 'secondary_database'  

Arguments

[ @primary_database = ] 'primary_database'
Is the name of the database on the primary server. primary_database is sysname, with no default.

[ @secondary_server = ] 'secondary_server',
Is the name of the secondary server. secondary_server is sysname, with no default.

[ @secondary_database = ] 'secondary_database'
Is the name of the secondary database. secondary_database is sysname, with no default.

Return Code Values

0 (success) or 1 (failure)

Result Sets

None

Remarks

sp_add_log_shipping_primary_secondary must be run from the master database on the primary server.

Permissions

Only members of the sysadmin fixed server role can run this procedure.

Examples

This example illustrates using sp_add_log_shipping_primary_secondary to add an entry for the secondary database LogShipAdventureWorks to the secondary server FLATIRON.

EXEC master.dbo.sp_add_log_shipping_primary_secondary   
@primary_database = N'AdventureWorks'   
, @secondary_server = N'flatiron'   
, @secondary_database = N'LogShipAdventureWorks' ;  
GO  

See Also

About Log Shipping (SQL Server)
System Stored Procedures (Transact-SQL)