IConventionIndex Interface

Definição

Representa um índice em um conjunto de propriedades.

public interface IConventionIndex : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IIndex
public interface IConventionIndex : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex
type IConventionIndex = interface
    interface IIndex
    interface IAnnotatable
    interface IConventionAnnotatable
type IConventionIndex = interface
    interface IReadOnlyIndex
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable
Public Interface IConventionIndex
Implements IConventionAnnotatable, IIndex
Public Interface IConventionIndex
Implements IConventionAnnotatable, IReadOnlyIndex
Implementações

Comentários

Essa interface é usada durante a criação do modelo e permite que os metadados sejam modificados. Depois que o modelo é criado, IIndex representa uma exibição somente leitura dos mesmos metadados.

Consulte Convenções de criação de modelo para obter mais informações e exemplos.

Propriedades

Builder

Obtém o construtor que pode ser usado para configurar esse índice.

DeclaringEntityType

Obtém o tipo de entidade em que o índice é definido. Isso pode ser diferente do tipo definido em quando o índice é definido como um tipo derivado em uma hierarquia de herança (uma vez que Properties as propriedades podem ser definidas em um tipo base).

IsDescending

Um conjunto de valores que indica se cada coluna de índice correspondente tem ordem de classificação decrescente.

(Herdado de IReadOnlyIndex)
IsInModel

Indica se esse objeto está em um modelo, ou seja, não foi removido de um.

(Herdado de IConventionAnnotatable)
IsUnique

Obtém um valor que indica se os valores atribuídos às propriedades indexadas são exclusivos.

(Herdado de IReadOnlyIndex)
Item[String]

Obtém o valor da anotação com o nome fornecido, retornando null se ela não existir.

(Herdado de IReadOnlyAnnotatable)
Name

Obtém o nome desse índice.

(Herdado de IReadOnlyIndex)
Properties

Obtém as propriedades em que esse índice é definido.

Métodos

AddAnnotation(String, Object, Boolean)

Adiciona uma anotação a esse objeto. Gerará se já existir uma anotação com o nome especificado.

(Herdado de IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)

Adiciona anotações a um objeto .

(Herdado de IConventionAnnotatable)
AddRuntimeAnnotation(String, Object)

Adiciona uma anotação de runtime a esse objeto. Gerará se já existir uma anotação com o nome especificado.

(Herdado de IAnnotatable)
AnnotationsToDebugString(Int32)

Obtém a cadeia de caracteres de depuração para todas as anotações declaradas no objeto .

(Herdado de IReadOnlyAnnotatable)
DisplayName()

Obtém o nome de exibição amigável para o determinado IReadOnlyIndex, retornando seu Name se um for definido ou uma representação de cadeia de caracteres de seu Properties se este for um índice sem nome.

(Herdado de IReadOnlyIndex)
FindAnnotation(String)

Obtém a anotação com o nome fornecido, retornando null se ela não existir.

(Herdado de IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)

Obtém a anotação de runtime com o nome fornecido, retornando null se ela não existir.

(Herdado de IAnnotatable)
FindRuntimeAnnotationValue(String)

Obtém o valor da anotação de runtime com o nome fornecido, retornando null se ela não existir.

(Herdado de IAnnotatable)
GetAnnotation(String)

Obtém a anotação com o nome fornecido, lançando se ela não existir.

(Herdado de IReadOnlyAnnotatable)
GetAnnotations()

Obtém todas as anotações no objeto atual.

(Herdado de IReadOnlyAnnotatable)
GetConfigurationSource()

Retorna a fonte de configuração para esse índice.

GetIsDescendingConfigurationSource()

Retorna a fonte de configuração para IsDescending.

GetIsUniqueConfigurationSource()

Retorna a fonte de configuração para IsUnique.

GetNullableValueFactory<TKey>()

Obtém uma fábrica para valores de chave com base nos valores de chave de índice obtidos de várias formas de dados de entidade.

Esse método normalmente é usado por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

(Herdado de IIndex)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)

Obtém o valor da anotação de runtime com o nome fornecido, adicionando-o se um não existir.

(Herdado de IAnnotatable)
GetRuntimeAnnotations()

Obtém todas as anotações de runtime no objeto atual.

(Herdado de IAnnotatable)
RemoveAnnotation(String)

Remove a anotação com o nome fornecido desse objeto.

