FILEPROPERTY (Transact-SQL)

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

トピック リンク アイコン Transact-SQL 構文表記規則

構文

FILEPROPERTY ( file_name , property )

引数

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

  • property
    返されるファイル プロパティの名前を含む式を指定します。 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 カタログ ビューの name 列に対応しています。

使用例

次の例では、AdventureWorks データベース内のファイル名 AdventureWorks_Data の IsPrimaryFile プロパティに対する設定を返します。

USE AdventureWorks2012;
GO
SELECT FILEPROPERTY('AdventureWorks2012_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)