FILE_IDEX (Transact-SQL)

適用対象:SQL ServerAzure SQL Managed Instance

この関数は、指定された現在のデータベースのデータ、ログ、フルテキスト ファイルの論理名に対する、ファイル識別 (ID) 番号を返します。

Transact-SQL 構文表記規則

構文

FILE_IDEX ( file_name )  

Note

SQL Server 2014 (12.x) 以前のバージョンの Transact-SQL 構文を確認するには、以前のバージョンのドキュメントを参照してください。

引数

file_name
ファイルの名前に対するファイル ID 値 "FILE_IDEX" を返す、sysname 型の式です。

戻り値の型

int

エラー時は NULL

注釈

file_name は、sys.master_files カタログ ビューまたは sys.database_files カタログ ビューの name 列に表示される論理ファイル名に対応します。

FILE_IDEX は、SELECT リスト、WHERE 句、または式の使用がサポートされるあらゆる場所で使用します。 詳細については、「式 (Transact-SQL)」を参照してください。

例

A. 指定されたファイルのファイル ID を取得する

この例では、AdventureWorks_Data ファイルのファイル ID が返されます。

USE AdventureWorks2022;  
GO  
SELECT FILE_IDEX('AdventureWorks2022_Data') AS 'File ID';  
GO  

結果セットは次のようになります。

File ID   
-------   
1  
(1 row(s) affected)  

B. ファイル名が不明な場合ファイル ID を取得する

この例では、AdventureWorks ログ ファイルのファイル ID が返されます。 Transact-SQL (T-SQL) のコード スニペットで、sys.database_files カタログ ビューから論理ファイル名が選択されます (ファイルの種類は 1 (ログ) です)。

USE AdventureWorks2022;  
GO  
SELECT FILE_IDEX((SELECT TOP (1) name FROM sys.database_files WHERE type = 1)) AS 'File ID';  
GO  

結果セットは次のようになります。

File ID   
-------   
2  

C. フルテキスト カタログ ファイルのファイル ID を取得する

この例では、フルテキスト ファイルのファイル ID が返されます。 T-SQL のコード スニペットで、sys.database_files カタログ ビューから論理ファイル名が選択されます (ファイルの種類は 4 (フルテキスト) です)。 フルテキスト カタログが存在しない場合、このコードは "NULL" を返します。

SELECT FILE_IDEX((SELECT name FROM sys.master_files WHERE type = 4))  
AS 'File_ID';  

関連項目

メタデータ関数 (Transact-SQL)
sys.database_files (Transact-SQL)
sys.master_files (Transact-SQL)