sp_help_category (Transact-SQL)
Выдает сведения об указанных классах заданий, предупреждений или операторов.
Синтаксис
sp_help_category [ [ @class = ] 'class' ]
[ , [ @type = ] 'type' ]
[ , [ @name = ] 'name' ]
[ , [ @suffix = ] suffix ]
Аргументы
[ @class=] 'class'
Класс, о котором запрашиваются сведения. Аргумент class имеет тип varchar(8) и значение по умолчанию JOB. Значение аргумента class может быть одним из следующих.Значение Описание JOB
Выдает сведения о категории заданий.
ALERT
Выдает сведения о категории предупреждений.
OPERATOR
Выдает сведения о категории операторов.
[ @type= ] 'type'
Тип категории, для которой запрашиваются сведения. Аргумент type имеет тип varchar(12), значение по умолчанию NULL и может принимать одно из следующих значений.Значение Описание LOCAL
Категория локальных заданий.
MULTI -SERVER
Категория многосерверных заданий.
NONE
Категория для класса, отличного от JOB.
- [ @name= ] 'name'
Имя категории, для которой запрашиваются сведения. Аргумент name имеет тип sysname и значение по умолчанию NULL.
- [ @suffix= ] suffix
Указывает, является ли столбец category_type в результирующем наборе идентификатором или именем. Аргумент suffix имеет тип bit и значение по умолчанию 0. При значении 1 в качестве имени отображается category_type, а в качестве идентификатора — 0.
Значения кодов возврата
0 (успешное завершение) или 1 (неуспешное завершение)
Результирующие наборы
Если значение аргумента @suffix равно 0, то процедура sp_help_category возвращает следующий результирующий набор:
| Имя столбца | Тип данных | Описание |
|---|---|---|
category_id |
int |
Идентификатор категории |
category_type |
tinyint |
Тип категории: 1 = Локальная 2 = Многосерверная 3 = Нет |
name |
sysname |
Имя категории |
Если значение аргумента @suffix равно 1, то процедура sp_help_category возвращает следующий результирующий набор:
| Имя столбца | Тип данных | Описание |
|---|---|---|
category_id |
int |
Идентификатор категории |
category_type |
sysname |
Тип категории. Одно из значений: LOCAL, MULTI-SERVER или NONE |
name |
sysname |
Имя категории |
Замечания
Хранимую процедуру sp_help_category необходимо запускать из базы данных msdb.
Если никакие аргументы не указаны, результирующий набор содержит сведения обо всех категориях заданий.
Разрешения
По умолчанию члены фиксированной серверной роли sysadmin могут выполнять эту хранимую процедуру. Другим пользователям должно быть предоставлено членство в одной из следующих фиксированных ролей базы данных агента SQL Server в базе данных msdb:
- SQLAgentUserRole
- SQLAgentReaderRole
- SQLAgentOperatorRole
Сведения о разрешениях для этих ролей см. в разделе Фиксированные роли базы данных агента SQL Server.
Примеры
A. Возвращение сведений о локальных заданиях
В следующем примере возвращаются сведения о заданиях, администрируемых локально.
USE msdb ;
GO
EXEC dbo.sp_help_category
@type = N'LOCAL' ;
GO
Б. Возвращение сведений о предупреждениях
В следующем примере возвращаются сведения о категории предупреждений Replication.
USE msdb ;
GO
EXEC dbo.sp_help_category
@class = N'ALERT',
@name = N'Replication' ;
GO
См. также
Справочник
sp_add_category (Transact-SQL)
sp_delete_category (Transact-SQL)
sp_update_category (Transact-SQL)
Системные хранимые процедуры (Transact-SQL)