sp_helpindex (Transact-SQL)

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

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

Transact-SQL 语法约定

语法

sp_helpindex [ @objname = ] N'objname'
[ ; ]

参数

[ @objname = ] N'objname'

用户定义的表或视图的限定或非限定名称。 @objname为 nvarchar(776),没有默认值。 仅当指定限定的表或视图名称时,才需要使用引号。 如果提供的是完全限定名称(包括数据库名称),则数据库名称必须是当前数据库的名称。

返回代码值

0(成功)或 1(失败)。

结果集

列名称 数据类型 描述
index_name sysname 索引名。
index_description varchar(210) 索引说明,包括其所在的文件组。
index_keys nvarchar(2078) 对其生成索引的表或视图列。

结果集中列出了一个降序索引列,其名称后带有减号(-);单靠其名称列出升序索引列(默认值)。

注解

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

sp_helpindex 仅公开可排序索引列;因此,它不会公开有关 XML 索引或空间索引的信息。

权限

要求 公共 角色具有成员身份。

示例

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

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