通过

  • 项目

COLUMNPROPERTY (Transact-SQL)

返回有关列或过程参数的信息。

主题链接图标Transact-SQL 语法约定

语法

COLUMNPROPERTY ( id , column , property )

参数

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

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

  • property
    一个表达式，其中包含要为 id 返回的信息，可以为下列值之一。

    值

    说明

    返回的值

    AllowsNull

    允许空值。

    1 = TRUE

    0 = FALSE

    NULL = 输入无效。

    ColumnId

    对应于 sys.columns.column_id 的列 ID 值。

    列 ID

    注意注意
    查询多列时，列 ID 值的序列中可能出现间隔。

    FullTextTypeColumn

    表中的 TYPE COLUMN，其中包含 column 的文档类型信息。

    列的全文 TYPE COLUMN 的 ID，作为此属性的第二个参数传递。

    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 = 输入无效。

    IsIdentity

    列使用 IDENTITY 属性。

    1 = TRUE

    0 = FALSE NULL = 输入无效。

    IsIdNotForRepl

    列检查 IDENTITY_INSERT 设置。如果指定了 IDENTITY NOT FOR REPLICATION，则不检查 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 = 输入无效。

    IsSystemVerified

    列的确定性和精度属性可以使用 数据库引擎 验证。此属性只应用于计算列和视图中的列。

    1 = TRUE

    0 = FALSE

    NULL = 输入无效。

    IsXmlIndexable

    可以在 XML 索引中使用 XML 列。

    1 = TRUE

    0 = FALSE

    NULL = 输入无效。

    Precision

    列或参数的数据类型的长度。

    指定的列数据类型的长度

    -1 = xml 或大值类型

    NULL = 输入无效。

    Scale

    列或参数的数据类型的小数位数。

    小数位数

    NULL = 输入无效。

    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 = 输入无效。

    IsSparse

    列为稀疏列。有关详细信息，请参阅使用稀疏列。

    1= TRUE

    0= FALSE

    NULL = 输入无效。

    IsColumnSet

    列为列集。有关详细信息，请参阅使用列集。

    1= TRUE

    0= FALSE

    NULL = 输入无效。

返回类型

int

异常

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

在 SQL Server 2008 中，用户只能查看其拥有的安全对象的元数据，或者已对其授予权限的安全对象的元数据。这意味着，如果用户对对象没有任何权限，则元数据生成的内置函数（如 COLUMNPROPERTY）可能返回 NULL。有关详细信息，请参阅 元数据可见性配置 和元数据可见性故障排除。

注释

检查列的确定性属性时，首先测试该列是否为计算列。IsDeterministic 为非计算列返回 NULL。可以将计算列指定为索引列。

示例

以下示例将返回 LastName 列的长度。

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

下面是结果集。

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

(1 row(s) affected)