FILEPROPERTY (Transact-SQL)

Статья
12/22/2023

Применимо к:SQL Server Управляемый экземпляр SQL Azure

Возвращает указанное значение свойства имени файла, если указываются имя файла текущей базы данных и имя свойства. Возвращает значение NULL для файлов, которые не находятся в текущей базе данных.

Соглашения о синтаксисе Transact-SQL

Синтаксис

FILEPROPERTY ( file_name , property )

Примечание.

Сведения о синтаксисе Transact-SQL для SQL Server 2014 (12.x) и более ранних версиях см . в документации по предыдущим версиям.

Аргументы

file_name
Выражение, которое содержит имя файла, связанного с текущей базой данных, для которого нужно возвратить сведения о свойстве. Аргумент file_name имеет тип nchar(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 соответствует столбцу name в представлении каталога sys.master_files или sys.database_files.

Примеры

В следующем примере возвращается параметр свойства IsPrimaryFile для AdventureWorks_Data имени файла в AdventureWorks2022 в базе данных.

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)