Edit

Share via

jobs.sp_purge_jobhistory (Azure Elastic Jobs) (Transact-SQL)

  • Article

Applies to: Azure SQL Database

Removes the history records for a job in the Azure Elastic Jobs service for Azure SQL Database.

This stored procedure shares the name of sp_purge_jobhistory with a similar object in SQL Server for the SQL Server Agent service. For information about the SQL Server Agent version, see sp_purge_jobhistory.

Transact-SQL syntax conventions

Syntax

[jobs].sp_purge_jobhistory [ @job_name = ] 'job_name'
      [ , [ @job_id = ] job_id ]
      [ , [ @oldest_date = ] oldest_date ]

Arguments

[ @job_name = ] N'job_name'

The name of the job for which to delete the history records. @job_name is nvarchar(128), with a default of NULL.

Either @job_id or @job_name must be specified, but both can't be specified.

[ @job_id = ] job_id

The job identification number of the job for the records to be deleted. @job_id is uniqueidentifier, with a default of NULL.

Either @job_id or @job_name must be specified, but both can't be specified.

[ @oldest_date = ] oldest_date

The oldest record to retain in the history. @oldest_date is datetime2, with a default of NULL. When @oldest_date is specified, sp_purge_jobhistory only removes records that are older than the value specified.

All times in elastic jobs are in the UTC time zone.

Return code values

0 (success) or 1 (failure).

Remarks

Elastic job history is automatically deleted if more than 45 days old.

Permissions

By default, members of the sysadmin fixed server role can execute this stored procedure. Only members of sysadmin can use this stored procedure to edit the attributes of jobs that are owned by other users.

Examples

A. Delete old job history

The following example shows how to delete job history before a specific date.

Connect to the job_database and run the following command:

--Connect to the job database specified when creating the job agent

-- Delete history of a specific job's executions older than the specified date
EXEC jobs.sp_purge_jobhistory
    @job_name = 'ResultPoolsJob',
    @oldest_date = '2016-07-01 00:00:00';
GO

B. Delete a job and all its job history

The following example shows how to delete a job using jobs.sp_delete_job and all related job history.

Connect to the job_database and run the following command:

--Connect to the job database specified when creating the job agent

--Delete a job and all its history
EXEC jobs.sp_delete_job @job_name = 'ResultsPoolsJob';

Related content