IReadOnlyProperty Interface

Definição

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Pacote:

Microsoft.EntityFrameworkCore v8.0.0

Representa uma propriedade escalar de um tipo estrutural.

public interface IReadOnlyProperty : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyPropertyBase

type IReadOnlyProperty = interface
    interface IReadOnlyPropertyBase
    interface IReadOnlyAnnotatable

Public Interface IReadOnlyProperty
Implements IReadOnlyPropertyBase

Derivado

Microsoft.EntityFrameworkCore.Metadata.IConventionProperty

Microsoft.EntityFrameworkCore.Metadata.IMutableProperty

Microsoft.EntityFrameworkCore.Metadata.IProperty

Microsoft.EntityFrameworkCore.Metadata.RuntimeProperty

Implementações

IReadOnlyAnnotatable IReadOnlyPropertyBase

Comentários

Confira Modelagem de tipos de entidade e relações para obter mais informações e exemplos.

Propriedades

ClrType	Obtém o tipo de valor que esse objeto semelhante à propriedade contém. (Herdado de IReadOnlyPropertyBase)
DeclaringEntityType	Obsoleto.. Obtém o tipo de entidade ao qual essa propriedade pertence.
DeclaringType	Obtém o tipo ao qual este objeto semelhante à propriedade pertence. (Herdado de IReadOnlyPropertyBase)
FieldInfo	Obtém o FieldInfo para o campo CLR subjacente para esse objeto semelhante a uma propriedade. Isso pode ser null para propriedades de sombra ou se o campo de suporte não for conhecido. (Herdado de IReadOnlyPropertyBase)
IsConcurrencyToken	Obtém um valor que indica se essa propriedade é usada como um token de simultaneidade. Quando uma propriedade é configurada como um token de simultaneidade, o valor no banco de dados será verificado quando uma instância desse tipo de entidade for atualizada ou excluída durante SaveChanges() para garantir que ela não tenha sido alterada desde que a instância foi recuperada do banco de dados. Se ele tiver sido alterado, uma exceção será gerada e as alterações não serão aplicadas ao banco de dados.
IsNullable	Obtém um valor que indica se essa propriedade pode conter null.
IsPrimitiveCollection	Uma propriedade será uma coleção primitiva se tiver um tipo de elemento que corresponda ao tipo de elemento do tipo CLR.
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 objeto semelhante a uma propriedade. (Herdado de IReadOnlyPropertyBase)
PropertyInfo	Obtém o PropertyInfo da propriedade CLR subjacente para esse objeto semelhante a uma propriedade. Isso pode ser null para propriedades de sombra ou se mapeadas diretamente para um campo. (Herdado de IReadOnlyPropertyBase)
Sentinel	Obtém o valor sentinela que indica que essa propriedade não está definida. (Herdado de IReadOnlyPropertyBase)
ValueGenerated	Obtém um valor que indica quando um valor para essa propriedade será gerado pelo banco de dados. Mesmo quando a propriedade é definida para ser gerada pelo banco de dados, o EF ainda pode tentar salvar um valor específico (em vez de ter um gerado pelo banco de dados) quando a entidade é adicionada e um valor é atribuído ou a propriedade é marcada como modificada para uma entidade existente. Confira GetBeforeSaveBehavior() e GetAfterSaveBehavior() para obter mais informações e exemplos.

Métodos

