sp_add_maintenance_plan (Transact-SQL)

適用対象: SQL Server

メンテナンス プランを追加し、プラン ID を返します。

Note

このストアド プロシージャは、データベース メンテナンス プランで使用されます。 この機能は、このストアド プロシージャを使用しないメンテナンス プランに置き換えられました。 以前のバージョンの SQL Server からアップグレードされたインストールでデータベース メンテナンス プランを維持するには、次の手順に従います。

この機能は、 SQL Serverの将来のバージョンで削除される予定です。 新規の開発作業ではこの機能を使用しないようにし、現在この機能を使用しているアプリケーションは修正することを検討してください。

Transact-SQL 構文表記規則

構文

sp_add_maintenance_plan
    [ @plan_name = ] 'plan_name'
    , [ @plan_id = ] 'plan_id' OUTPUT
[ ; ]

引数

[ @plan_name = ] N'plan_name'

追加するメンテナンス プランの名前を指定します。 @plan_name は varchar(128)です。

[ @plan_id = ] N'plan_id' OUTPUT

メンテナンス プランの ID を指定します。 @plan_id は uniqueidentifierです。

リターン コードの値

0 (成功) または 1 (失敗)。

解説

sp_add_maintenance_plan は、 msdb データベースから実行し、新しい (空の) メンテナンス プランを作成する必要があります。 1 つ以上のデータベースを追加し、それらをジョブまたはジョブに関連付けるには、 sp_add_maintenance_plan_db と sp_add_maintenance_plan_jobを実行します。

アクセス許可

このストアド プロシージャは、 db_owner ロールによって所有されています。 EXECUTEアクセス許可は任意のユーザーに付与できますが、SQL Server のアップグレード中にこれらのアクセス許可がオーバーライドされる可能性があります。

例

MyPlanと呼ばれるメンテナンス プランを作成します。

DECLARE @myplan_id UNIQUEIDENTIFIER;

EXECUTE sp_add_maintenance_plan
    @plan_name = N'MyPlan',
    @plan_id = @myplan_id OUTPUT

PRINT 'The ID for the maintenance plan "MyPlan" is:' + convert(VARCHAR(256), @myplan_id);
GO

メンテナンス プランの作成に成功すると、プラン ID が返されます。

The ID for the maintenance plan "MyPlan" is: FAD6F2AB-3571-11D3-9D4A-00C04FB925FC

関連するコンテンツ

• メンテナンス プラン
• データベース メンテナンス プランストアド プロシージャ (Transact-SQL)