sp_procoption (Transact-SQL)

  • Статья

Задает или отменяет хранимую процедуру для автоматического запуска. Хранимая процедура настроена на выполнение при каждом запуске экземпляра SQL Server.

Значок ссылки на раздел Синтаксические обозначения в Transact-SQL

Синтаксис

sp_procoption [ @ProcName = ] 'procedure' 
    , [ @OptionName = ] 'option' 
    , [ @OptionValue = ] 'value'

Аргументы

  • [ @ProcName = ] 'procedure'
    Имя процедуры, для которой устанавливается автовыполнение. Аргумент procedure имеет тип nvarchar(776) и не имеет значения по умолчанию.

  • [ @OptionName = ] 'option'
    Имя устанавливаемого параметра. Единственное возможное значение аргумента option — startup.

  • [ @OptionValue = ] 'value'
    Указывает, включать ли данный аргумент (true или on) или отключать (false или off). Аргумент value имеет тип varchar(12) и не имеет значения по умолчанию.

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

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

Замечания

Процедуры автозапуска должны находиться в базе данных master и не могут содержать входных (INPUT) или выходных (OUTPUT) параметров. Выполнение хранимых процедур начинается после восстановления всех баз данных и регистрации сообщения «Восстановление завершено» во время начального запуска.

Разрешения

Необходимо членство в предопределенной роли сервера sysadmin.

Примеры

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

EXEC sp_procoption @ProcName = '<procedure name>' 
    , @OptionName = ] 'startup' 
    , @OptionValue = 'on';

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

EXEC sp_procoption @ProcName = '<procedure name>' 
    , @OptionValue = 'off';

См. также

Основные понятия

Выполнение хранимой процедуры