フルテキストインデックスのキーワードごとのドキュメントの一覧を出力する：SQL Server動的管理ビューレファレンス（96）

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

[伊東敏章，＠IT]

SQL Server動的管理ビュー一覧

　本連載では、「Microsoft SQL Server（以下、SQL Server）」で使用可能な動的管理ビューについて、動作概要や出力内容などを紹介していきます。今回は動的管理ビュー「sys.dm_fts_index_keywords_by_document」における、フルテキストインデックスのキーワードごとのドキュメントの一覧を出力する方法について解説します。対応バージョンは、SQL Server（サポートされている全てのバージョン）です。

概要

　SQL Serverではフルテキスト検索の機能を使用して、英語や日本語など、特定の言語の規則に基づいた言語検索を実行できます。フルテキスト関数を使用して大量のテキストデータを対象として検索する場合、全文検索をするLIKE句と比較して高速に実行できます。フルテキスト検索では、フォーマットされたバイナリデータ（Microsoft Wordドキュメントなど）を対象とすることもできます。

　フルテキスト検索を使用するには、SQL Serverインスタンスに「検索のためのフルテキスト抽出とセマンティック抽出」機能を追加する必要があります。また、データベースにフルテキストカタログを作成し、対象のテーブルに対してフルテキストインデックスを作成する必要があります。

　「sys.dm_fts_index_keywords_by_document」動的管理関数を使用することで、フルテキストインデックスに含まれるキーワードごとに、そのキーワードを含むドキュメントの一覧を出力できます。

• sys.dm_fts_index_keywords_by_document（Transact-SQL）

構文と引数

構文　sys.dm_fts_index_keywords_by_document(database_id, object_id)

列名	データ型	説明
database_id	int	対象のデータベースID DB_ID関数を使用することで、データベース名からデータベースIDを取得できる
object_id	int	対象のテーブルのオブジェクトID OBJECT_ID関数を使用することで、テーブル名からオブジェクトIDを取得できる

出力内容

列名	データ型	説明
keyword	nvarchar（4000）	キーワードの16進数表現 ※0xFFは、ファイルまたはデータセットの末尾を示す
display_term	nvarchar（4000）	キーワードの人間が判読できる形式 ※※「END OF FILE」は、ファイルまたはデータセットの末尾を示す
column_id	int	このキーワードが作成された列のID
document_id	int	このキーワードを含んでいるドキュメントまたは行のID。ドキュメントまたは行のフルテキストキー値に対応する
occurrence_count	int	このキーワードを含んでいたドキュメントまたは行での、このキーワードの出現回数

動作例

　テーブルの複数の列を対象としたフルテキストインデックスを作成し、テスト用にデータを追加しました（図1）。

図1　既定のフルテキストカタログにフルテキストインデックスを追加したところ

　次に、作成したテーブルを対象として「sys.dm_fts_index_keywords_by_document」動的管理関数を出力します（図2）。

図2　キーワードごとに、キーワードを含むドキュメントと出現回数の一覧が出力された

　引数として必要なデータベースIDとテーブルのオブジェクトIDは、DB_ID関数とOBJECT_ID関数で取得しました。

　テーブルに作成されたフルテキストインデックスのキーワードの一覧と、そのキーワードを含むドキュメントのキーインデックス値、キーワードの出現回数が出力されました。

　出力された結果を確認すると、句読点がキーワードに含まれないことや、「今日」と「今日は」が区別されていそうなことが分かります（図3）。

図3　「今日」をキーワードとして検索しても「今日は」を含むデータは検索されなかった

　「sys.dm_fts_index_keywords_by_document」動的管理関数をフルテキスト検索クエリで直接使用することはありませんが、このようにフルテキスト検索のキーワードの扱いの確認や、意図した結果が検索されないときの原因追及などの用途に使用できそうです。

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

筆者紹介

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

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

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

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