Edit

sp_change_log_shipping_primary_database (Transact-SQL)

  • Article

Applies to: SQL Server

Changes the primary database settings.

Transact-SQL syntax conventions

Syntax

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 ]
[ ; ]

Arguments

[ @database = ] 'database'

The name of the database on the primary server. @primary_database is sysname, with no default.

[ @backup_directory = ] N'backup_directory'

The path to the backup folder on the primary server. @backup_directory is nvarchar(500), with no default, and can't be NULL.

[ @backup_share = ] N'backup_share'

The network path to the backup directory on the primary server. @backup_share is nvarchar(500), with no default, and can't be NULL.

[ @backup_retention_period = ] 'backup_retention_period'

The length of time, in minutes, to retain the log backup file in the backup directory on the primary server. @backup_retention_period is int, with no default, and can't be NULL.

[ @monitor_server_security_mode = ] 'monitor_server_security_mode'

The security mode used to connect to the monitor server.

  • 1 = Windows Authentication
  • 0 = SQL Server Authentication

@monitor_server_security_mode is bit and defaults to NULL.

[ @monitor_server_login = ] 'monitor_server_login'

The username of the account used to access the monitor server.

[ @monitor_server_password = ] 'monitor_server_password'

The password of the account used to access the monitor server.

[ @backup_threshold = ] 'backup_threshold'

The length of time, in minutes, after the last backup before a @threshold_alert error is raised. @backup_threshold is int, with a default of 60 minutes.

[ @threshold_alert = ] 'threshold_alert'

The alert to be raised when the backup threshold is exceeded. @threshold_alert is int and can't be NULL.

[ @threshold_alert_enabled = ] 'threshold_alert_enabled'

Specifies whether an alert is raised when @backup_threshold is exceeded.

  • 1: enabled
  • 0: disabled

threshold_alert_enabled is bit and can't be NULL.

[ @history_retention_period = ] 'history_retention_period'

The length of time in minutes in which the history is retained. @history_retention_period is int. A value of 14420 is used if none is specified.

[ @backup_compression = ] backup_compression_option

Specifies whether a log shipping configuration uses backup compression. This parameter is supported in Enterprise edition for SQL Server 2008 (10.0.x) (and later versions), and all editions on SQL Server 2016 (13.x) with Service Pack 1 (and later versions).

Return code values

0 (success) or 1 (failure).

Result set

None.

Remarks

sp_change_log_shipping_primary_database must be run from the master database on the primary server. This stored procedure does the following:

  1. Changes the settings in the log_shipping_primary_database record, if necessary.

  2. Changes the local record in log_shipping_monitor_primary on the primary server using supplied arguments, if necessary.

  3. If the monitor server is different from the primary server, changes record in log_shipping_monitor_primary on the monitor server using supplied arguments, if necessary.

Permissions

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

Examples

This example illustrates the use of sp_change_log_shipping_primary_database to update the settings associated with the primary database AdventureWorks2022.

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;

Related content