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

CETTE RUBRIQUE S’APPLIQUE À :ouiSQL Server (à partir de la version 2008)nonAzure SQL DatabasenonAzure SQL Data Warehouse nonParallel Data Warehouse THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Retourne des informations concernant la clé d'index.Returns information about the index key. Retourne la valeur NULL pour les index XML.Returns NULL for XML indexes.

Important

Cette fonctionnalité sera supprimée dans une prochaine version de Microsoft SQL Server.This feature will be removed in a future version of Microsoft SQL Server. Évitez d'utiliser cette fonctionnalité dans de nouveaux travaux de développement, et prévoyez de modifier les applications qui utilisent actuellement cette fonctionnalité.Avoid using this feature in new development work, and plan to modify applications that currently use this feature. Utilisez plutôt sys.index_columns (Transact-SQL). Instead, use sys.index_columns (Transact-SQL).

Icône de lien de rubrique Conventions de la syntaxe Transact-SQLTopic link icon Transact-SQL Syntax Conventions

SyntaxeSyntax


INDEXKEY_PROPERTY ( object_ID ,index_ID ,key_ID ,property )  

ArgumentsArguments

object_IDobject_ID
Numéro d'identification de l'objet de la table ou de la vue indexée.Is the object identification number of the table or indexed view. object_ID est de type int.object_ID is int.

index_IDindex_ID
Numéro d'identification de l'index.Is the index identification number. index_ID est de type int.index_ID is int.

key_IDkey_ID
Position de la colonne clé d'index.Is the index key column position. key_ID est de type int.key_ID is int.

propertyproperty
Nom de la propriété pour laquelle des informations sont retournées.Is the name of the property for which information will be returned. property est une chaîne de caractères qui peut avoir l’une des valeurs suivantes.property is a character string and can be one of the following values.

ValeurValue DescriptionDescription
ColumnIdColumnId Identificateur de colonne à la position key_ID de l’index.Column ID at the key_ID position of the index.
IsDescendingIsDescending Ordre de stockage de la colonne d'indexOrder in which the index column is stored.

1 = décroissant 0 = croissant1 = Descending 0 = Ascending

Types de retourReturn Types

Intint

ExceptionsExceptions

Retourne la valeur NULL en cas d'erreur ou si un appelant n'est pas autorisé à afficher l'objet.Returns NULL on error or if a caller does not have permission to view the object.

Un utilisateur peut voir uniquement les métadonnées des éléments sécurisables qui lui appartiennent ou pour lesquels il dispose d'une autorisation.A user can only view the metadata of securables that the user owns or on which the user has been granted permission. Cela signifie que les fonctions intégrées générant des métadonnées, telles que INDEXKEY_PROPERTY, peuvent retourner la valeur NULL si l'utilisateur ne dispose d'aucune autorisation sur l'objet.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. Pour plus d'informations, consultez Metadata Visibility Configuration.For more information, see Metadata Visibility Configuration.

ExemplesExamples

Dans l'exemple suivant, les deux propriétés sont retournées pour l'ID index 1, la colonne clé 1 dans la table 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];  

Voici l'ensemble de résultats obtenu :Here is the result set:

Column ID   Asc or Desc order   
----------- -----------------   
1           0  

(1 row(s) affected)  

Voir aussiSee 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)