IConventionPropertyBuilder Interface

Definição

Namespace:

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly:

Microsoft.EntityFrameworkCore.dll

Pacote:

Microsoft.EntityFrameworkCore v8.0.0

Fornece uma superfície de API simples para configurar um IConventionProperty a partir de convenções.

Normalmente, essa interface é usada por provedores de banco de dados (e outras extensões). Geralmente, ele não é usado no código do aplicativo.

public interface IConventionPropertyBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBaseBuilder<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder>

type IConventionPropertyBuilder = interface
    interface IConventionPropertyBaseBuilder<IConventionPropertyBuilder>
    interface IConventionAnnotatableBuilder

Public Interface IConventionPropertyBuilder
Implements IConventionPropertyBaseBuilder(Of IConventionPropertyBuilder)

Implementações

IConventionAnnotatableBuilder IConventionPropertyBaseBuilder<IConventionPropertyBuilder>

Comentários

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

Propriedades

Metadata	Obtém a propriedade que está sendo configurada.
ModelBuilder	Obtém o construtor de modelos. (Herdado de IConventionAnnotatableBuilder)

Métodos

AfterSave(Nullable<PropertySaveBehavior>, Boolean)	Configura se essa propriedade pode ser modificada depois que a entidade é salva no banco de dados.
BeforeSave(Nullable<PropertySaveBehavior>, Boolean)	Configura se essa propriedade pode ser modificada antes que a entidade seja salva no banco de dados.
CanRemoveAnnotation(String, Boolean)	Retorna um valor que indica se uma anotação com o nome fornecido pode ser removida usando essa origem de configuração. (Herdado de IConventionAnnotatableBuilder)
CanSetAfterSave(Nullable<PropertySaveBehavior>, Boolean)	Retorna um valor que indica se a capacidade de ser modificada depois que a entidade é salva no banco de dados pode ser configurada para essa propriedade da fonte de configuração atual.
CanSetAnnotation(String, Object, Boolean)	Retorna um valor que indica se uma anotação com o nome e o valor fornecidos pode ser definida nessa fonte de configuração. (Herdado de IConventionAnnotatableBuilder)
CanSetBeforeSave(Nullable<PropertySaveBehavior>, Boolean)	Retorna um valor que indica se a capacidade de ser modificada antes que a entidade seja salva no banco de dados pode ser configurada para essa propriedade da fonte de configuração atual.
CanSetConversion(Type, Boolean)	Retorna um valor que indica se o tipo fornecido para converter valores de e para pode ser configurado para essa propriedade a partir da fonte de configuração atual.
CanSetConversion(ValueConverter, Boolean)	Retorna um valor que indica se o ValueConverter pode ser configurado para essa propriedade da fonte de configuração atual.
CanSetConverter(Type, Boolean)	Retorna um valor que indica se o ValueConverter pode ser configurado para essa propriedade da fonte de configuração atual.
CanSetElementType(Type, Boolean)	Essa é uma API interna que dá suporte à infraestrutura do Entity Framework Core e não está sujeita aos mesmos padrões de compatibilidade que as APIs públicas. Ele pode ser alterado ou removido sem aviso prévio em qualquer versão. Você só deve usá-lo diretamente em seu código com extrema cautela e saber que fazer isso pode resultar em falhas de aplicativo ao atualizar para uma nova versão do Entity Framework Core.
CanSetIsConcurrencyToken(Nullable<Boolean>, Boolean)	Retorna um valor que indica se a propriedade pode ser configurada como um token de simultaneidade da fonte de configuração atual.
CanSetIsRequired(Nullable<Boolean>, Boolean)	Retorna um valor que indica se essa propriedade requiredness pode ser configurada a partir da fonte de configuração atual.
CanSetIsUnicode(Nullable<Boolean>, Boolean)	Retorna um valor que indica se a propriedade pode ser configurada como capaz de persistir caracteres unicode da fonte de configuração atual.
CanSetMaxLength(Nullable<Int32>, Boolean)	Retorna um valor que indica se o comprimento máximo de dados permitidos pode ser definido para essa propriedade da fonte de configuração atual.
CanSetPrecision(Nullable<Int32>, Boolean)	Retorna um valor que indica se a precisão dos dados permitidos pode ser definida para essa propriedade da fonte de configuração atual.
CanSetProviderValueComparer(Type, Boolean)	Retorna um valor que indica se o determinado ValueComparer pode ser configurado para essa propriedade a partir da fonte de configuração atual.
CanSetProviderValueComparer(ValueComparer, Boolean)	Retorna um valor que indica se o determinado ValueComparer pode ser configurado para essa propriedade a partir da fonte de configuração atual.
CanSetScale(Nullable<Int32>, Boolean)	Retorna um valor que indica se a escala de dados permitida pode ser definida para essa propriedade da fonte de configuração atual.
CanSetSentinel(Object, Boolean)	Retorna um valor que indica se o sentinela pode ser definido para essa propriedade da origem de configuração atual.
CanSetTypeMapping(CoreTypeMapping, Boolean)	Retorna um valor que indica se o determinado CoreTypeMapping pode ser configurado para essa propriedade a partir da fonte de configuração atual.
CanSetValueComparer(Type, Boolean)	Retorna um valor que indica se o determinado ValueComparer pode ser configurado para essa propriedade a partir da fonte de configuração atual.
CanSetValueComparer(ValueComparer, Boolean)	Retorna um valor que indica se o determinado ValueComparer pode ser configurado para essa propriedade a partir da fonte de configuração atual.
CanSetValueGenerated(Nullable<ValueGenerated>, Boolean)	Retorna um valor que indica se a geração de valor da propriedade pode ser configurada a partir da fonte de configuração atual.
CanSetValueGenerator(Func<IProperty,ITypeBase,ValueGenerator>, Boolean)	Retorna um valor que indica se o ValueGenerator pode ser configurado para essa propriedade da fonte de configuração atual.
CanSetValueGeneratorFactory(Type, Boolean)	Retorna um valor que indica se o ValueGeneratorFactory pode ser configurado para essa propriedade da fonte de configuração atual.
HasAnnotation(String, Object, Boolean)	Define a anotação armazenada sob o nome fornecido. Substitui a anotação existente se uma anotação com o nome especificado já existir com o mesmo ou inferior ConfigurationSource. (Herdado de IConventionPropertyBaseBuilder<TBuilder>)
HasConversion(Type, Boolean)	Configura a propriedade para que o valor da propriedade seja convertido no tipo fornecido antes de gravar no banco de dados e convertido novamente ao ler do banco de dados.
HasConversion(ValueConverter, Boolean)	Configura a propriedade para que o valor da propriedade seja convertido de e para o banco de dados usando o fornecido ValueConverter.
HasConverter(Type, Boolean)	Configura a propriedade para que o valor da propriedade seja convertido de e para o banco de dados usando o fornecido ValueConverter.
HasMaxLength(Nullable<Int32>, Boolean)	Configura o comprimento máximo dos dados que podem ser armazenados nessa propriedade.
HasNoAnnotation(String, Boolean)	Remove a anotação com o nome fornecido desse objeto. (Herdado de IConventionPropertyBaseBuilder<TBuilder>)
HasNonNullAnnotation(String, Object, Boolean)	Define a anotação armazenada sob o nome fornecido. Substitui a anotação existente se uma anotação com o nome especificado já existir com o mesmo ou inferior ConfigurationSource. Remove a anotação se null o valor for especificado. (Herdado de IConventionPropertyBaseBuilder<TBuilder>)
HasPrecision(Nullable<Int32>, Boolean)	Configura a precisão da propriedade .
HasProviderValueComparer(Type, Boolean)	Configura o ValueComparer a ser usado para os valores do provedor para essa propriedade.
HasProviderValueComparer(ValueComparer, Boolean)	Configura o ValueComparer a ser usado para os valores do provedor para essa propriedade.
HasScale(Nullable<Int32>, Boolean)	Configura a escala da propriedade .
HasSentinel(Object, Boolean)	Configura o valor que será usado para determinar se a propriedade foi definida ou não. Se a propriedade for definida como o valor sentinela, ela será considerada não definida. Por padrão, o valor sentinela é o valor padrão CLR para o tipo da propriedade.
HasTypeMapping(CoreTypeMapping, Boolean)	Configura o CoreTypeMapping para essa propriedade.
HasValueComparer(Type, Boolean)	Configura o ValueComparer para essa propriedade.
HasValueComparer(ValueComparer, Boolean)	Configura o ValueComparer para essa propriedade.
HasValueGenerator(Func<IProperty,ITypeBase,ValueGenerator>, Boolean)	Configura o ValueGenerator que gerará valores para essa propriedade.
HasValueGenerator(Type, Boolean)	Configura o ValueGenerator que gerará valores para essa propriedade.
HasValueGeneratorFactory(Type, Boolean)	Configura o ValueGeneratorFactory para criar um ValueGenerator que gerará valores para essa propriedade.
IsConcurrencyToken(Nullable<Boolean>, Boolean)	Configura se essa propriedade deve ser 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.
IsRequired(Nullable<Boolean>, Boolean)	Configura se essa propriedade deve ter um valor atribuído ou null se é um valor válido. Uma propriedade só poderá ser configurada como não obrigatória se for baseada em um tipo CLR que possa ser atribuído nulla .
IsUnicode(Nullable<Boolean>, Boolean)	Configura se a propriedade é capaz de persistir caracteres unicode.
SetElementType(Type, Boolean)	Essa é uma API interna que dá suporte à infraestrutura do Entity Framework Core e não está sujeita aos mesmos padrões de compatibilidade que as APIs públicas. Ele pode ser alterado ou removido sem aviso prévio em qualquer versão. Você só deve usá-lo diretamente em seu código com extrema cautela e saber que fazer isso pode resultar em falhas de aplicativo ao atualizar para uma nova versão do Entity Framework Core.
ValueGenerated(Nullable<ValueGenerated>, Boolean)	Define 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 de Extensão

