sp_create_plan_guide_from_handle (Transact-SQL)

[アーティクル]
07/17/2024

適用対象: SQL Server

プランキャッシュ内のクエリプランから 1 つ以上のプランガイドを作成します。このストアドプロシージャを使用すると、クエリオプティマイザーで、指定したクエリに対して特定のクエリプランが常に使用されるようにすることができます。プランガイドの詳細については、「 Plan Guides」を参照してください。

Transact-SQL 構文表記規則

構文

sp_create_plan_guide_from_handle
    [ @name = ] N'name'
    , [ @plan_handle = ] plan_handle
    [ , [ @statement_start_offset = ] statement_start_offset ]
[ ; ]

引数

[ @name = ] N'name'

プランガイドの名前。 @name は sysname で、既定値はありません。プランガイド名は現在のデータベースに対して有効です。 @name識別子の規則に従う必要があり番号記号 (#) で始めることはできません。 @nameの最大長は 124 文字です。

[ @plan_handle = ] plan_handle

プランキャッシュのバッチを識別します。 @plan_handle は varbinary(64)で、既定値はありません。 @plan_handle は、 sys.dm_exec_query_stats 動的管理ビューから取得できます。

[ @statement_start_offset = ] statement_start_offset

指定した @plan_handleのバッチ内でのステートメントの開始位置を識別します。 @statement_start_offset は int で、既定値は NULL です。

ステートメントオフセットは、sys.dm_exec_query_stats動的管理ビューのstatement_start_offset列に対応します。

NULLが指定されているか、ステートメントオフセットが指定されていない場合、指定されたプランハンドルのクエリプランを使用して、バッチ内の各ステートメントに対してプランガイドが作成されます。結果のプランガイドは、 USE PLAN クエリヒントを使用して特定のプランを強制的に使用するプランガイドと同じです。

解説

プランガイドは、すべてのステートメントの種類に対して作成することはできません。バッチ内のステートメントに対してプランガイドを作成できない場合、ストアドプロシージャはステートメントを無視し、バッチ内の次のステートメントに進みます。同じバッチ内でステートメントが複数回発生した場合、最後に発生したステートメントのプランが有効になり、ステートメントの以前のプランが無効になります。プランガイドでバッチ内のステートメントを使用できない場合、エラー 10532 が発生し、ステートメントは失敗します。このエラーの可能性を回避するには、常に sys.dm_exec_query_stats 動的管理ビューからプランハンドルを取得することをお勧めします。

重要

sp_create_plan_guide_from_handle は、プランキャッシュに表示されるプランに基づいてプランガイドを作成します。つまり、バッチテキスト、Transact-SQL ステートメント、XML プラン表示は、プランキャッシュから結果のプランガイドに文字ごとに取得されます (クエリに渡されるリテラル値を含む)。これらのテキスト文字列には、データベースのメタデータに格納される機密情報を含めることができます。適切なアクセス許可を持つユーザーは、SQL Server Management Studio の sys.plan_guides カタログビューと Plan Guide Properties ダイアログボックスを使用して、この情報を表示できます。機密情報がプランガイドを通じて開示されないようにするには、プランキャッシュから作成されたプランガイドを確認することをお勧めします。

クエリプラン内の複数のステートメントのプランガイドを作成する

sp_create_plan_guideと同様に、sp_create_plan_guide_from_handleは、対象のバッチまたはモジュールのクエリプランをプランキャッシュから削除します。これは、新しいプランガイドがすべてのユーザーによって使用されるようにするための措置です。 1 つのクエリプラン内で複数のステートメントのプランガイドを作成する場合は、明示的なトランザクションですべてのプランガイドを作成することで、キャッシュからのプランの削除を延期できます。これにより、そのトランザクションが完了して、指定した各ステートメントのプランガイドが作成されるまで、プランがキャッシュに保持されます。例 B を参照してください。

アクセス許可

VIEW SERVER STATE 権限が必要です。また、 sp_create_plan_guide_from_handleを使用して作成されるプランガイドごとに、個々のアクセス許可が必要です。 OBJECT型のプランガイドを作成するには、参照先オブジェクトALTERアクセス許可が必要です。 SQLまたはTEMPLATEの種類のプランガイドを作成するには、現在のデータベースALTERアクセス許可が必要です。作成されるプランガイドの種類を確認するには、次のクエリを実行します。

SELECT cp.plan_handle,
    sql_handle,
    st.text,
    objtype
FROM sys.dm_exec_cached_plans AS cp
INNER JOIN sys.dm_exec_query_stats AS qs
    ON cp.plan_handle = qs.plan_handle
CROSS APPLY sys.dm_exec_sql_text(sql_handle) AS st;

プランガイドを作成するステートメントを含む行で、結果セットの objtype 列を調べます。 Procの値は、プランガイドが OBJECT 型であることを示します。 Ad hocやPreparedなどのその他の値は、プランガイドが SQL 型であることを示します。

例

A. プランキャッシュ内のクエリプランからプランガイドを作成する

次の例では、プランキャッシュからクエリプランを指定して、単一の SELECT ステートメントのプランガイドを作成します。まず、プランガイドを作成する単純な SELECT ステートメントを実行します。次に、動的管理ビューの sys.dm_exec_sql_text および sys.dm_exec_text_query_plan を使用してこのクエリのプランを調べます。その後、クエリに関連付けられているプランキャッシュ内のクエリプランを指定することで、クエリのプランガイドが作成されます。この例の最後のステートメントは、プランガイドが存在することを確認します。

USE AdventureWorks2022;
GO

SELECT WorkOrderID,
    p.Name,
    OrderQty,
    DueDate
FROM Production.WorkOrder AS w
INNER JOIN Production.Product AS p
    ON w.ProductID = p.ProductID
WHERE p.ProductSubcategoryID > 4
ORDER BY p.Name, DueDate;
GO

-- Inspect the query plan by using dynamic management views.
SELECT *
FROM sys.dm_exec_query_stats AS qs
CROSS APPLY sys.dm_exec_sql_text(sql_handle)
CROSS APPLY sys.dm_exec_text_query_plan(
    qs.plan_handle, qs.statement_start_offset,
    qs.statement_end_offset
) AS qp
WHERE TEXT LIKE N'SELECT WorkOrderID, p.Name, OrderQty, DueDate%';
GO

-- Create a plan guide for the query by specifying the query plan in the plan cache.
DECLARE @plan_handle VARBINARY(64);
DECLARE @offset INT;

SELECT @plan_handle = plan_handle,
    @offset = qs.statement_start_offset
FROM sys.dm_exec_query_stats AS qs
CROSS APPLY sys.dm_exec_sql_text(sql_handle) AS st
CROSS APPLY sys.dm_exec_text_query_plan(
    qs.plan_handle, qs.statement_start_offset,
    qs.statement_end_offset
) AS qp
WHERE text LIKE N'SELECT WorkOrderID, p.Name, OrderQty, DueDate%';

EXECUTE sp_create_plan_guide_from_handle @name = N'Guide1',
    @plan_handle = @plan_handle,
    @statement_start_offset = @offset;
GO

-- Verify that the plan guide is created.
SELECT *
FROM sys.plan_guides
WHERE scope_batch LIKE N'SELECT WorkOrderID, p.Name, OrderQty, DueDate%';
GO

B. 複数の状態バッチの複数のプランガイドを作成する

次の例では、複数ステートメントバッチ内に 2 つのステートメントのプランガイドを作成します。プランガイドは、最初のプランガイドの作成後にバッチのクエリプランがプランキャッシュから削除されないように、明示的なトランザクション内に作成されます。まず、複数のステートメントで構成されるバッチを実行します。バッチの計画は、動的管理ビューを使用して調べられます。バッチ内の各ステートメントの行が返されます。その後、 @statement_start_offset パラメーターを指定して、バッチ内の最初と 3 番目のステートメントのプランガイドが作成されます。この例の最後のステートメントは、プランガイドが存在することを確認します。

USE AdventureWorks2022;
GO
SELECT * FROM Production.Product WHERE ProductSubcategoryID > 4;
SELECT * FROM Person.Address;
SELECT * FROM Production.Product WHERE ProductSubcategoryID > 10;
GO

-- Examine the query plans for this batch
SELECT * FROM sys.dm_exec_query_stats AS qs
CROSS APPLY sys.dm_exec_sql_text(sql_handle)
CROSS APPLY sys.dm_exec_text_query_plan(qs.plan_handle, qs.statement_start_offset, qs.statement_end_offset) AS qp
WHERE text LIKE N'SELECT * FROM Production.Product WHERE ProductSubcategoryID > 4%';
GO

-- Create plan guides for the first and third statements in the batch by specifying the statement offsets.
BEGIN TRANSACTION

DECLARE @plan_handle varbinary(64);
DECLARE @offset int;

SELECT @plan_handle = plan_handle, @offset = qs.statement_start_offset
FROM sys.dm_exec_query_stats AS qs
CROSS APPLY sys.dm_exec_sql_text(sql_handle) AS st
CROSS APPLY sys.dm_exec_text_query_plan(qs.plan_handle, qs.statement_start_offset, qs.statement_end_offset) AS qp
WHERE text LIKE N'SELECT * FROM Production.Product WHERE ProductSubcategoryID > 4%'
AND SUBSTRING(st.text, (qs.statement_start_offset/2) + 1,
                        ((CASE statement_end_offset 
                              WHEN -1 THEN DATALENGTH(st.text)
                              ELSE qs.statement_end_offset END 
                              - qs.statement_start_offset)/2) + 1)  like 'SELECT * FROM Production.Product WHERE ProductSubcategoryID > 4%'

EXECUTE sp_create_plan_guide_from_handle 
    @name =  N'Guide_Statement1_only',
    @plan_handle = @plan_handle,
    @statement_start_offset = @offset;

SELECT @plan_handle = plan_handle, @offset = qs.statement_start_offset
FROM sys.dm_exec_query_stats AS qs
CROSS APPLY sys.dm_exec_sql_text(sql_handle) AS st
CROSS APPLY sys.dm_exec_text_query_plan(qs.plan_handle, qs.statement_start_offset, qs.statement_end_offset) AS qp
WHERE text LIKE N'SELECT * FROM Production.Product WHERE ProductSubcategoryID > 4%'
AND SUBSTRING(st.text, (qs.statement_start_offset/2) + 1,
                        ((CASE statement_end_offset 
                              WHEN -1 THEN DATALENGTH(st.text)
                              ELSE qs.statement_end_offset END 
                              - qs.statement_start_offset)/2) + 1)  like 'SELECT * FROM Production.Product WHERE ProductSubcategoryID > 10%'

EXECUTE sp_create_plan_guide_from_handle 
    @name =  N'Guide_Statement3_only',
    @plan_handle = @plan_handle,
    @statement_start_offset = @offset;

COMMIT TRANSACTION
GO

-- Verify the plan guides are created.
SELECT * FROM sys.plan_guides;
GO

次の方法で共有

sp_create_plan_guide_from_handle (Transact-SQL)

構文

引数

[ @name = ] N'name'

[ @plan_handle = ] plan_handle

[ @statement_start_offset = ] statement_start_offset

解説

クエリプラン内の複数のステートメントのプランガイドを作成する

アクセス許可

例

A. プランキャッシュ内のクエリプランからプランガイドを作成する

B. 複数の状態バッチの複数のプランガイドを作成する

フィードバック

その他のリソース

次の方法で共有

sp_create_plan_guide_from_handle (Transact-SQL)

構文

引数

[ @name = ] N'name'

[ @plan_handle = ] plan_handle

[ @statement_start_offset = ] statement_start_offset

解説

クエリ プラン内の複数のステートメントのプラン ガイドを作成する

アクセス許可

例

A. プラン キャッシュ内のクエリ プランからプラン ガイドを作成する

B. 複数の状態バッチの複数のプラン ガイドを作成する

関連するコンテンツ

フィードバック

その他のリソース

クエリプラン内の複数のステートメントのプランガイドを作成する

A. プランキャッシュ内のクエリプランからプランガイドを作成する

B. 複数の状態バッチの複数のプランガイドを作成する