This tip continues the system stored procedure series with a routine to list information about selected SQL Server Agent jobs.
One of the many things a SQL Server database administrator needs to keep track of is SQL Agent jobs -- defined tasks of a relatively low priority that execute in parallel with normal operations. SQL Agent jobs can be invoked directly, but they are often invoked indirectly by setting them up with a schedule for execution. The SQL Agent component of SQL Server automatically runs the jobs according to their schedules.
A SQL Agent job is a complex database object with many details involved in the definition. There are even more details to consider while a job is actually running, but it's not convenient to examine the details for SQL Agent jobs using Enterprise Manager and the filtering is less than ideal.
The SQL code in Listing 1 creates a system stored procedure named sp_ListJobInformation. The routine lists schedule and status information about selected SQL Agent jobs.
The sp_ListJobInformation stored procedure accepts seven parameters, but none of them are required.
The first parameter (@DBUltra) is optional and it specifies whether to limit the list to only enabled jobs. A value of zero (0) means all eligible jobs should be listed. A value of one (1) means only enabled jobs should be listed.
The next parameter (@PCUltra) is optional and it specifies whether to limit the list to only running jobs. A value of zero (0) means all eligible jobs should be listed. A value of one (1) means only running jobs should be listed.
The next four parameters are optional and they work together to form a combination of selection criteria using job names. Please refer to my earlier tip for an explanation of how these parameters work. These parameters specify the SQL Agent jobs to be considered.
The last parameter (@PCAdmin) is optional and it specifies the character string used to identify a connection initiated to run a job. The default value of "SQLAgent%Job%" works for SQL Server 2000 and it should work for other versions as well, but this parameter allows for potential differences.
The sp_ListJobInformation stored procedure returns schedule and status information about SQL Agent jobs. There is one row per job and the rows are filtered according to @DBUltra, @PCUltra and the other parameters.
I recommend using the Customize option under the Tools menu of Query Analyzer to set up an appropriate call of this stored procedure so it can be executed with a simple keyboard combination. This screen image demonstrates the suggestion.
Query Analyzer Customize option
This example lists information for all currently running jobs.
EXECUTE sp_ListJobInformation 0,1
This example lists information for all enabled jobs, which means the jobs eligible for scheduled execution.
EXECUTE sp_ListJobInformation 1,0
I hope you find this system stored procedure to be useful.
Click for the stored procedure: sp_ListJobInformation
About the author: Brian Walker is a senior database architect in an IS department that uses SQL Server 2000 and the .NET Framework. He has more than 25 years of experience in the IT industry with the last several years focused on databases and SQL Server. Walker is a software developer, database developer, database administrator and database consultant. He develops utility software as a hobby, including a large collection of SQL Server utilities.
More information from SearchSQLServer.com
- Fast Guide: Stored procedures
- Tips: View our complete collection of stored procedures
- Topic: Get stored procedure tips and tricks in this topic section