FILEPROPERTY (Transact-SQL)

適用対象:SQL ServerAzure SQL Managed Instance

現在のデータベース内のファイル名とプロパティ名を指定したときに、指定されたファイル名のプロパティ値を返します。 現在のデータベース内にないファイルの場合は NULL を返します。

Transact-SQL 構文表記規則

構文

FILEPROPERTY ( file_name , property )  

Note

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

引数

file_name
プロパティ情報を返す基になる、現在のデータベースに関連付けられたファイルの名前を含む式を指定します。 file_namenchar (128)です。

property
返されるファイル プロパティの名前を含む式を指定します。 プロパティvarchar (128), 、値は次のいずれかを指定することができます。

説明 返される値
IsReadOnly ファイル グループが読み取り専用であるかどうかを示します。 1 = True

0 = False

NULL = 入力は無効です。
IsPrimaryFile ファイルはプライマリ ファイルです。 1 = True

0 = False

NULL = 入力は無効です。
IsLogFile ファイルはログ ファイルです。 1 = True

0 = False

NULL = 入力は無効です。
SpaceUsed 指定されたファイルで使用されている領域のサイズ。 ファイルに割り当てられているページ数

戻り値の型

int

解説

file_name に対応する、 名前 内の列、 sys.master_files または sys.database_files カタログ ビューです。

次の例では、AdventureWorks2022 データベースのファイル名 AdventureWorks_DataIsPrimaryFile プロパティに対する設定を取得します。

SELECT FILEPROPERTY('AdventureWorks2022_Data', 'IsPrimaryFile')AS [Primary File];  
GO  

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

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

参照

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