COLUMNPROPERTY (Transact-SQL)

适用于:SQL ServerAzure SQL 数据库Azure SQL 托管实例

此函数将返回列或参数的信息。

Transact-SQL 语法约定

语法

COLUMNPROPERTY ( id , column , property )   

注意

若要查看 SQL Server 2014 (12.x) 及更早版本的 Transact-SQL 语法,请参阅早期版本文档

自变量

id
一个表达式,其中包含表或过程的标识符 (ID)。

column
一个表达式,其中包含列或参数的名称。

property
对于 id 自变量,property 自变量指定 COLUMNPROPERTY 函数将返回的信息类型。 property 自变量可具有下列值之一

说明 返回的值
AllowsNull 允许空值。 1:TRUE

0:FALSE

NULL:输入无效。
ColumnId 对应于 sys.columns.column_id 的列 ID 值 列 ID

请注意:查询多列时,列 ID 值的序列中可能出现间隔
FullTextTypeColumn 表中的 TYPE COLUMN,其中包含 column 的文档类型信息 列名称表达式的全文 TYPE COLUMN 的 ID,作为此函数的第二个参数传递。
GeneratedAlwaysType 系统生成的列值。 对应于 sys.columns.generated_always_type 适用于:SQL Server 2016 (13.x) 及更高版本。

0:有时生成

1:始终在行首生成

2:始终在行末生成
IsColumnSet 列为列集。 有关详细信息,请参阅 使用列集 1:TRUE

0:FALSE

NULL:输入无效。
IsComputed 列是计算列。 1:TRUE

0:FALSE

NULL:输入无效。
IsCursorType 过程参数类型为 CURSOR。 1:TRUE

0:FALSE

NULL:输入无效。
IsDeterministic 列是确定性列。 此属性只适用于计算列和视图列。 1:TRUE

0:FALSE

NULL:输入无效。 非计算列或视图列。
IsFulltextIndexed 列已注册为全文检索。 1:TRUE

0:FALSE

NULL:输入无效。
IsHidden 系统生成的列值。 对应于 sys.columns.is_hidden 适用于:SQL Server 2016 (13.x) 及更高版本。

0:未隐藏

1:已隐藏
IsIdentity 列使用 IDENTITY 属性。 1:TRUE

0:FALSE

NULL:输入无效。
IsIdNotForRepl 列检查 IDENTITY_INSERT 设置。 1:TRUE

0:FALSE

NULL:输入无效。
IsIndexable 可以对列进行索引。 1:TRUE

0:FALSE

NULL:输入无效。
IsOutParam 过程参数是输出参数。 1:TRUE

0:FALSE

NULL:输入无效。
IsPrecise 列是精确列。 此属性只适用于确定性列。 1:TRUE

0:FALSE

NULL:输入无效。 不是确定性列
IsRowGuidCol 列具有 uniqueidentifier 数据类型,并且是使用 ROWGUIDCOL 属性定义的 1:TRUE

0:FALSE

NULL:输入无效。
IsSparse 列为稀疏列。 有关详细信息,请参阅 使用稀疏列 1:TRUE

0:FALSE

NULL:输入无效。
IsSystemVerified 数据库引擎 可以验证列的确定性和精度属性。 此属性只应用于计算列和视图中的列。 1:TRUE

0:FALSE

NULL:输入无效。
IsXmlIndexable 可以在 XML 索引中使用 XML 列。 1:TRUE

0:FALSE

NULL:输入无效。
精度 列或参数的数据类型的长度。 指定的列数据类型的长度

-1:xml 或大值类型

NULL:输入无效。
缩放 列或参数的数据类型的小数位数。 小数位数值

NULL:输入无效。
StatisticalSemantics 支持对列进行语义索引。 1:TRUE

0:FALSE
SystemDataAccess 列是由访问 SQL Server 的系统目录或虚拟系统表中数据的函数派生的。 此属性只应用于计算列和视图中的列。 1:TRUE(指示只读访问。)

0:FALSE

NULL:输入无效。
UserDataAccess 列是由访问储存于 SQL Server 本地实例的用户表中数据的函数派生的。 此属性只应用于计算列和视图中的列。 1:TRUE(指示只读访问。)

0:FALSE

NULL:输入无效。
UsesAnsiTrim 在创建表时 ANSI_PADDING 已设置为 ON。 此属性仅适用于 char 或 varchar 类型的列或参数 1:TRUE

0:FALSE

NULL:输入无效。

返回类型

int

例外

出现错误时或调用方没有查看对象的权限时将返回 NULL。

用户只能查看符合如下条件的安全对象的元数据:该安全对象为该用户所有,或已授予该用户对该安全对象的权限。 这意味着,如果用户对该对象没有正确的权限,那些发出元数据的内置函数(如 COLUMNPROPERTY)则可能会返回 NULL。 有关详细信息,请参阅元数据可见性配置

备注

检查列的确定性属性时,首先测试此列是否为计算列。 对于非计算列,IsDeterministic 自变量将返回 NULL。 可以将计算列指定为索引列。

示例

此示例将返回 LastName 列的长度。

USE AdventureWorks2022;  
GO  
SELECT COLUMNPROPERTY( OBJECT_ID('Person.Person'),'LastName','PRECISION')AS 'Column Length';  
GO  

下面是结果集。

Column Length
-------------
50

另请参阅

元数据函数 (Transact-SQL)
TYPEPROPERTY (Transact-SQL)