バッチの実行プランをXML形式で出力する：SQL Server動的管理ビューレファレンス（64）

「Microsoft SQL Server」が稼働するデータベースシステムを運用する管理者に向け、「動的管理ビュー」の活用を軸にしたトラブル対策のためのノウハウを紹介していきます。今回は、バッチの実行プランをXML形式で出力する方法について解説します。

[伊東敏章，＠IT]

SQL Server動的管理ビュー一覧

　本連載では、「Microsoft SQL Server（以下、SQL Server）」で使用可能な動的管理ビューについて、動作概要や出力内容などを紹介していきます。今回は動的管理ビュー「sys.dm_exec_query_plan」における、バッチの実行プランをXML形式で出力する方法について解説します。対応バージョンは、SQL Server（サポートされている全てのバージョン）です。

概要

　SQL Serverでクエリを実行する際には、クエリ文や統計情報を使用してコンパイル処理が実行され、コンパイル結果は「実行プラン」としてプランキャッシュに保存されます。次回以降の実行では、コンパイル前にプランキャッシュが確認され、実行プランが保存されている場合にはコンパイルは行われません。

　実行プランには、クエリの実行時にテーブルやインデックスをどのように使用するか、どのようにデータを結合するか、どういった計算を行うのかなどの情報が、どのような流れで処理するかも含めて記録されています。また、コンパイル時に計算されたコスト情報やデータ量の推測などの情報も含まれています。

　「sys.dm_exec_query_plan」動的管理関数を使用することで、実行プランをXML形式で出力できます。

　XML形式の実行プランは、SQL Server Management Studio（SSMS）を使用することで、グラフィカルに表示することや、他の実行プランと画面上で比較することが可能です。

• sys.dm_exec_query_plan（Transact-SQL）

構文と引数

構文　sys.dm_exec_query_plan(plan_handle)

列名	データ型	説明
plan_handle	varbinary（64）	実行プランを一意に識別する識別子 実行プランがプランキャッシュ内に存在するか、現在実行されている必要がある 次の動的管理オブジェクトから取得できる 　・sys.dm_exec_cached_plans（Transact-SQL） 　・sys.dm_exec_query_stats（Transact-SQL） 　・sys.dm_exec_requests（Transact-SQL） 　・sys.dm_exec_procedure_stats（Transact-SQL） 　・sys.dm_exec_trigger_stats（Transact-SQL）

出力内容

列名	データ型	説明
dbid	smallint	ステートメントがコンパイルされたデータベースのID
objectid	int	この実行プランのオブジェクトのID アドホックおよび準備されたバッチでは「NULL」
number	smallint	番号付きストアドプロシージャに付けられた番号（整数） アドホックおよび準備されたバッチでは「NULL」
encrypted	bit	対応するストアドプロシージャが暗号化されているかどうか 　「0」＝暗号化されていない 　「1」＝暗号化されている
query_plan	xml	この実行プランのコンパイル時のXML形式のプラン表示 アドホックバッチやストアドプロシージャの呼び出し、ユーザー定義関数の呼び出しに含まれているTransact-SQLステートメントごとに1つのプランが生成される

動作例

　SSMSで、動作確認用に作成したクエリを実行しました（図1）。

図1　実行プランを出力する対象のクエリを実行したところ

　「sys.dm_exec_query_plan」動的管理関数を使用してクエリの実行プランを取得するには、クエリ実行に使用された実行プランのプランハンドルが必要です。

　今回は、プランキャッシュに記録されているクエリの実行情報を出力できる「sys.dm_exec_query_stats」動的管理ビューと、ステートメントのテキスト情報を出力できる「sys.dm_exec_sql_text」動的管理関数を「sys.dm_exec_query_plan」動的管理関数と組み合わせることで、クエリテキストと併せて実行プランの情報を出力しました（図2）。

図2　クエリテキストに続いて「sys.dm_exec_query_plan」動的管理関数の情報を出力したところ

　動作確認用クエリの実行直前に「DBCC FREEPROCCACHE」コマンドを実行し、プランキャッシュをクリアしましたので他のクエリの情報は表示されていません。

　出力された情報はXML形式のテキストです。SSMSはXML形式の実行プランのグラフィカルな表示に対応しており、画面に表示されたXML形式の実行プランのテキストをクリックすることで、グラフィカルな画面を表示できます（図3）。

図3　「query_plan」列のリンクをクリックすると、別のタブでグラフィカルに実行プランが表示される

　この実行プランは、右クリックのメニューなどから保存することで、後からSSMSで画面に表示することも可能です。

図4　「実行プランに名前を付けて保存」を選択することで拡張子「.sqlplan」で保存できる

　「sys.dm_exec_query_plan」動的管理関数や「sys.dm_exec_query_stats」動的管理ビューでクエリや実行プランの情報を出力するには、プランキャッシュに実行プランが残っている必要があります。メモリの少ない環境だと、すぐにキャッシュから削除されてしまう場合があるため注意が必要です。

※本Tipsは、「Windows Server 2019」上に「SQL Server 2019 RC1」をインストールした環境を想定して解説しています。

筆者紹介

椎名 武史（しいな たけし）

日本ユニシス株式会社所属。Microsoft MVP for Data Platform（2017〜）。入社以来 SQL Serverの評価／設計／構築／教育などに携わりながらも、主にサポート業務に従事。SQL Serverのトラブル対応で社長賞の表彰を受けた経験も持つ。休日は学生時代の仲間と市民駅伝に参加し、銭湯で汗を流してから飲み会へと流れる。

伊東 敏章（いとう としあき）

日本ユニシス株式会社所属。入社以来SQL Server一筋で評価／設計／構築／教育などに携わりながらも、主にサポート業務に従事。社内のプログラミングコンテストで4回の優勝経験も持つ。趣味は輪行で週末は自転車を持っての旅行。目標は色々な日本百選を制覇すること。