sp_update_category (Transact-SQL)

Applies to: SQL Server

Changes the name of a category.

Transact-SQL syntax conventions

Syntax

sp_update_category
    [ @class = ] 'class'
    , [ @name = ] N'name'
    , [ @new_name = ] N'new_name'
[ ; ]

Arguments

[ @class = ] 'class'

The class of the category to update. @class is varchar(8), and can be one of these values.

Value Description
ALERT Updates an alert category.
JOB Updates a job category.
OPERATOR Updates an operator category.

[ @name = ] N'name'

The current name of the category. @name is sysname, with no default.

[ @new_name = ] N'new_name'

The new name for the category. @new_name is sysname, with no default.

Return code values

0 (success) or 1 (failure).

Remarks

sp_update_category must be run from the msdb database.

Permissions

To run this stored procedure, users must be granted the sysadmin fixed server role.

Examples

The following example renames a job category from AdminJobs to Administrative Jobs.

USE msdb;
GO

EXEC dbo.sp_update_category
  @class = N'JOB',
  @name = N'AdminJobs',
  @new_name = N'Administrative Jobs';
GO