Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 2.41 KB

sp-procoption-transact-sql.md

File metadata and controls

83 lines (58 loc) · 2.41 KB
title description author ms.author ms.reviewer ms.date ms.service ms.subservice ms.topic f1_keywords helpviewer_keywords dev_langs
sp_procoption (Transact-SQL)
sp_procoption sets or clears a stored procedure for automatic execution.
markingmyname
maghan
randolphwest
10/26/2023
sql
system-objects
reference
sp_procoption
sp_procoption_TSQL
sp_procoption
TSQL

sp_procoption (Transact-SQL)

[!INCLUDE SQL Server]

Sets or clears a stored procedure for automatic execution. A stored procedure that is set to automatic execution runs every time an instance of [!INCLUDE ssNoVersion] is started.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

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

Arguments

[ @ProcName = ] N'ProcName'

The name of the procedure for which to set an option. @ProcName is nvarchar(776), with no default.

[ @OptionName = ] 'OptionName'

The name of the option to set. @OptionName is varchar(35), and the only value possible is startup.

[ @OptionValue = ] 'OptionValue'

Whether to set the option on (true or on) or off (false or off). @OptionValue is varchar(12), with no default.

Return code values

0 (success) or error number (failure).

Remarks

Startup procedures must be in the dbo schema of the master database, and can't contain INPUT or OUTPUT parameters. Execution of the stored procedures starts when all databases are recovered and the "Recovery is completed" message is logged at startup.

Permissions

Requires membership in the sysadmin fixed server role.

Examples

The following example sets a procedure for automatic execution.

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

The following example stops a procedure from executing automatically.

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

Related content