FILEGROUP_ID (Transact-SQL)

Applies to: SQL Server Azure SQL Managed Instance

This function returns the filegroup identification (ID) number for a specified filegroup name.

Transact-SQL syntax conventions

Syntax

FILEGROUP_ID ( 'filegroup_name' )   

Note

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

Arguments

filegroup_name An expression of type sysname, representing the filegroup name whose filegroup ID FILEGROUP_ID will return.

Return Types

int

Remarks

filegroup_name corresponds to the name column in the sys.filegroups catalog view.

Examples

This example returns the filegroup ID for the filegroup named PRIMARY in the AdventureWorks2022 database.

SELECT FILEGROUP_ID('PRIMARY') AS [Filegroup ID];  
GO  

Here is the result set.

Filegroup ID  
------------  
1  

(1 row(s) affected)

See Also

FILEGROUP_NAME (Transact-SQL)
Metadata Functions (Transact-SQL)
sys.filegroups (Transact-SQL)