sp_procoption (Transact-SQL)

2025-06-23

Область применения: SQL Server

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

Соглашения о синтаксисе Transact-SQL

Синтаксис

sys.sp_procoption
    [ @ProcName = ] N'ProcName'
    , [ @OptionName = ] 'OptionName'
    , [ @OptionValue = ] 'OptionValue'
[ ; ]

Аргументы

[ @ProcName = ] N'ProcName'

Имя процедуры, для которой необходимо задать параметр. @ProcName — nvarchar(776), без значения по умолчанию.

[ @OptionName = ] 'OptionName'

Имя задаваемого параметра. @OptionName является varchar(35), и единственное startupвозможное значение.

[ @OptionValue = ] 'OptionValue'

Установка параметра (true или) или onвыключения (false или off). @OptionValue — varchar(12), без значения по умолчанию.

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

0 (успешно) или номер ошибки (сбой).

Замечания

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

Разрешения

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

Примеры

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

EXECUTE sp_procoption
    @ProcName = N'<procedure name>',
    @OptionName = 'startup',
    @OptionValue = 'on';

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

EXECUTE sp_procoption
    @ProcName = N'<procedure name>',
    @OptionName = 'startup',
    @OptionValue = 'off';

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