IConventionPropertyBuilder Интерфейс

Определение

Пространство имен:

Microsoft.EntityFrameworkCore.Metadata.Builders

Сборка:

Microsoft.EntityFrameworkCore.dll

Пакет:

Microsoft.EntityFrameworkCore v8.0.0

Предоставляет простую поверхность API для настройки соглашений IConventionProperty from.

Этот интерфейс обычно используется поставщиками баз данных (и другими расширениями). Как правило, он не используется в коде приложения.

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)

Реализации

IConventionAnnotatableBuilder IConventionPropertyBaseBuilder<IConventionPropertyBuilder>

Комментарии

Дополнительные сведения и примеры см. в разделе Соглашения о создании моделей .

Свойства

Metadata	Возвращает настраиваемое свойство.
ModelBuilder	Возвращает построитель моделей. (Унаследовано от IConventionAnnotatableBuilder)

Методы

AfterSave(Nullable<PropertySaveBehavior>, Boolean)	Указывает, можно ли изменить это свойство после сохранения сущности в базе данных.
BeforeSave(Nullable<PropertySaveBehavior>, Boolean)	Определяет, можно ли изменить это свойство перед сохранением сущности в базе данных.
CanRemoveAnnotation(String, Boolean)	Возвращает значение, указывающее, можно ли удалить заметку с заданным именем с помощью этого источника конфигурации. (Унаследовано от IConventionAnnotatableBuilder)
CanSetAfterSave(Nullable<PropertySaveBehavior>, Boolean)	Возвращает значение, указывающее, можно ли настроить возможность изменения после сохранения сущности в базе данных для этого свойства из текущего источника конфигурации.
CanSetAnnotation(String, Object, Boolean)	Возвращает значение, указывающее, можно ли задать заметку с заданным именем и значением из этого источника конфигурации. (Унаследовано от IConventionAnnotatableBuilder)
CanSetBeforeSave(Nullable<PropertySaveBehavior>, Boolean)	Возвращает значение, указывающее, можно ли настроить возможность изменения перед сохранением сущности в базе данных для этого свойства из текущего источника конфигурации.
CanSetConversion(Type, Boolean)	Возвращает значение, указывающее, можно ли настроить заданный тип для преобразования значений в и из этого свойства из текущего источника конфигурации.
CanSetConversion(ValueConverter, Boolean)	Возвращает значение, указывающее, можно ли ValueConverter настроить для этого свойства из текущего источника конфигурации.
CanSetConverter(Type, Boolean)	Возвращает значение, указывающее, можно ли ValueConverter настроить для этого свойства из текущего источника конфигурации.
CanSetElementType(Type, Boolean)	Это внутренний API, который поддерживает инфраструктуру Entity Framework Core и не подчиняется тем же стандартам совместимости, что и общедоступные API. Он может быть изменен или удален без уведомления в любом выпуске. Следует использовать его только непосредственно в коде с особой осторожностью и зная, что это может привести к сбоям приложений при обновлении до нового выпуска Entity Framework Core.
CanSetIsConcurrencyToken(Nullable<Boolean>, Boolean)	Возвращает значение, указывающее, можно ли настроить свойство в качестве маркера параллелизма из текущего источника конфигурации.
CanSetIsRequired(Nullable<Boolean>, Boolean)	Возвращает значение, указывающее, можно ли настроить обязательность этого свойства из текущего источника конфигурации.
CanSetIsUnicode(Nullable<Boolean>, Boolean)	Возвращает значение, указывающее, можно ли настроить свойство как способное сохранять символы Юникода из текущего источника конфигурации.
CanSetMaxLength(Nullable<Int32>, Boolean)	Возвращает значение, указывающее, можно ли задать максимальную длину данных из текущего источника конфигурации для этого свойства.
CanSetPrecision(Nullable<Int32>, Boolean)	Возвращает значение, указывающее, можно ли задать точность данных, разрешенную для этого свойства из текущего источника конфигурации.
CanSetProviderValueComparer(Type, Boolean)	Возвращает значение, указывающее, можно ли настроить данное ValueComparer свойство для этого свойства из текущего источника конфигурации.
CanSetProviderValueComparer(ValueComparer, Boolean)	Возвращает значение, указывающее, можно ли настроить данное ValueComparer свойство для этого свойства из текущего источника конфигурации.
CanSetScale(Nullable<Int32>, Boolean)	Возвращает значение, указывающее, можно ли задать допустимый масштаб данных для этого свойства из текущего источника конфигурации.
CanSetSentinel(Object, Boolean)	Возвращает значение, указывающее, можно ли задать sentinel для этого свойства из текущего источника конфигурации.
CanSetTypeMapping(CoreTypeMapping, Boolean)	Возвращает значение, указывающее, можно ли настроить данное CoreTypeMapping свойство для этого свойства из текущего источника конфигурации.
CanSetValueComparer(Type, Boolean)	Возвращает значение, указывающее, можно ли настроить данное ValueComparer свойство для этого свойства из текущего источника конфигурации.
CanSetValueComparer(ValueComparer, Boolean)	Возвращает значение, указывающее, можно ли настроить данное ValueComparer свойство для этого свойства из текущего источника конфигурации.
CanSetValueGenerated(Nullable<ValueGenerated>, Boolean)	Возвращает значение, указывающее, можно ли настроить создание значения свойства из текущего источника конфигурации.
CanSetValueGenerator(Func<IProperty,ITypeBase,ValueGenerator>, Boolean)	Возвращает значение, указывающее, можно ли ValueGenerator настроить для этого свойства из текущего источника конфигурации.
CanSetValueGeneratorFactory(Type, Boolean)	Возвращает значение, указывающее, можно ли ValueGeneratorFactory настроить для этого свойства из текущего источника конфигурации.
HasAnnotation(String, Object, Boolean)	Задает заметку, хранящуюся под заданным именем. Перезаписывает существующую заметку, если заметка с указанным именем уже существует с тем же или более низким значением ConfigurationSource. (Унаследовано от IConventionPropertyBaseBuilder<TBuilder>)
HasConversion(Type, Boolean)	Настраивает свойство таким образом, чтобы значение свойства преобразовылось в заданный тип перед записью в базу данных и преобразовылось обратно при чтении из базы данных.
HasConversion(ValueConverter, Boolean)	Настраивает свойство таким образом, чтобы значение свойства преобразовылось в базу данных и из нее с помощью заданного ValueConverter.
HasConverter(Type, Boolean)	Настраивает свойство таким образом, чтобы значение свойства преобразовылось в базу данных и из нее с помощью заданного ValueConverter.
HasMaxLength(Nullable<Int32>, Boolean)	Настраивает максимальную длину данных, которые могут храниться в этом свойстве.
HasNoAnnotation(String, Boolean)	Удаляет заметку с заданным именем из этого объекта. (Унаследовано от IConventionPropertyBaseBuilder<TBuilder>)
HasNonNullAnnotation(String, Object, Boolean)	Задает заметку, хранящуюся под заданным именем. Перезаписывает существующую заметку, если заметка с указанным именем уже существует с тем же или более низким значением ConfigurationSource. Удаляет заметку, если null указано значение. (Унаследовано от IConventionPropertyBaseBuilder<TBuilder>)
HasPrecision(Nullable<Int32>, Boolean)	Настраивает точность свойства.
HasProviderValueComparer(Type, Boolean)	Настраивает для ValueComparer использования для значений поставщика для этого свойства.
HasProviderValueComparer(ValueComparer, Boolean)	Настраивает для ValueComparer использования для значений поставщика для этого свойства.
HasScale(Nullable<Int32>, Boolean)	Настраивает масштаб свойства .
HasSentinel(Object, Boolean)	Настраивает значение, которое будет использоваться для определения того, задано ли свойство. Если свойству присвоено значение sentinel, оно считается не заданным. По умолчанию значение sentinel является значением clR по умолчанию для типа свойства .
HasTypeMapping(CoreTypeMapping, Boolean)	Настраивает CoreTypeMapping для этого свойства .
HasValueComparer(Type, Boolean)	Настраивает ValueComparer для этого свойства .
HasValueComparer(ValueComparer, Boolean)	Настраивает ValueComparer для этого свойства .
HasValueGenerator(Func<IProperty,ITypeBase,ValueGenerator>, Boolean)	Настраивает , ValueGenerator который будет создавать значения для этого свойства.
HasValueGenerator(Type, Boolean)	Настраивает , ValueGenerator который будет создавать значения для этого свойства.
HasValueGeneratorFactory(Type, Boolean)	Настраивает ValueGeneratorFactory для создания ValueGenerator , который будет создавать значения для этого свойства.
IsConcurrencyToken(Nullable<Boolean>, Boolean)	Указывает, следует ли использовать это свойство в качестве маркера параллелизма. При настройке свойства в качестве маркера параллелизма значение в базе данных проверяется при обновлении или удалении экземпляра этого типа сущности во время SaveChanges() , чтобы убедиться, что оно не изменилось с момента извлечения экземпляра из базы данных. Если она была изменена, возникнет исключение, и изменения не будут применены к базе данных.
IsRequired(Nullable<Boolean>, Boolean)	Указывает, должно ли свойство присваивать значение или null является допустимым. Свойство можно настроить как необязательное, только если оно основано на типе CLR, который можно назначить null.
IsUnicode(Nullable<Boolean>, Boolean)	Определяет, может ли свойство сохранять символы Юникода.
SetElementType(Type, Boolean)	Это внутренний API, который поддерживает инфраструктуру Entity Framework Core и не подчиняется тем же стандартам совместимости, что и общедоступные API. Он может быть изменен или удален без уведомления в любом выпуске. Следует использовать его только непосредственно в коде с особой осторожностью и зная, что это может привести к сбоям приложений при обновлении до нового выпуска Entity Framework Core.
ValueGenerated(Nullable<ValueGenerated>, Boolean)	Задает значение, указывающее, когда для этого свойства будет создано базой данных. Даже если свойство создано базой данных, EF может попытаться сохранить определенное значение (а не созданное базой данных) при добавлении сущности и присвоении значения или если свойство помечено как измененное для существующей сущности. Дополнительные сведения и примеры см GetBeforeSaveBehavior() . в разделе и GetAfterSaveBehavior() .