(Herdado de IConventionAnnotatable)
RemoveRuntimeAnnotation(String)

Remove a anotação de runtime fornecida desse objeto.

(Herdado de IAnnotatable)
SetAnnotation(String, Object, Boolean)

Define a anotação armazenada sob o nome fornecido. Substitui a anotação existente se já existir uma anotação com o nome especificado.

(Herdado de IConventionAnnotatable)
SetIsDescending(IReadOnlyList<Boolean>, Boolean)

Define as ordem de classificação para esse índice (crescente ou decrescente).

SetIsUnique(Nullable<Boolean>, Boolean)

Define um valor que indica se os valores atribuídos às propriedades de índice são exclusivos.

SetOrRemoveAnnotation(String, Object, Boolean)

Define a anotação armazenada sob o nome fornecido. Substitui a anotação existente se já existir uma anotação com o nome especificado. Remove a anotação existente se null for fornecida.

(Herdado de IConventionAnnotatable)
SetRuntimeAnnotation(String, Object)

Define a anotação de runtime armazenada sob a chave fornecida. Substitui a anotação existente se já existir uma anotação com o nome especificado.

(Herdado de IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)

Cria uma representação legível por humanos dos metadados especificados.

Aviso: não dependa do formato da cadeia de caracteres retornada. Ele foi projetado apenas para depuração e pode mudar arbitrariamente entre as versões.

(Herdado de IReadOnlyIndex)

Métodos de Extensão

AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)

Adiciona anotações a um objeto .

GetAnnotation(IConventionAnnotatable, String)

Obtém a anotação com o nome fornecido, lançando se ela não existir.

SetOrRemoveAnnotation(IConventionAnnotatable, String, Object, Boolean)

Define a anotação armazenada sob o nome fornecido. Substitui a anotação existente se já existir uma anotação com o nome especificado. Remove a anotação existente se null for fornecida.

GetNullableValueFactory<TKey>(IIndex)

Obtém uma fábrica para valores de chave com base nos valores de chave de índice obtidos de várias formas de dados de entidade.

Esse método normalmente é usado por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

ToDebugString(IIndex, MetadataDebugStringOptions, Int32)

Cria uma representação legível por humanos dos metadados especificados.

Aviso: não dependa do formato da cadeia de caracteres retornada. Ele foi projetado apenas para depuração e pode mudar arbitrariamente entre as versões.

AnnotationsToDebugString(IAnnotatable, Int32)

Obtém a cadeia de caracteres de depuração para todas as anotações declaradas no objeto .

GetAnnotation(IAnnotatable, String)

Obtém a anotação com o nome fornecido, lançando se ela não existir.

FindSharedObjectRootIndex(IConventionIndex, StoreObjectIdentifier)

Localiza o primeiro IConventionIndex mapeado para o mesmo índice em um objeto semelhante a uma tabela compartilhada.

Esse método normalmente é usado por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

FindSharedObjectRootIndex(IIndex, StoreObjectIdentifier)

Localiza o primeiro IConventionIndex mapeado para o mesmo índice em um objeto semelhante a uma tabela compartilhada.

Esse método normalmente é usado por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)

Localiza o primeiro IIndex mapeado para o mesmo índice em um objeto semelhante a uma tabela compartilhada.

Esse método normalmente é usado por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

GetDatabaseName(IIndex)

Retorna o nome do índice no banco de dados.

GetDatabaseName(IIndex, StoreObjectIdentifier)

Retorna o nome do índice no banco de dados.

GetDatabaseName(IReadOnlyIndex)

Retorna o nome do índice no banco de dados.

GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)

Retorna o nome do índice no banco de dados.

GetDatabaseNameConfigurationSource(IConventionIndex)

Obtém o ConfigurationSource para o nome do índice no banco de dados.

GetDefaultDatabaseName(IIndex)

Retorna o nome padrão que seria usado para esse índice.

GetDefaultDatabaseName(IIndex, StoreObjectIdentifier)

Retorna o nome padrão que seria usado para esse índice.

GetDefaultDatabaseName(IReadOnlyIndex)

Retorna o nome padrão que seria usado para esse índice.

GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)

Retorna o nome padrão que seria usado para esse índice.

GetDefaultName(IIndex)
Obsoleto..

Retorna o nome padrão que seria usado para esse índice.

GetFilter(IIndex)

Retorna a expressão de filtro de índice.

GetFilter(IIndex, StoreObjectIdentifier)