CanSetJsonProperty(IConventionPropertyBuilder, String, Boolean)	Retorna um valor que indica se o nome da propriedade determinado pode ser definido.
ToJsonProperty(IConventionPropertyBuilder, String, Boolean)	Configura o nome da propriedade para o qual a propriedade é mapeada ao direcionar para o Azure Cosmos. Se uma cadeia de caracteres vazia for fornecida, a propriedade não será mantida.
CanSetCollation(IConventionPropertyBuilder, String, Boolean)	Retorna um valor que indica se o valor fornecido pode ser definido como a ordenação.
CanSetColumnName(IConventionPropertyBuilder, String, StoreObjectIdentifier, Boolean)	Retorna um valor que indica se a coluna fornecida para um objeto de repositório semelhante a uma tabela específica pode ser definida para a propriedade .
CanSetColumnName(IConventionPropertyBuilder, String, Boolean)	Retorna um valor que indica se a coluna determinada pode ser definida para a propriedade .
CanSetColumnOrder(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Obtém um valor que indica se a ordem de coluna determinada pode ser definida para a propriedade .
CanSetColumnType(IConventionPropertyBuilder, String, Boolean)	Retorna um valor que indica se o tipo de dados fornecido pode ser definido para a propriedade .
CanSetComment(IConventionPropertyBuilder, String, Boolean)	Retorna um valor que indica se o valor fornecido pode ser definido como comentário para a coluna.
CanSetComputedColumnSql(IConventionPropertyBuilder, String, Boolean)	Retorna um valor que indica se a expressão SQL de valor computado fornecida pode ser definida para a coluna.
CanSetDefaultValue(IConventionPropertyBuilder, Object, Boolean)	Retorna um valor que indica se o valor fornecido pode ser definido como padrão para a coluna.
CanSetDefaultValueSql(IConventionPropertyBuilder, String, Boolean)	Retorna um valor que indica se a expressão de valor padrão fornecida pode ser definida para a coluna.
CanSetIsFixedLength(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Retorna um valor que indica se a propriedade pode ser configurada como sendo de comprimento fixo ou não.
CanSetIsStoredComputedColumn(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Retorna um valor que indica se o tipo de coluna computada fornecido pode ser definido para a coluna.
CanSetJsonPropertyName(IConventionPropertyBuilder, String, Boolean)	Retorna um valor que indica se o valor fornecido pode ser usado como um nome de propriedade JSON para uma determinada propriedade de entidade.
HasColumnName(IConventionPropertyBuilder, String, StoreObjectIdentifier, Boolean)	Configura a coluna para a qual a propriedade mapeia em um objeto de repositório semelhante a uma tabela específica.
HasColumnName(IConventionPropertyBuilder, String, Boolean)	Configura a coluna para a qual a propriedade é mapeada ao direcionar um banco de dados relacional.
HasColumnOrder(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Configura a ordem da coluna para a qual a propriedade é mapeada.
HasColumnType(IConventionPropertyBuilder, String, Boolean)	Configura o tipo de dados da coluna para a qual a propriedade mapeia ao direcionar um banco de dados relacional. Esse deve ser o nome de tipo completo, incluindo precisão, escala, comprimento etc.
HasComment(IConventionPropertyBuilder, String, Boolean)	Configura um comentário a ser aplicado à coluna
HasComputedColumnSql(IConventionPropertyBuilder, String, Boolean)	Configura a propriedade a ser mapeada para uma coluna computada ao direcionar um banco de dados relacional.
HasDefaultValue(IConventionPropertyBuilder, Object, Boolean)	Configura o valor padrão para a coluna para a qual a propriedade mapeia ao direcionar um banco de dados relacional.
HasDefaultValueSql(IConventionPropertyBuilder, String, Boolean)	Configura a expressão de valor padrão para a coluna para a qual a propriedade mapeia ao direcionar um banco de dados relacional.
HasJsonPropertyName(IConventionPropertyBuilder, String, Boolean)	Configura a propriedade de uma entidade mapeada para uma coluna JSON, mapeando a propriedade da entidade para uma propriedade JSON específica, em vez de usar o nome da propriedade da entidade.
IsFixedLength(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Configura a propriedade como capaz de armazenar apenas dados de comprimento fixo, como cadeias de caracteres.
IsStoredComputedColumn(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Configura a propriedade a ser mapeada para uma coluna computada do tipo especificado ao direcionar um banco de dados relacional.
UseCollation(IConventionPropertyBuilder, String, Boolean)	Configura a propriedade para usar a ordenação fornecida. A coluna de banco de dados será criada com a ordenação fornecida e será usada implicitamente em todas as operações sensíveis à ordenação.
CanSetSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Retorna um valor que indica se o valor fornecido pode ser definido como SRID para a coluna.
HasSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Configura o SRID da coluna para a qual a propriedade mapeia ao direcionar o SQLite.
CanSetHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)	Retorna um valor que indica se o nome e o esquema fornecidos podem ser definidos para a sequência hi-lo.
CanSetIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, StoreObjectIdentifier, Boolean)	Retorna um valor que indica se o valor fornecido pode ser definido como o incremento para SQL Server IDENTITY para uma tabela específica.
CanSetIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Retorna um valor que indica se o valor fornecido pode ser definido como o incremento para SQL Server IDENTITY.
CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, StoreObjectIdentifier, Boolean)	Retorna um valor que indica se o valor fornecido pode ser definido como a semente para SQL Server IDENTITY para uma tabela específica.
CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, Boolean)	Retorna um valor que indica se o valor fornecido pode ser definido como a semente para SQL Server IDENTITY.
CanSetIsSparse(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Retorna um valor que indica se a coluna da propriedade pode ser configurada como esparsa ao direcionar SQL Server.
CanSetSequence(IConventionPropertyBuilder, String, String, Boolean)	Retorna um valor que indica se o nome e o esquema fornecidos podem ser definidos para a sequência de geração de valor de chave.
CanSetValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, StoreObjectIdentifier, Boolean)	Retorna um valor que indica se o valor fornecido pode ser definido como a estratégia de geração de valor para uma tabela específica.
CanSetValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, Boolean)	Retorna um valor que indica se o valor fornecido pode ser definido como a estratégia de geração de valor.
HasHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)	Configura a sequência de banco de dados usada para o padrão hi-lo para gerar valores para a propriedade key, ao direcionar SQL Server.
HasIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, StoreObjectIdentifier, Boolean)	Configura o incremento para SQL Server IDENTITY para uma tabela específica.
HasIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Configura o incremento para SQL Server IDENTITY.
HasIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, StoreObjectIdentifier, Boolean)	Configura a semente para SQL Server IDENTITY para uma tabela específica.
HasIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, Boolean)	Configura a semente para SQL Server IDENTITY.
HasSequence(IConventionPropertyBuilder, String, String, Boolean)	Configura a sequência de banco de dados usada para o padrão de geração de valor de chave para gerar valores para a propriedade de chave, ao direcionar SQL Server.
HasValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, StoreObjectIdentifier, Boolean)	Configura a estratégia de geração de valor para a propriedade key, ao direcionar SQL Server para uma tabela específica.
HasValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, Boolean)	Configura a estratégia de geração de valor para a propriedade key ao direcionar SQL Server.
IsSparse(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Configura se a coluna da propriedade é criada como esparsa ao direcionar SQL Server.