Compartilhar via

  • Artigo

INDEXKEY_PROPERTY (Transact-SQL)

Retorna informações sobre a chave de índice. Retorna NULL para índices XML.

Observação importanteImportante

Esse recurso será removido em uma versão futura do Microsoft SQL Server. Evite usar esse recurso em desenvolvimentos novos e planeje modificar os aplicativos que atualmente o utilizam. Em vez disso, use sys.index_columns (Transact-SQL).

Ícone de vínculo de tópicoConvenções de sintaxe Transact-SQL

Sintaxe

INDEXKEY_PROPERTY ( object_ID ,index_ID ,key_ID ,property )

Argumentos

  • object_ID
    É o número de identificação de objeto da tabela ou exibição indexada. object_ID é int.

  • index_ID
    É o número de identificação de índice. index_ID é int.

  • key_ID
    É a posição da coluna da chave de índice. key_ID é int.

  • property
    É o nome da propriedade para a qual as informações serão retornadas. property é uma cadeia de caracteres e pode ser um dos valores a seguir.

    Valor

    Descrição

    ColumnId

    ID de coluna na posição key_ID do índice.

    IsDescending

    Ordem na qual a coluna de índice é armazenada.

    1 = Descendente 0 = Ascendente

Tipos de retorno

int

Exceções

Retorna NULL no caso de erro ou se um chamador não tiver permissão para exibir o objeto.

Um usuário só pode exibir os metadados de protegíveis de sua propriedade ou para os quais ele recebeu permissão. Isso significa que as funções internas emissoras de metadados, como INDEXKEY_PROPERTY, podem retornar NULL se o usuário não tiver permissão no objeto. Para obter mais informações, consulte Configuração de visibilidade de metadados e Solucionando problemas de visibilidade de metadados.

Exemplos

No exemplo a seguir, são retornadas ambas as propriedades para ID de índice 1, coluna de chave 1 na tabela Production.Location.

USE AdventureWorks;
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];

Aqui está o conjunto de resultados:

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

(1 row(s) affected)