SQL Agent Jobs in an AlwaysOn / Mirroring Environment
Running SQL Agent Jobs in an AlwaysOn or Database Mirroring environment can be a challenge, as the database might be not accessible at the time when the job starts. This is especially the case for all SAP collector and backup jobs. On the other hand there might be jobs that should not run on primary server (e.g. DBCC Checks), but on a readable secondary or readonly standby database (Log Shipping). In the worst case either the jobs fail or run on the wrong server. To prevent this, SAP created a small stored procedure to control the run of these kind of jobs.
To use the stored procedure, download the attached script and run it on all nodes of the affected system (either AlwaysOn, Database Mirroring or Log Shipping). It will create a stored procedure CheckAccess in the master database. The procedure has 5 parameters:
Parameter | Data Type | Default Value | Description |
@DBName | NVARCHAR(128) | N'master' | Database to check. |
@RunOnPrimary | TINYINT | 1 | Should the job run on the primary database ? |
@RunOnSecondary | TINYINT | 0 | Should the job run on the secondary database ? |
@RunOnReadonly | TINYINT | 0 | Should the job run on the read only databases (Log Shipping) ? |
@RC | TINYINT | 0 | Return code (0 = Success, 1 = Failure) |
With the parameters @RunOnPrimary, @RunOnSecondary and @RunOnReadonly you can control in which state of the AlwaysOn database the Job should start. A combination of these parameters is possible, so the job can run on primary and secondary databases if you set both to 1. Even if you do not use AlwaysOn or readonly databases or if you set all the options to 0 the stored procedure will check for the availability of the database. It will return a failure (1) if the database is absent, offline, suspect, in recovery and all the other states that won't let you access the database. A valid call looks like this (Check the TST database if it is accessible and check if it is the primary database in an AlwaysOn configuration):
exec dbo.CheckAccess N'TST',1,0,0,@RC OUTPUT
To enable the CheckAccess stored procedure for jobs, we have to change the job a bit. In this example it is an SAP Collector Job (SAP_SCU_SAPMonitor_TST_MSSQL_COLLECTOR) for the TST SAP database.
Open the properties for the job (right click -> Properties)
Switch to the Steps branch on the left
and edit the first step with the name DBCOLL. Change the database to master (as the stored procedure lives there) and change the script from
EXECUTE sap_dbcoll
to
DECLARE @Msg NVARCHAR(128)
DECLARE @RC TINYINT
exec dbo.CheckAccess N'TST',1,0,0,@RC OUTPUT
IF @RC = 0
exec( 'use [TST] EXECUTE sap_dbcoll' )
Ensure that you change the database accordingly (here TST) for your system. The step then should look like:
On the advanced tab change the 'On failure action' field to 'Quit the job reporting failure'
and save and exit the job definition. This will ensure that the DBCOLL part will only start when the database is accessible and is the primary database in the AlwaysOn Configuration.
You can use this stored procedure for any job, when you follow this generic approach:
DECLARE @Msg NVARCHAR(128)
DECLARE @RC TINYINT
exec dbo.CheckAccess N'<Database in Question>',1,0,0,@RC OUTPUT
IF @RC = 0
exec( 'use [<Database in Question>] <Step definition>' )
Regards
Clas
Comments
- Anonymous
June 07, 2016
A bug in the stored procedure:DECLARE @Message NVARCHAR(50);50 is too small for the whole message to be displayed. As a result, @Message = N'The database is not in the required state for Always-ON access.'; gets truncated. - Anonymous
June 21, 2016
The comment has been removed - Anonymous
August 05, 2016
The DECLARE @Message NVARCHAR(50); is not enough to contain all messages.Increase the size of varchar to 100.