INDEXKEY_PROPERTY (Transact-SQL)INDEXKEY_PROPERTY (Transact-SQL)

SE APLICA A: síSQL Server noAzure SQL Database noAzure SQL Data Warehouse noAlmacenamiento de datos paralelos APPLIES TO: yesSQL Server noAzure SQL Database noAzure SQL Data Warehouse noParallel Data Warehouse

Devuelve información acerca de la clave de índice.Returns information about the index key. Devuelve NULL para los índices XML.Returns NULL for XML indexes.

Importante

Esta característica está en modo de mantenimiento y es posible que no se incluya en una versión futura de Microsoft SQL Server.This feature is in maintenance mode and may be removed in a future version of Microsoft SQL Server. Evite utilizar esta característica en nuevos trabajos de desarrollo y tenga previsto modificar las aplicaciones que actualmente la utilizan.Avoid using this feature in new development work, and plan to modify applications that currently use this feature. Use mejor sys.index_columns (Transact-SQL).Instead, use sys.index_columns (Transact-SQL).

Icono de vínculo de tema Convenciones de sintaxis de Transact-SQLTopic link icon Transact-SQL Syntax Conventions

SintaxisSyntax

  
INDEXKEY_PROPERTY ( object_ID ,index_ID ,key_ID ,property )  

ArgumentosArguments

object_IDobject_ID
Es el número de identificación de objeto de la tabla o vista indizada.Is the object identification number of the table or indexed view. object_ID es int.object_ID is int.

index_IDindex_ID
Es el número de identificación del índice.Is the index identification number. index_ID es int.index_ID is int.

key_IDkey_ID
Es la posición de la columna de clave de índice.Is the index key column position. key_ID es int.key_ID is int.

propertyproperty
Es el nombre de la propiedad cuya información se va a devolver.Is the name of the property for which information will be returned. property es una cadena de caracteres y puede tener uno de los valores siguientes.property is a character string and can be one of the following values.

ValorValue DescripciónDescription
ColumnIdColumnId Identificador de columna en la posición key_ID del índice.Column ID at the key_ID position of the index.
IsDescendingIsDescending Orden en el que se almacena la columna de índice.Order in which the index column is stored.

1 = Descendente ?0 = Ascendente1 = Descending 0 = Ascending

Tipos devueltosReturn Types

intint

ExcepcionesExceptions

Devuelve NULL si se produce un error o si el autor de la llamada no tiene permiso para ver el objeto.Returns NULL on error or if a caller does not have permission to view the object.

Un usuario solo puede ver los metadatos de elementos protegibles que posea o para los que se le haya concedido permiso.A user can only view the metadata of securables that the user owns or on which the user has been granted permission. Esto significa que las funciones integradas de emisión de metadatos, como INDEXKEY_PROPERTY, pueden devolver NULL si el usuario no tiene ningún permiso para el objeto.This means that metadata-emitting, built-in functions such as INDEXKEY_PROPERTY may return NULL if the user does not have any permission on the object. Para obtener más información, consulte Metadata Visibility Configuration.For more information, see Metadata Visibility Configuration.

EjemplosExamples

En el ejemplo siguiente, se devuelven ambas propiedades para el identificador de índice 1, la columna de clave 1 de la tabla Production.Location.In the following example, both properties are returned for index ID 1, key column 1 in the Production.Location table.

USE AdventureWorks2012;  
GO  
SELECT   
    INDEXKEY_PROPERTY(OBJECT_ID('Production.Location', 'U'),  
        1,1,'ColumnId') AS [Column ID],  
    INDEXKEY_PROPERTY(OBJECT_ID('Production.Location', 'U'),  
        1,1,'IsDescending') AS [Asc or Desc order];  

El conjunto de resultados es:Here is the result set:

Column ID   Asc or Desc order   
----------- -----------------   
1           0  
  
(1 row(s) affected)  

Consulte tambiénSee Also

INDEX_COL (Transact-SQL) INDEX_COL (Transact-SQL)
INDEXPROPERTY (Transact-SQL) INDEXPROPERTY (Transact-SQL)
sys.objects (Transact-SQL) sys.objects (Transact-SQL)
sys.indexes (Transact-SQL) sys.indexes (Transact-SQL)
sys.index_columns (Transact-SQL)sys.index_columns (Transact-SQL)