sp_update_job (Transact-SQL)

Изменяет атрибуты задания.

Применимо для следующих объектов: SQL Server (начиная с SQL Server 2008 до текущей версии).

Синтаксические обозначения в Transact-SQL

Синтаксис

sp_update_job [ @job_id =] job_id | [@job_name =] 'job_name'
     [, [@new_name =] 'new_name' ] 
     [, [@enabled =] enabled ]
     [, [@description =] 'description' ] 
     [, [@start_step_id =] step_id ]
     [, [@category_name =] 'category' ] 
     [, [@owner_login_name =] 'login' ]
     [, [@notify_level_eventlog =] eventlog_level ]
     [, [@notify_level_email =] email_level ]
     [, [@notify_level_netsend =] netsend_level ]
     [, [@notify_level_page =] page_level ]
     [, [@notify_email_operator_name =] 'operator_name' ]
     [, [@notify_netsend_operator_name =] 'netsend_operator' ]
     [, [@notify_page_operator_name =] 'page_operator' ]
     [, [@delete_level =] delete_level ] 
     [, [@automatic_post =] automatic_post ]

Аргументы

• [ @job_id =] job_id
  Идентификатор обновляемого задания. job_idявляется uniqueidentifier.

• [ @job_name =] 'job_name'
  Имя задания. job_nameявляется nvarchar(128).

  Примечание

  Должен быть задан аргумент job_id или аргумент job_name, но одновременно эти аргументы задаваться не могут.

• [ @new_name =] 'new_name'
  Новое имя задания. new_nameявляется nvarchar(128).

• [ @enabled =] enabled
  Указывает, включено ли задание (1) или не включено (0). enabledявляется tinyint.

• [ @description =] 'description'
  Описание задания. Аргумент description имеет тип nvarchar(512).

• [ @start_step_id =] step_id
  Идентификатор первого этапа, выполняемого в ходе задания. step_idявляется int.

• [ @category_name =] 'category'
  Категория задания. categoryявляется nvarchar(128).

• [ @owner_login_name =] 'login'
  Имя входа, которое владеет заданием. Аргумент loginимеет тип nvarchar(128). Менять владельца задания могут только члены предопределенной роли сервера sysadmin.

• [ @notify_level_eventlog =] eventlog_level
  Указывает, следует ли помещать запись в журнал приложений Microsoft Windows для данного задания. Аргумент eventlog_levelимеет тип int и может принимать одно из следующих значений.

  Значение	Описание (действие)
  0	Никогда
  1	При успешном завершении
  2	При сбое
  3	Всегда

• [ @notify_level_email =] email_level
  Указывает, нужно ли отправить сообщение электронной почты по завершении этого задания. email_levelявляется int. Аргумент email_level использует те же значения, что и eventlog_level.

• [ @notify_level_netsend =] netsend_level
  Указывает, нужно ли отправить сетевое сообщение по завершении этого задания. netsend_levelявляется int. Аргумент netsend_levelиспользует те же значения, что и eventlog_level.

• [ @notify_level_page =] page_level
  Указывает, необходимо ли отправить страницу по завершении этого задания. page_levelявляется int. Аргумент page_level использует те же значения, что и eventlog_level.

• [ @notify_email_operator_name =] 'operator_name'
  Имя оператора, которому отправляется сообщение электронной почты, если достигнут уровень email_level. Аргумент email_name имеет тип nvarchar(128).

• [ @notify_netsend_operator_name =] 'netsend_operator'
  Имя оператора, которому отправляется сетевое сообщение. Аргумент netsend_operator имеет тип nvarchar(128).

• [ @notify_page_operator_name =] 'page_operator'
  Имя оператора, которому отправляется страница. Аргумент page_operator имеет тип nvarchar(128).

• [ @delete_level =] delete_level
  Указывает, когда необходимо удалить задание. delete_valueявляется int. Аргумент delete_level использует те же значения, что и eventlog_level.

• [ @automatic_post =] automatic_post
  Зарезервировано.

Значения кода возврата

0 (успешное завершение) или 1 (неуспешное завершение)

Замечания

Процедура sp_update_job должна запускаться из базы данных msdb.

Процедура sp_update_job изменяет только те установки, для которых предоставляются значения параметров. Если параметр пропущен, сохраняется текущая настройка.

Разрешения

По умолчанию эту хранимую процедуру могут выполнять только члены предопределенной роли сервера sysadmin. Другим пользователям должна быть предоставлена одна из следующих предопределенных ролей базы данных агента SQL Server в базе данных msdb.

• SQLAgentUserRole

• SQLAgentReaderRole

• SQLAgentOperatorRole.

Дополнительные сведения о разрешениях для этих ролей см. в разделе Предопределенные роли базы данных агента SQL Server.

Использовать эту хранимую процедуру для редактирования атрибутов заданий, владельцами которых являются другие пользователи, могут только члены роли sysadmin.

Примеры

В следующем примере изменяются имя, описание и включенное состояние задания NightlyBackups.

USE msdb ;
GO

EXEC dbo.sp_update_job
    @job_name = N'NightlyBackups',
    @new_name = N'NightlyBackups -- Disabled',
    @description = N'Nightly backups disabled during server migration.',
    @enabled = 0 ;
GO

См. также

Справочник

sp_add_job (Transact-SQL)

sp_delete_job (Transact-SQL)

sp_help_job (Transact-SQL)

Системные хранимые процедуры (Transact-SQL)