Skip to content

Commit 4551bad

Browse files
authored
Merge pull request MicrosoftDocs#5261 from srutzky/patch-7
Add missing property and datatypes for SERVERPROPERTY
2 parents 6f49804 + 6883861 commit 4551bad

1 file changed

Lines changed: 18 additions & 16 deletions

File tree

docs/t-sql/functions/serverproperty-transact-sql.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "SERVERPROPERTY (Transact-SQL) | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "05/08/2020"
4+
ms.date: "07/28/2020"
55
ms.prod: sql
66
ms.prod_service: "database-engine, sql-database, sql-data-warehouse, pdw"
77
ms.reviewer: ""
@@ -58,32 +58,36 @@ Is an expression that contains the property information to be returned for the s
5858
|Edition|Installed product edition of the instance of [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)]. Use the value of this property to determine the features and the limits, such as [Compute Capacity Limits by Edition of SQL Server](../../sql-server/compute-capacity-limits-by-edition-of-sql-server.md). 64-bit versions of the [!INCLUDE[ssDE](../../includes/ssde-md.md)] append (64-bit) to the version.<br /><br /> Returns:<br /><br /> 'Enterprise Edition'<br /><br /> 'Enterprise Edition: Core-based Licensing'<br /><br /> 'Enterprise Evaluation Edition'<br /><br /> 'Business Intelligence Edition'<br /><br /> 'Developer Edition'<br /><br /> 'Express Edition'<br /><br /> 'Express Edition with Advanced Services'<br /><br /> 'Standard Edition'<br /><br /> 'Web Edition'<br /><br /> 'SQL Azure' indicates [!INCLUDE[ssSDS](../../includes/sssds-md.md)] or [!INCLUDE[ssDW](../../includes/ssdw-md.md)]<br /><br /> 'Azure SQL Edge Developer' indicates the development only edition for Azure SQL Edge' <br /><br /> 'Azure SQL Edge' indicates the paid edition for Azure SQL Edge' <br /><br /> Base data type: **nvarchar(128)**|
5959
|EditionID|EditionID represents the installed product edition of the instance of [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)]. Use the value of this property to determine features and limits, such as [Compute Capacity Limits by Edition of SQL Server](../../sql-server/compute-capacity-limits-by-edition-of-sql-server.md).<br /><br /> 1804890536 = Enterprise<br /><br /> 1872460670 = Enterprise Edition: Core-based Licensing<br /><br /> 610778273= Enterprise Evaluation<br /><br /> 284895786 = Business Intelligence<br /><br /> -2117995310 = Developer<br /><br /> -1592396055 = Express<br /><br /> -133711905= Express with Advanced Services<br /><br /> -1534726760 = Standard<br /><br /> 1293598313 = Web<br /><br /> 1674378470 = SQL Database or Microsoft Azure Synapse Analytics (formerly SQL Data Warehouse)<br /><br /> -1461570097 = Azure SQL Edge Developer <br /><br /> 1994083197 = Azure SQL Edge <br /><br />Base data type: **bigint**|
6060
|EngineEdition|[!INCLUDE[ssDE](../../includes/ssde-md.md)] edition of the instance of [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] installed on the server.<br /><br /> 1 = Personal or Desktop Engine (Not available in [!INCLUDE[ssVersion2005](../../includes/ssversion2005-md.md)] and later versions.)<br /><br /> 2 = Standard (This is returned for Standard, Web, and Business Intelligence.)<br /><br /> 3 = Enterprise (This is returned for Evaluation, Developer, and Enterprise editions.)<br /><br /> 4 = Express (This is returned for Express, Express with Tools, and Express with Advanced Services)<br /><br /> 5 = [!INCLUDE[ssSDS](../../includes/sssds-md.md)]<br /><br /> 6 = [!INCLUDE[ssDW](../../includes/ssdw-md.md)]<br /><br /> 8 = Managed Instance<br /><br /> 9 = Azure SQL Edge (This is returned for both editions of Azure SQL Edge<br /><br /> Base data type: **int**|
61-
|HadrManagerStatus|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] and later.<br /><br /> Indicates whether the [!INCLUDE[ssHADR](../../includes/sshadr-md.md)] manager has started.<br /><br /> 0 = Not started, pending communication.<br /><br /> 1 = Started and running.<br /><br /> 2 = Not started and failed.<br /><br /> NULL = Input is not valid, an error, or not applicable.|
62-
|InstanceDefaultDataPath|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> Name of the default path to the instance data files.|
63-
|InstanceDefaultLogPath|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> Name of the default path to the instance log files.|
61+
|FilestreamConfiguredLevel|The configured level of FILESTREAM access. For more information, see [filestream access level](../../database-engine/configure-windows/filestream-access-level-server-configuration-option.md).<br /><br /> Base data type: **int**|
62+
|FilestreamEffectiveLevel|The effective level of FILESTREAM access. This value can be different than the FilestreamConfiguredLevel if the level has changed and either an instance restart or a computer restart is pending. For more information, see [filestream access level](../../database-engine/configure-windows/filestream-access-level-server-configuration-option.md).<br /><br /> Base data type: **int**|
63+
|FilestreamShareName|The name of the share used by FILESTREAM.<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **nvarchar(128)**|
64+
|HadrManagerStatus|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] and later.<br /><br /> Indicates whether the [!INCLUDE[ssHADR](../../includes/sshadr-md.md)] manager has started.<br /><br /> 0 = Not started, pending communication.<br /><br /> 1 = Started and running.<br /><br /> 2 = Not started and failed.<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **int**|
65+
|InstanceDefaultDataPath|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> Name of the default path to the instance data files.<br /><br /> Base data type: **nvarchar(128)**|
66+
|InstanceDefaultLogPath|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> Name of the default path to the instance log files.<br /><br /> Base data type: **nvarchar(128)**|
6467
|InstanceName|Name of the instance to which the user is connected.<br /><br /> Returns NULL if the instance name is the default instance, if the input is not valid, or error.<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **nvarchar(128)**|
65-
|IsAdvancedAnalyticsInstalled|Returns 1 if the Advanced Analytics feature was installed during setup; 0 if Advanced Analytics was not installed.|
66-
|IsBigDataCluster| Introduced in [!INCLUDE[ssSQL2019](../../includes/sssqlv15-md.md)] beginning with CU4.<br /><br />Returns 1 if the instance is SQL Server Big Data Cluster; 0 if not.|
68+
|IsAdvancedAnalyticsInstalled|Returns 1 if the Advanced Analytics feature was installed during setup; 0 if Advanced Analytics was not installed.<br /><br /> Base data type: **int**|
69+
|IsBigDataCluster| Introduced in [!INCLUDE[ssSQL2019](../../includes/sssqlv15-md.md)] beginning with CU4.<br /><br />Returns 1 if the instance is SQL Server Big Data Cluster; 0 if not.<br /><br /> Base data type: **int**|
6770
|IsClustered|Server instance is configured in a failover cluster.<br /><br /> 1 = Clustered.<br /><br /> 0 = Not Clustered.<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **int**|
6871
|IsFullTextInstalled|The full-text and semantic indexing components are installed on the current instance of [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)].<br /><br /> 1 = Full-text and semantic indexing components are installed.<br /><br /> 0 = Full-text and semantic indexing components are not installed.<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **int**|
6972
|IsHadrEnabled|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] and later.<br /><br /> [!INCLUDE[ssHADR](../../includes/sshadr-md.md)] is enabled on this server instance.<br /><br /> 0 = The [!INCLUDE[ssHADR](../../includes/sshadr-md.md)] feature is disabled.<br /><br /> 1 = The [!INCLUDE[ssHADR](../../includes/sshadr-md.md)] feature is enabled.<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **int**<br /><br /> For availability replicas to be created and run on an instance of [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)], [!INCLUDE[ssHADR](../../includes/sshadr-md.md)] must be enabled on the server instance. For more information, see [Enable and Disable AlwaysOn Availability Groups (SQL Server)](../../database-engine/availability-groups/windows/enable-and-disable-always-on-availability-groups-sql-server.md).<br /><br /> **Note:** The IsHadrEnabled property pertains only to [!INCLUDE[ssHADR](../../includes/sshadr-md.md)]. Other high availability or disaster recovery features, such as database mirroring or log shipping, are unaffected by this server property.|
7073
|IsIntegratedSecurityOnly|Server is in integrated security mode.<br /><br /> 1 = Integrated security (Windows Authentication)<br /><br /> 0 = Not integrated security. (Both Windows Authentication and [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] Authentication.)<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **int**|
71-
|IsLocalDB|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] and later.<br /><br /> Server is an instance of [!INCLUDE[ssExpress](../../includes/ssexpress-md.md)] LocalDB.<br /><br /> NULL = Input is not valid, an error, or not applicable.|
74+
|IsLocalDB|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] and later.<br /><br /> Server is an instance of [!INCLUDE[ssExpress](../../includes/ssexpress-md.md)] LocalDB.<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **int**|
7275
|IsPolyBaseInstalled|**Applies to**: [!INCLUDE[ssCurrent](../../includes/sscurrent-md.md)].<br /><br /> Returns whether the server instance has the PolyBase feature installed.<br /><br /> 0 = PolyBase is not installed.<br /><br /> 1 = PolyBase is installed.<br /><br /> Base data type: **int**|
7376
|IsSingleUser|Server is in single-user mode.<br /><br /> 1 = Single user.<br /><br /> 0 = Not single user<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **int**|
77+
|IsTempDbMetadataMemoryOptimized|**Applies to**: [!INCLUDE[ssSQL2019](../../includes/sssqlv15-md.md)] and later.<br /><br />Returns 1 if tempdb has been enabled to use memory-optimized tables for metadata; 0 if tempdb is using regular, disk-based tables for metadata. For more information, see [tempdb Database](../../relational-databases/databases/tempdb-database.md#memory-optimized-tempdb-metadata).<br /><br /> Base data type: **int**|
7478
|IsXTPSupported|**Applies to**: SQL Server ([!INCLUDE[ssSQL14](../../includes/sssql14-md.md)] and later), [!INCLUDE[ssSDS](../../includes/sssds-md.md)].<br /><br /> Server supports In-Memory OLTP.<br /><br /> 1= Server supports In-Memory OLTP.<br /><br /> 0= Server does not supports In-Memory OLTP.<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **int**|
7579
|LCID|Windows locale identifier (LCID) of the collation.<br /><br /> Base data type: **int**|
7680
|LicenseType|Unused. License information is not preserved or maintained by the [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] product. Always returns DISABLED.<br /><br /> Base data type: **nvarchar(128)**|
7781
|MachineName|Windows computer name on which the server instance is running.<br /><br /> For a clustered instance, an instance of [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] running on a virtual server on Microsoft Cluster Service, it returns the name of the virtual server.<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **nvarchar(128)**|
7882
|NumLicenses|Unused. License information is not preserved or maintained by the [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] product. Always returns NULL.<br /><br /> Base data type: **int**|
7983
|ProcessID|Process ID of the [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] service. ProcessID is useful in identifying which Sqlservr.exe belongs to this instance.<br /><br /> NULL = Input is not valid, an error, or not applicable.<br /><br /> Base data type: **int**|
80-
|ProductBuild|**Applies to**: [!INCLUDE[ssSQL14](../../includes/sssql14-md.md)] beginning October, 2015.<br /><br /> The build number.|
81-
|ProductBuildType|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> Type of build of the current build.<br /><br /> Returns one of the following:<br /><br /> OD = On Demand release a specific customer.<br /><br /> GDR = General Distribution Release released through windows update.<br /><br /> NULL<br />= Not applicable.|
84+
|ProductBuild|**Applies to**: [!INCLUDE[ssSQL14](../../includes/sssql14-md.md)] beginning October, 2015.<br /><br /> The build number.<br /><br /> Base data type: **nvarchar(128)**|
85+
|ProductBuildType|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> Type of build of the current build.<br /><br /> Returns one of the following:<br /><br /> OD = On Demand release a specific customer.<br /><br /> GDR = General Distribution Release released through windows update.<br /><br /> NULL = Not applicable.<br /><br /> Base data type: **nvarchar(128)**|
8286
|ProductLevel|Level of the version of the instance of [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)].<br /><br /> Returns one of the following:<br /><br /> 'RTM' = Original release version<br /><br /> 'SP*n*' = Service pack version<br /><br /> 'CTP*n*', = Community Technology Preview version<br /><br /> Base data type: **nvarchar(128)**|
83-
|ProductMajorVersion|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> The major version.|
84-
|ProductMinorVersion|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> The minor version.|
85-
|ProductUpdateLevel|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> Update level of the current build. CU indicates a cumulative update.<br /><br /> Returns one of the following:<br /><br /> CU*n* = Cumulative Update<br /><br /> NULL<br />= Not applicable.|
86-
|ProductUpdateReference|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> KB article for that release.|
87+
|ProductMajorVersion|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> The major version.<br /><br /> Base data type: **nvarchar(128)**|
88+
|ProductMinorVersion|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> The minor version.<br /><br /> Base data type: **nvarchar(128)**|
89+
|ProductUpdateLevel|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> Update level of the current build. CU indicates a cumulative update.<br /><br /> Returns one of the following:<br /><br /> CU*n* = Cumulative Update<br /><br /> NULL = Not applicable.<br /><br /> Base data type: **nvarchar(128)**|
90+
|ProductUpdateReference|**Applies to**: [!INCLUDE[ssSQL11](../../includes/sssql11-md.md)] through current version in updates beginning in late 2015.<br /><br /> KB article for that release.<br /><br /> Base data type: **nvarchar(128)**|
8791
|ProductVersion|Version of the instance of [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)], in the form of '*major.minor.build.revision*'.<br /><br /> Base data type: **nvarchar(128)**|
8892
|ResourceLastUpdateDateTime|Returns the date and time that the Resource database was last updated.<br /><br /> Base data type: **datetime**|
8993
|ResourceVersion|Returns the version Resource database.<br /><br /> Base data type: **nvarchar(128)**|
@@ -92,9 +96,7 @@ Is an expression that contains the property information to be returned for the s
9296
|SqlCharSetName|The SQL character set name from the collation.<br /><br /> Base data type: **nvarchar(128)**|
9397
|SqlSortOrder|The SQL sort order ID from the collation<br /><br /> Base data type: **tinyint**|
9498
|SqlSortOrderName|The SQL sort order name from the collation.<br /><br /> Base data type: **nvarchar(128)**|
95-
|FilestreamShareName|The name of the share used by FILESTREAM.<br /><br /> NULL = Input is not valid, an error, or not applicable.|
96-
|FilestreamConfiguredLevel|The configured level of FILESTREAM access. For more information, see [filestream access level](../../database-engine/configure-windows/filestream-access-level-server-configuration-option.md).|
97-
|FilestreamEffectiveLevel|The effective level of FILESTREAM access. This value can be different than the FilestreamConfiguredLevel if the level has changed and either an instance restart or a computer restart is pending. For more information, see [filestream access level](../../database-engine/configure-windows/filestream-access-level-server-configuration-option.md).|
99+
98100

99101
## Return Types
100102

0 commit comments

Comments
 (0)