解析済みXMLドキュメントのハンドル一覧を取得する：SQL Server動的管理ビューレファレンス（78）

「Microsoft SQL Server」が稼働するデータベースシステムを運用する管理者に向け、「動的管理ビュー」の活用を軸にしたトラブル対策のためのノウハウを紹介していきます。今回は、解析済みXMLドキュメントのハンドル一覧を取得する方法について解説します。

[伊東敏章，＠IT]

SQL Server動的管理ビュー一覧

　本連載では、「Microsoft SQL Server（以下、SQL Server）」で使用可能な動的管理ビューについて、動作概要や出力内容などを紹介していきます。今回は動的管理ビュー「sys.dm_exec_xml_handles」における、解析済みXMLドキュメントのハンドル一覧を取得する方法について解説します。対応バージョンは、SQL Serverです。

概要

　SQL Serverでは、OPENXML関数を使用して、XMLドキュメントから行セットビューを取得できます。OPENXML 関数を使用するには、事前に「sp_xml_preparedocument」ストアドプロシージャを使用して、XMLドキュメントから解析済みXMLドキュメントを作成する必要があります。

　解析済みXMLドキュメントは、「sp_xml_removedocument」ストアドプロシージャにより解放するか、作成したセッションが終了するまで有効です。

　「sys.dm_exec_xml_handles」動的管理関数を使用することで、サーバ全体、もしくは指定したセッションでの、解析済みのXMLドキュメントのハンドルや作成情報、使用情報などの一覧を取得することが可能です。

• sys.dm_exec_xml_handles（TRANSACT-SQL）

構文と引数

構文　dm_exec_xml_handles (session_id | 0 )

引数	データ型	説明
session_id | 0	int	対象のセッションのID 「0」の場合、全てのセッションが対象

出力内容

列名	データ型	説明
session_id	int	このXMLドキュメントを保持しているセッションID
document_id	int	XMLドキュメントのハンドル「sp_xml_preparedocument」によって返されるID
namespace_document_id	int	「sp_xml_preparedocument」の第3パラメーターとして渡された名前空間の内部ハンドル 名前空間が指定されていない場合は「NULL」
sql_handle	varbinary（64）	このXMLドキュメントが作成された「sp_xml_preparedocument」呼び出しのSQLテキストのハンドル 「sys.dm_exec_sql_text」動的管理関数によりテキストを取得できる
statement_start_offset	int	このXMLドキュメントが作成されたSQLテキスト中での「sp_xml_preparedocument」呼び出しステートメントの開始オフセット
statement_end_offset	int	このXMLドキュメントが作成されたSQLテキスト中での「sp_xml_preparedocument」呼び出しステートメントの終了オフセット
creation_time	datetime	「sp_xml_preparedocument」が呼び出された時刻
original_document_size_bytes	bigint	解析前のXMLドキュメントのサイズ（バイト単位）
original_namespace_document_size_bytes	bigint	解析前のXML名前空間ドキュメントのサイズ（バイト単位） 名前空間がない場合は「NULL」
num_openxml_calls	bigint	このドキュメントハンドルを指定したOPENXML関数の実行回数
row_count	bigint	このドキュメントハンドルを指定して実行されたOPENXML関数で返された行の総数
dormant_duration_ms	bigint	最後にOPENXMLが呼び出されてから経過したミリ秒数 OPENXMLが呼び出されていない場合は「sp_xml_preparedocument」呼び出しからのミリ秒数

動作例

　解析済みのXMLドキュメントを「sp_xml_preparedocument」ストアドプロシージャにより準備し、OPENXML関数を実行しました（図1）。

図1　OPENXML関数を使用することで、XMLドキュメントを行セットとして扱うことができる

　「sp_xml_removedocument」ストアドプロシージャを実行していないため、解析済みXMLドキュメントは解放されていません。

　次に、「sys.dm_exec_xml_handles」動的管理関数を実行します（図2）。

図2　全てのセッションの解析済みXMLドキュメントの一覧情報を出力したところ

　対象のセッションIDに「0」を指定したため、全セッションの解析済みXMLドキュメントの一覧情報が出力されました。呼び出し回数や作成、OPENXML実行からの経過時間などの情報が確認できます。

　「sql_handle」列を使用することで、対象のXMLドキュメントを準備した際のクエリ全体も確認できました（図3）。

図3　「sys.dm_exec_sql_text」動的管理関数と組み合わせることでクエリを確認できる

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

筆者紹介

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

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

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

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