FILESTREAMハンドルの一覧を出力する：SQL Server動的管理ビューレファレンス（90）

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

[伊東敏章，＠IT]

SQL Server動的管理ビュー一覧

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

概要

　SQL ServerではFILESTREAMの機能を使用することで、非構造化データ（ドキュメントやイメージなど）をファイルシステムに格納できます。FILESTREAMの機能によって、ファイルシステムのストリーミングAPIをアプリケーションで活用できるほか、非構造化データとそれに対応する構造化データの間でトランザクションの一貫性を維持できます。

　FILESTREAMの機能を使用するためには、SQL ServerインスタンスでFILESTREAM機能を有効化して、データベースやテーブルをFILESTREAMデータを格納できるように構成する必要があります。

　FILESTREAMを使用する際には、T-SQLを使用してFILESTREAMデータの論理パスを取得後に、アプリケーションからOpenSqlFilestream APIを使用してFILESTREAMハンドルを作成すると、ファイルシステムのストリーミングAPIによりFILESTREAMデータにアクセスできるようになります。

　「sys.dm_filestream_file_io_handles」動的管理ビューでは、OpenSqlFilestream APIを使用して作成されているFILESTREAMハンドルの情報の一覧を出力できます。

• sys.dm_filestream_file_io_handles（Transact-SQL）

出力内容

列名	データ型	説明
handle_context_address	varbinary（8）	ハンドルに関連付けられた内部構造体のアドレス
creation_request_id	int	ハンドルの作成に使用されたREQ_PRE_CREATE I/O要求のフィールド
creation_irp_id	int	ハンドルの作成に使用されたREQ_PRE_CREATE I/O要求のフィールド
handle_id	int	ドライバによって割り当てられたハンドルの一意のID
creation_client_thread_id	varbinary（8）	ハンドルの作成に使用されたREQ_PRE_CREATE I/O要求のフィールド
creation_client_process_id	varbinary（8）	ハンドルの作成に使用されたREQ_PRE_CREATE I/O要求のフィールド
filestream_transaction_id	varbinary（128）	ハンドルに関連付けられているトランザクションのID 「get_filestream_transaction_context」関数によって返された値
access_type	nvarchar（60）	ファイルを開くときに指定されたアクセスモード
logical_path	nvarchar（256）	このハンドルによって開かれたファイルの論理パス名
physical_path	nvarchar（256）	ファイルの実際のNTFSパス名

動作例

　FILESTREAM機能を使用するために、SQL ServerインスタンスでFILESTREAMを有効化します（図1、図2）。

図1　SQL Server構成マネージャーからFILESTREAMが有効化されていることを確認できる

図2　サーバ構成オプションからFILESTREAMアクセスレベルの変更を行った

　次に、FILESTREAMが有効なデータベースと、FILESTREAMデータを格納するテーブルを作成します（図3、図4）。

図3　FILESTREAMデータをデータベースに追加した

図4　FILESTREAMデータを格納するテーブルを作成してサンプルデータを追加した

　T-SQLでトランザクションを開始してFILESTREAMデータの変更を行い、トランザクションのコミット前に「sys.dm_filestream_file_io_handles」動的管理ビューを出力します（図5）。

図5　T-SQLからのアクセスではFILESTREAMハンドルは作成されなかった

　結果は何も表示されませんでしたので、T-SQLでFILESTREAMデータの変更を行ってもFILESTREAMハンドルは作成されないようです。

　次に、クライアントアプリケーションからOpenSqlFilestream API を使用してFILESTREAMデータの変更を行い、「sys.dm_filestream_file_io_handles」動的管理ビューを出力すると、FILESTREAMハンドルの情報が表示されました（図6、図7）。

図6　PowerShellでSqlFileStreamクラスを使用してFILESTREAMデータにアクセスしたところ

図7　「sys.dm_filestream_file_io_handles」動的管理ビューを出力した

　OpenSqlFilestream APIのパラメーターに指定したGET_FILESTREAM_TRANSACTION_CONTEXT（）で取得した値と、「filestream_transaction_id」列の値は一致するようです。FILESTREAM.Pathname（）で取得した値と「logical_path」列の値は完全には一致しませんでした。FILESTREAM.Pathname（）で取得した値には共有名が含まれていますが、「logical_path」列の値は共有名を含まない論理パスだけが表示されるようです（図8）。

図8　OpenSqlFilestream APIのパラメーターに指定した値を出力したところ

　また、FILESTREAM.PhysicalPathname（）関数とは異なり、「physical_path」列の値の出力にトレースフラグ「5556」は不要のようでした。

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

筆者紹介

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

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

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

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