FILE_ID (Transact-SQL)

Article
08/10/2023

Applies to: SQL Server Azure SQL Managed Instance

For the given logical name for a component file of the current database, this function returns the file identification (ID) number.

Important

This feature will be removed in a future version of SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature. Use FILE_IDEX instead.

Transact-SQL syntax conventions

Syntax

FILE_ID ( file_name )

Note

To view Transact-SQL syntax for SQL Server 2014 (12.x) and earlier versions, see Previous versions documentation.

Arguments

file_name
An expression of type sysname, representing the logical name of the file whose file ID value FILE_ID will return.

Return Types

smallint

Remarks

file_name corresponds to the logical file name displayed in the name column of the sys.master_files or sys.database_files catalog views.

FILE_ID returns NULL if file_name does not correspond to the logical name of a component file of the current database.

In SQL Server, the file identification number assigned to full-text catalogs exceeds 32767. Because the FILE_ID function has a smallint return type, FILE_ID will not support full-text files. Use FILE_IDEX instead.

Examples

This example returns the file ID value for the AdventureWorks2022_Data file, a component file of the AdventureWorks2022 database.

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

Here is the result set.

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