sp_helpindex (Transact-SQL)

报告有关表或视图上索引的信息。

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

语法

sp_helpindex [ @objname = ] 'name'

参数

  • [ @objname=] 'name'
    用户定义的表或视图的限定或非限定名称。 仅当指定限定的表或视图名称时,才需要使用引号。 如果提供了完全限定名称,包括数据库名称,则该数据库名称必须是当前数据库的名称。name 的数据类型为 nvarchar(776),无默认值。

返回代码值

0(成功)或 1(失败)

结果集

列名

数据类型

说明

index_name

sysname

索引名。

index_description

varchar(210)

索引说明,其中包括索引所在的文件组。

index_keys

nvarchar(2078)

对其生成索引的表或视图列。

被降序索引的列将在结果集中列出,该列的名称后面带有一个减号 (-),当列出被升序索引的列(这是默认情况)时,只带有该列的名称。

注释

如果已使用 UPDATE STATISTICS 的 NORECOMPUTE 选项设置了索引,该信息将包含在 index_description 列中。

sp_helpindex 只显示可排序的索引列;因此,它不显示关于 XML 索引或空间索引的信息。

权限

要求具有 public 角色的成员身份。

示例

以下示例报告 Customer 表的索引类型。

USE AdventureWorks2008R2;
GO
EXEC sp_helpindex N'Sales.Customer';
GO