AnnotationsToDebugString(Int32)	Obtém a cadeia de caracteres de depuração para todas as anotações declaradas no objeto . (Herdado de IReadOnlyAnnotatable)
FindAnnotation(String)	Obtém a anotação com o nome fornecido, retornando null se ela não existir. (Herdado de IReadOnlyAnnotatable)
FindContainingPrimaryKey()	Obtém a chave primária que usa essa propriedade (incluindo uma chave primária composta na qual essa propriedade está incluída).
FindFirstPrincipal()	Localiza a primeira propriedade principal pela qual a propriedade fornecida será restrita se a propriedade fornecida fizer parte de uma chave estrangeira.
FindTypeMapping()	Retorna o mapeamento de tipo para essa propriedade.
GetAfterSaveBehavior()	Obtém um valor que indica se essa propriedade pode ou não ser modificada depois que a entidade é salva no banco de dados.
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)
GetBeforeSaveBehavior()	Obtém um valor que indica se essa propriedade pode ou não ser modificada antes que a entidade seja salva no banco de dados.
GetContainingForeignKeys()	Obtém todas as chaves estrangeiras que usam essa propriedade (incluindo chaves estrangeiras compostas nas quais essa propriedade está incluída).
GetContainingIndexes()	Obtém todos os índices que usam essa propriedade (incluindo índices compostos nos quais essa propriedade está incluída).
GetContainingKeys()	Obtém todas as chaves primárias ou alternativas que usam essa propriedade (incluindo chaves compostas nas quais essa propriedade está incluída).
GetElementType()	Obtém a configuração para elementos da coleção primitiva representada por essa propriedade.
GetFieldName()	Obtém o nome do campo de suporte para essa propriedade ou null se o campo de suporte não é conhecido. (Herdado de IReadOnlyPropertyBase)
GetJsonValueReaderWriter()	Obtém o JsonValueReaderWriter para essa propriedade ou null se nenhum estiver definido.
GetKeyValueComparer()	Obtém o ValueComparer a ser usado com chaves para essa propriedade ou null se nenhum estiver definido.
GetMaxLength()	Obtém o comprimento máximo dos dados permitidos nesta propriedade. Por exemplo, se a propriedade for um String , esse será o número máximo de caracteres.
GetPrecision()	Obtém a precisão dos dados permitidos nesta propriedade. Por exemplo, se a propriedade for um Decimal , esse será o número máximo de dígitos.
GetPrincipals()	Localiza a lista de propriedades principais, incluindo a propriedade fornecida pela qual a propriedade fornecida é restrita se a propriedade fornecida fizer parte de uma chave estrangeira.
GetPrincipals<T>()	Localiza a lista de propriedades principais, incluindo a propriedade fornecida pela qual a propriedade fornecida é restrita se a propriedade fornecida fizer parte de uma chave estrangeira.
GetPropertyAccessMode()	Obtém o PropertyAccessMode que está sendo usado para esse objeto semelhante a uma propriedade. (Herdado de IReadOnlyPropertyBase)
GetProviderClrType()	Obtém o tipo para o qual o valor da propriedade será convertido antes de ser enviado ao provedor de banco de dados.
GetProviderValueComparer()	Obtém o ValueComparer a ser usado para os valores do provedor para essa propriedade.
GetScale()	Obtém a escala de dados permitida nessa propriedade. Por exemplo, se a propriedade for um Decimal , esse será o número máximo de casas decimais.
GetTypeMapping()	Retorna o CoreTypeMapping para a propriedade fornecida de um modelo finalizado.
GetValueComparer()	Obtém o ValueComparer para essa propriedade ou null se nenhum estiver definido.
GetValueConverter()	Obtém o conjunto personalizado ValueConverter para essa propriedade.
GetValueGeneratorFactory()	Obtém a fábrica que foi definida para gerar valores para essa propriedade, se houver.
IsForeignKey()	Obtém um valor que indica se essa propriedade é usada como uma chave estrangeira (ou parte de uma chave estrangeira composta).
IsIndex()	Obtém um valor que indica se essa propriedade é usada como um índice (ou parte de um índice composto).
IsIndexerProperty()	Obtém um valor que indica se esta é uma propriedade do indexador. Uma propriedade do indexador é aquela que é acessada por meio de um indexador na classe de entidade. (Herdado de IReadOnlyPropertyBase)
IsKey()	Obtém um valor que indica se essa propriedade é usada como chave primária ou chave alternativa (ou parte de uma chave primária ou alternativa composta).
IsPrimaryKey()	Obtém um valor que indica se essa propriedade é usada como a chave primária (ou parte de uma chave primária composta).
IsShadowProperty()	Obtém um valor que indica se esta é uma propriedade de sombra. Uma propriedade de sombra é aquela que não tem uma propriedade correspondente na classe de entidade. O valor atual da propriedade é armazenado no em ChangeTracker vez de ser armazenado em instâncias da classe de entidade. (Herdado de IReadOnlyPropertyBase)
IsUnicode()	Obtém um valor que indica se a propriedade pode ou não persistir caracteres Unicode.
IsUniqueIndex()	Obtém um valor que indica se essa propriedade é usada como um índice exclusivo (ou parte de um índice composto exclusivo).
ToDebugString(MetadataDebugStringOptions, Int32)	Cria uma representação legível por humanos dos metadados determinados. 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.

Métodos de Extensão

