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