Skip to content

Latest commit

 

History

History
77 lines (61 loc) · 2.81 KB

filegroupproperty-transact-sql.md

File metadata and controls

77 lines (61 loc) · 2.81 KB
title description author ms.author ms.date ms.service ms.subservice ms.topic f1_keywords helpviewer_keywords dev_langs
FILEGROUPPROPERTY (Transact-SQL)
FILEGROUPPROPERTY (Transact-SQL)
markingmyname
maghan
03/03/2017
sql
t-sql
reference
FILEGROUPPROPERTY_TSQL
FILEGROUPPROPERTY
filegroups [SQL Server], property values
FILEGROUPPROPERTY function
viewing filegroup properties
displaying filegroup properties
TSQL

FILEGROUPPROPERTY (Transact-SQL)

[!INCLUDE SQL Server Azure SQL Managed Instance]

This function returns the filegroup property value for a specified name and filegroup value.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

FILEGROUPPROPERTY ( filegroup_name, property )  

Arguments

filegroup_name
An expression of type sysname that represents the filegroup name for which FILEGROUPPROPERTY returns the named property information.

property
An expression of type varchar(128) that returns the name of the filegroup property. Property can return one of these values:

Value Description Value returned
IsReadOnly Filegroup is read-only. 1 = TRUE

0 = FALSE

NULL = Invalid input.
IsUserDefinedFG Filegroup is a user-defined filegroup. 1 = TRUE

0 = FALSE

NULL = Invalid input.
IsDefault Filegroup is the default filegroup. 1 = TRUE

0 = FALSE

NULL = Invalid input.

Return Types

int

Remarks

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

Examples

This example returns the IsDefault property setting for the primary filegroup in the [!INCLUDEssSampleDBnormal] database.

SELECT FILEGROUPPROPERTY('PRIMARY', 'IsDefault') AS 'Default Filegroup';  
GO  

[!INCLUDEssResult]

Default Filegroup   
---------------------   
1  
  
(1 row(s) affected)  

See Also

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