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';

関連項目

概念

ストアド プロシージャの実行