Retorna a expressão de filtro de índice.

GetFilter(IReadOnlyIndex)

Retorna a expressão de filtro de índice.

GetFilter(IReadOnlyIndex, StoreObjectIdentifier)

Retorna a expressão de filtro de índice.

GetFilterConfigurationSource(IConventionIndex)

Obtém o ConfigurationSource para a expressão de filtro de índice.

GetMappedTableIndexes(IIndex)

Obtém os índices de tabela para os quais o índice é mapeado.

GetName(IIndex)
Obsoleto..

Retorna o nome do índice no banco de dados.

GetNameConfigurationSource(IConventionIndex)
Obsoleto..

Obtém o ConfigurationSource para o nome do índice no banco de dados.

SetDatabaseName(IConventionIndex, String, Boolean)

Define o nome do índice no banco de dados.

SetFilter(IConventionIndex, String, Boolean)

Define a expressão de filtro de índice.

SetName(IConventionIndex, String, Boolean)
Obsoleto..

Define o nome do índice no banco de dados.

GetDataCompression(IReadOnlyIndex)

Retorna a compactação de dados que o índice usa.

GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)

Retorna a compactação de dados que o índice usa.

GetDataCompressionConfigurationSource(IConventionIndex)

Retorna o ConfigurationSource para a compactação de dados que o índice usa.

GetFillFactor(IIndex)

Retorna um valor que indica se o índice usa o fator de preenchimento.

GetFillFactor(IReadOnlyIndex)

Retorna o fator de preenchimento usado pelo índice.

GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)

Retorna o fator de preenchimento usado pelo índice.

GetFillFactorConfigurationSource(IConventionIndex)

Retorna o ConfigurationSource para se o índice usa o fator de preenchimento.

GetIncludeProperties(IIndex)

Retorna nomes de propriedade incluídos ou null se eles não foram especificados.

GetIncludeProperties(IReadOnlyIndex)

Retorna nomes de propriedade incluídos ou null se eles não foram especificados.

GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier)

Retorna nomes de propriedade incluídos ou null se eles não foram especificados.

GetIncludePropertiesConfigurationSource(IConventionIndex)

Retorna o ConfigurationSource para os nomes de propriedade incluídos.

GetIsClusteredConfigurationSource(IConventionIndex)

Retorna o ConfigurationSource para se o índice está clusterizado.

GetIsCreatedOnlineConfigurationSource(IConventionIndex)

Retorna o ConfigurationSource para se o índice está online.

GetSortInTempDb(IReadOnlyIndex)

Retorna um valor que indica se o índice é classificado em tempdb.

GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)

Retorna um valor que indica se o índice é classificado em tempdb.

GetSortInTempDbConfigurationSource(IConventionIndex)

Retorna o ConfigurationSource para se o índice é classificado em tempdb.

IsClustered(IIndex)

Retorna um valor que indica se o índice está clusterizado.

IsClustered(IIndex, StoreObjectIdentifier)

Retorna um valor que indica se o índice está clusterizado.

IsClustered(IReadOnlyIndex)

Retorna um valor que indica se o índice está clusterizado.

IsClustered(IReadOnlyIndex, StoreObjectIdentifier)

Retorna um valor que indica se o índice está clusterizado.

IsCreatedOnline(IIndex)

Retorna um valor que indica se o índice está online.

IsCreatedOnline(IReadOnlyIndex)

Retorna um valor que indica se o índice está online.

IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier)

Retorna um valor que indica se o índice está online.

SetDataCompression(IConventionIndex, Nullable<DataCompressionType>, Boolean)

Define um valor que indica a compactação de dados que o índice usa.

SetFillFactor(IConventionIndex, Nullable<Int32>, Boolean)

Define um valor que indica se o índice usa o fator de preenchimento.

SetIncludeProperties(IConventionIndex, IReadOnlyList<String>, Boolean)

Os conjuntos incluíam nomes de propriedade.

SetIsClustered(IConventionIndex, Nullable<Boolean>, Boolean)

Define um valor que indica se o índice está clusterizado.

SetIsCreatedOnline(IConventionIndex, Nullable<Boolean>, Boolean)

Define um valor que indica se o índice está online.

SetSortInTempDb(IConventionIndex, Nullable<Boolean>, Boolean)

Define um valor que indica se o índice é classificado em tempdb.

Aplica-se a