Методы расширения

CanSetJsonProperty(IConventionPropertyBuilder, String, Boolean)	Возвращает значение, указывающее, можно ли задать заданное имя свойства.
ToJsonProperty(IConventionPropertyBuilder, String, Boolean)	Настраивает имя свойства, с которым сопоставляется свойство при нацеливание на Azure Cosmos. Если указана пустая строка, свойство не будет сохранено.
CanSetCollation(IConventionPropertyBuilder, String, Boolean)	Возвращает значение, указывающее, можно ли задать заданное значение в качестве параметров сортировки.
CanSetColumnName(IConventionPropertyBuilder, String, StoreObjectIdentifier, Boolean)	Возвращает значение, указывающее, можно ли задать заданный столбец для определенного табличного объекта хранилища для свойства .
CanSetColumnName(IConventionPropertyBuilder, String, Boolean)	Возвращает значение, указывающее, можно ли задать заданный столбец для свойства .
CanSetColumnOrder(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Возвращает значение, указывающее, можно ли задать заданный порядок столбцов для свойства .
CanSetColumnType(IConventionPropertyBuilder, String, Boolean)	Возвращает значение, указывающее, можно ли задать заданный тип данных для свойства .
CanSetComment(IConventionPropertyBuilder, String, Boolean)	Возвращает значение, указывающее, можно ли задать заданное значение в качестве комментария для столбца.
CanSetComputedColumnSql(IConventionPropertyBuilder, String, Boolean)	Возвращает значение, указывающее, можно ли задать заданное вычисляемое значение SQL-выражение для столбца.
CanSetDefaultValue(IConventionPropertyBuilder, Object, Boolean)	Возвращает значение, указывающее, можно ли задать заданное значение по умолчанию для столбца.
CanSetDefaultValueSql(IConventionPropertyBuilder, String, Boolean)	Возвращает значение, указывающее, можно ли задать заданное выражение значения по умолчанию для столбца.
CanSetIsFixedLength(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Возвращает значение, указывающее, можно ли настроить свойство как фиксированную длину.
CanSetIsStoredComputedColumn(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Возвращает значение, указывающее, можно ли задать для столбца заданный тип вычисляемого столбца.
CanSetJsonPropertyName(IConventionPropertyBuilder, String, Boolean)	Возвращает значение, указывающее, может ли данное значение использоваться в качестве имени свойства JSON для данного свойства сущности.
HasColumnName(IConventionPropertyBuilder, String, StoreObjectIdentifier, Boolean)	Настраивает столбец, с которым сопоставляется свойство в определенном объекте хранилища, похожем на таблицу.
HasColumnName(IConventionPropertyBuilder, String, Boolean)	Настраивает столбец, которому сопоставляется свойство при выборе реляционной базы данных.
HasColumnOrder(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Настраивает порядок столбца, с который сопоставляется свойство.
HasColumnType(IConventionPropertyBuilder, String, Boolean)	Настраивает тип данных столбца, с которым сопоставляется свойство при нацеливание на реляционную базу данных. Это должно быть полное имя типа, включая точность, масштаб, длину и т. д.
HasComment(IConventionPropertyBuilder, String, Boolean)	Настройка примечания для применения к столбцу
HasComputedColumnSql(IConventionPropertyBuilder, String, Boolean)	Настраивает свойство для сопоставления с вычисляемого столбца при нацеливанием на реляционную базу данных.
HasDefaultValue(IConventionPropertyBuilder, Object, Boolean)	Настраивает значение по умолчанию для столбца, с которым сопоставляется свойство при выборе реляционной базы данных.
HasDefaultValueSql(IConventionPropertyBuilder, String, Boolean)	Настраивает выражение значения по умолчанию для столбца, с которым сопоставляется свойство при нацеливание на реляционную базу данных.
HasJsonPropertyName(IConventionPropertyBuilder, String, Boolean)	Настраивает свойство сущности, сопоставленной со столбцом JSON, сопоставляя свойство сущности с определенным свойством JSON вместо использования имени свойства сущности.
IsFixedLength(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Настраивает свойство как способное хранить только данные фиксированной длины, например строки.
IsStoredComputedColumn(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Настраивает свойство для сопоставления с вычисляемого столбца заданного типа при нацеливание на реляционную базу данных.
UseCollation(IConventionPropertyBuilder, String, Boolean)	Настраивает свойство для использования заданных параметров сортировки. Столбец базы данных будет создан с заданными параметрами сортировки и будет использоваться неявно во всех операциях с учетом параметров сортировки.
CanSetSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Возвращает значение, указывающее, можно ли задать заданное значение в качестве SRID для столбца.
HasSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Настраивает SRID столбца, с которым сопоставляется свойство при нацеливание на SQLite.
CanSetHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)	Возвращает значение, указывающее, можно ли задать заданное имя и схему для последовательности hi-lo.
CanSetIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, StoreObjectIdentifier, Boolean)	Возвращает значение, указывающее, можно ли задать заданное значение в качестве приращения для SQL Server IDENTITY для конкретной таблицы.
CanSetIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Возвращает значение, указывающее, можно ли задать заданное значение в качестве приращения для SQL Server IDENTITY.
CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, StoreObjectIdentifier, Boolean)	Возвращает значение, указывающее, может ли данное значение быть задано в качестве начального значения для SQL Server IDENTITY для конкретной таблицы.
CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, Boolean)	Возвращает значение, указывающее, можно ли задать заданное значение в качестве начального значения для SQL Server IDENTITY.
CanSetIsSparse(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Возвращает значение, указывающее, можно ли настроить столбец свойства как разреженный при нацеливание на SQL Server.
CanSetSequence(IConventionPropertyBuilder, String, String, Boolean)	Возвращает значение, указывающее, можно ли задать заданное имя и схему для последовательности создания значения ключа.
CanSetValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, StoreObjectIdentifier, Boolean)	Возвращает значение, указывающее, может ли данное значение быть задано в качестве стратегии создания значений для конкретной таблицы.
CanSetValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, Boolean)	Возвращает значение, указывающее, может ли данное значение быть задано в качестве стратегии формирования значений.
HasHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)	Настраивает последовательность базы данных, используемую для шаблона hi-lo, для создания значений для свойства ключа при выборе SQL Server.
HasIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, StoreObjectIdentifier, Boolean)	Настраивает приращение для SQL Server IDENTITY для определенной таблицы.
HasIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Настраивает приращение для SQL Server IDENTITY.
HasIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, StoreObjectIdentifier, Boolean)	Настраивает начальное значение для SQL Server IDENTITY для определенной таблицы.
HasIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, Boolean)	Настраивает начальное значение для SQL Server IDENTITY.
HasSequence(IConventionPropertyBuilder, String, String, Boolean)	Настраивает последовательность базы данных, используемую для шаблона создания ключевого значения, для создания значений для свойства ключа при выборе SQL Server.
HasValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, StoreObjectIdentifier, Boolean)	Настраивает стратегию создания значений для свойства ключа при выборе SQL Server для конкретной таблицы.
HasValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, Boolean)	Настраивает стратегию создания значений для свойства ключа при выборе SQL Server.
IsSparse(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Указывает, создается ли столбец свойства как разреженный при нацеливание на SQL Server.