FILEGROUP_ID (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Returns the filegroup identification (ID) number for a specified filegroup name.

Topic link icon Transact-SQL Syntax Conventions

Syntax


FILEGROUP_ID ( 'filegroup_name' )   

Arguments

' filegroup_name '
Is an expression of type sysname that represents the filegroup name for which to return the filegroup ID.

Return Types

int

Remarks

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

Examples

The following example returns the filegroup ID for the filegroup named PRIMARY in the AdventureWorks2012 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)