sp_can_tlog_be_applied (Transact-SQL)

Article
02/28/2023

Applies to: SQL Server

Verifies whether a transaction log backup can be applied to a SQL Server database. sp_can_tlog_be_applied requires that the database be in the Restoring state.

Transact-SQL syntax conventions

Syntax

  
sp_can_tlog_be_applied [ @backup_file_name = ] 'backup_file_name'   
        , [ @database_name = ] 'database_name'   
        , [ @result = ] result OUTPUT

Arguments

[ @backup_file_name = ] 'backup_file_name' Is the name of a backup file. backup_file_name is nvarchar(128).

[ @database_name = ] 'database_name' Is the name of the database. database_name is sysname.

[ @result = ] _result_ OUTPUT Indicates whether the transaction log can be applied to the database. result is bit.

1 = The log can be applies

0= The log cannot be applied.

Return Code Values

0 (success) or 1 (failure)

Permissions

Only members of the sysadmin fixed server role can execute sp_can_tlog_be_applied.

Examples

The following example declares a local variable, @MyBitVar, to store the result.

USE master;  
GO  
DECLARE @MyBitVar BIT;  
EXEC sp_can_tlog_be_applied  
     @backup_file_name =   
N'C:\Program Files\Microsoft SQL Server\MSSQL13.MSSQLSERVER\MSSQL\Backup\AdventureWorks2022.bak',  
     @database_name = N'AdventureWorks2022',  
     @result = @MyBitVar OUTPUT;  
GO