GetJsonPropertyName(IReadOnlyProperty)	Retorna o nome da propriedade para o qual a propriedade é mapeada ao direcionar o Cosmos.
FindOverrides(IReadOnlyProperty, StoreObjectIdentifier)	Retorna as substituições de faceta de propriedade para um objeto de repositório semelhante a uma tabela específica. 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.
FindRelationalTypeMapping(IReadOnlyProperty)	Retorna o RelationalTypeMapping para a propriedade fornecida em um modelo finalizado.
FindRelationalTypeMapping(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o RelationalTypeMapping para a propriedade fornecida em um modelo finalizado.
FindSharedStoreObjectRootProperty(IReadOnlyProperty, StoreObjectIdentifier)	Localiza o primeiro IProperty mapeado para a mesma coluna em um objeto de 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.
GetCollation(IReadOnlyProperty)	Retorna a ordenação a ser usada para a coluna.
GetCollation(IReadOnlyProperty, StoreObjectIdentifier)	Retorna a ordenação a ser usada para a coluna.
GetColumnBaseName(IReadOnlyProperty)	Obsoleto.. Retorna o nome base da coluna para a qual a propriedade seria mapeada.
GetColumnName(IReadOnlyProperty)	Retorna o nome da coluna para a qual a propriedade seria mapeada.
GetColumnName(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o nome da coluna para a qual a propriedade é mapeada para uma tabela específica.
GetColumnOrder(IReadOnlyProperty)	Retorna a ordem da coluna para a qual essa propriedade é mapeada.
GetColumnOrder(IReadOnlyProperty, StoreObjectIdentifier)	Retorna a ordem da coluna para a qual essa propriedade é mapeada para uma tabela específica.
GetColumnType(IReadOnlyProperty)	Retorna o tipo de banco de dados da coluna para a qual a propriedade é mapeada ou null se o tipo de banco de dados não pôde ser encontrado.
GetColumnType(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o tipo de banco de dados da coluna para a qual a propriedade é mapeada ou null se o tipo de banco de dados não pôde ser encontrado.
GetComment(IReadOnlyProperty)	Retorna o comentário da coluna para a qual essa propriedade é mapeada.
GetComment(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o comentário da coluna para a qual essa propriedade é mapeada.
GetComputedColumnSql(IReadOnlyProperty)	Retorna a expressão SQL usada como o valor calculado para a coluna para a qual essa propriedade é mapeada.
GetComputedColumnSql(IReadOnlyProperty, StoreObjectIdentifier)	Retorna a expressão SQL usada como o valor calculado para a coluna para a qual essa propriedade é mapeada.
GetDefaultColumnBaseName(IReadOnlyProperty)	Obsoleto.. Retorna o nome base padrão da coluna para a qual a propriedade seria mapeada
GetDefaultColumnName(IReadOnlyProperty)	Retorna o nome base padrão da coluna para a qual a propriedade seria mapeada
GetDefaultColumnName(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o nome da coluna padrão para o qual a propriedade seria mapeada.
GetDefaultValue(IReadOnlyProperty)	Retorna o objeto usado como o valor padrão para a coluna para a qual essa propriedade é mapeada.
GetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o objeto usado como o valor padrão para a coluna para a qual essa propriedade é mapeada.
GetDefaultValueSql(IReadOnlyProperty)	Retorna a expressão SQL usada como o valor padrão para a coluna para a qual essa propriedade é mapeada.
GetDefaultValueSql(IReadOnlyProperty, StoreObjectIdentifier)	Retorna a expressão SQL usada como o valor padrão para a coluna para a qual essa propriedade é mapeada.
GetIsStored(IReadOnlyProperty)	Obtém se o valor da coluna computada para a qual essa propriedade é mapeada é armazenado no banco de dados ou calculado quando ele é lido.
GetIsStored(IReadOnlyProperty, StoreObjectIdentifier)	Obtém se o valor da coluna computada para a qual essa propriedade é mapeada é armazenado no banco de dados ou calculado quando ele é lido.
GetJsonPropertyName(IReadOnlyProperty)	Obtém o valor do nome da propriedade JSON usado para a propriedade fornecida de uma entidade mapeada para uma coluna JSON.
GetMappedStoreObjects(IReadOnlyProperty, StoreObjectType)	Retorna os objetos de repositório semelhantes à tabela para os quais essa propriedade é mapeada. 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.
GetMaxLength(IReadOnlyProperty, StoreObjectIdentifier)	Obtém o comprimento máximo dos dados permitidos nesta propriedade. Por exemplo, se a propriedade for um String , esse será o número máximo de caracteres.
GetOverrides(IReadOnlyProperty)	Retorna todas as substituições de faceta de propriedade. 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.
GetPrecision(IReadOnlyProperty, StoreObjectIdentifier)	Obtém a precisão dos dados permitidos nesta propriedade. Por exemplo, se a propriedade for um Decimal , esse será o número máximo de dígitos.
GetRelationalTypeMapping(IReadOnlyProperty)	Retorna o RelationalTypeMapping para a propriedade fornecida em um modelo finalizado.
GetScale(IReadOnlyProperty, StoreObjectIdentifier)	Obtém a escala de dados permitida nessa propriedade. Por exemplo, se a propriedade for um Decimal , esse será o número máximo de casas decimais.
IsColumnNullable(IReadOnlyProperty)	Verifica se a coluna mapeada para o determinado IProperty será anulável quando criada no banco de dados.
IsColumnNullable(IReadOnlyProperty, StoreObjectIdentifier)	Verifica se a coluna mapeada para a propriedade fornecida será anulável quando criada no banco de dados.
IsFixedLength(IReadOnlyProperty)	Retorna um sinalizador que indica se a propriedade é capaz de armazenar apenas dados de comprimento fixo, como cadeias de caracteres.
IsFixedLength(IReadOnlyProperty, StoreObjectIdentifier)	Retorna um sinalizador que indica se a propriedade é capaz de armazenar apenas dados de comprimento fixo, como cadeias de caracteres.
IsUnicode(IReadOnlyProperty, StoreObjectIdentifier)	Obtém um valor que indica se a propriedade pode ou não persistir caracteres Unicode.
TryGetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier, Object)	Retorna o objeto usado como o valor padrão para a coluna para a qual essa propriedade é mapeada.
TryGetDefaultValue(IReadOnlyProperty, Object)	Retorna o objeto usado como o valor padrão para a coluna para a qual essa propriedade é mapeada.
GetSrid(IReadOnlyProperty)	Retorna o SRID a ser usado ao criar uma coluna para essa propriedade.
GetSrid(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o SRID a ser usado ao criar uma coluna para essa propriedade.
FindHiLoSequence(IReadOnlyProperty)	Localiza o ISequence no modelo a ser usado para o padrão hi-lo.
FindHiLoSequence(IReadOnlyProperty, StoreObjectIdentifier)	Localiza o ISequence no modelo a ser usado para o padrão hi-lo.
FindSequence(IReadOnlyProperty)	Localiza o ISequence no modelo a ser usado para o padrão de geração de valor de chave.
FindSequence(IReadOnlyProperty, StoreObjectIdentifier)	Localiza o ISequence no modelo a ser usado para o padrão de geração de valor de chave.
GetHiLoSequenceName(IReadOnlyProperty)	Retorna o nome a ser usado para a sequência hi-lo.
GetHiLoSequenceName(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o nome a ser usado para a sequência hi-lo.
GetHiLoSequenceSchema(IReadOnlyProperty)	Retorna o esquema a ser usado para a sequência hi-lo.
GetHiLoSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o esquema a ser usado para a sequência hi-lo.
GetIdentityIncrement(IReadOnlyProperty)	Retorna o incremento de identidade.
GetIdentityIncrement(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o incremento de identidade.
GetIdentitySeed(IReadOnlyProperty)	Retorna a semente de identidade.
GetIdentitySeed(IReadOnlyProperty, StoreObjectIdentifier)	Retorna a semente de identidade.
GetSequenceName(IReadOnlyProperty)	Retorna o nome a ser usado para a sequência de geração de valor de chave.
GetSequenceName(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o nome a ser usado para a sequência de geração de valor de chave.
GetSequenceSchema(IReadOnlyProperty)	Retorna o esquema a ser usado para a sequência de geração de valor de chave.
GetSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o esquema a ser usado para a sequência de geração de valor de chave.
GetValueGenerationStrategy(IReadOnlyProperty)	Retorna o SqlServerValueGenerationStrategy a ser usado para a propriedade .
GetValueGenerationStrategy(IReadOnlyProperty, StoreObjectIdentifier)	Retorna o SqlServerValueGenerationStrategy a ser usado para a propriedade .
IsSparse(IReadOnlyProperty)	Retorna um valor que indica se a coluna da propriedade é esparsa.
IsSparse(IReadOnlyProperty, StoreObjectIdentifier)	Retorna um valor que indica se a coluna da propriedade é esparsa.