file-id-transact-sql.md

description	FILE_ID (Transact-SQL)
title	FILE_ID (Transact-SQL) | Microsoft Docs
ms.custom
ms.date	03/14/2017
ms.prod	sql
ms.prod_service	sql-database
ms.reviewer
ms.technology	t-sql
ms.topic	reference
f1_keywords	FILE_ID FILE_ID_TSQL
dev_langs	TSQL
helpviewer_keywords	IDs [SQL Server], files file IDs [SQL Server] FILE_ID function names [SQL Server], files identification numbers [SQL Server], files file names [SQL Server], FILE_ID
ms.assetid	6a7382cf-a360-4d62-b9d2-5d747f56f076
author	cawrites
ms.author	chadam

FILE_ID (Transact-SQL)

[!INCLUDE SQL Server]

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

Important

[!INCLUDEssNoteDepFutureAvoid] Use FILE_IDEX instead.

Transact-SQL Syntax Conventions

Syntax

FILE_ID ( file_name )  

[!INCLUDEsql-server-tsql-previous-offline-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 [!INCLUDEssNoVersion], 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 AdventureWorks_Data file, a component file of the ADVENTUREWORKS2012 database.

USE AdventureWorks2012;  
GO  
SELECT FILE_ID('AdventureWorks2012_Data')AS 'File ID';  
GO  

[!INCLUDEssResult]

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

See Also

Deprecated Database Engine Features in SQL Server 2016
FILE_NAME (Transact-SQL)
Metadata Functions (Transact-SQL)
sys.database_files (Transact-SQL)
sys.master_files (Transact-SQL)