PropertyBuilder Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет простой API для настройки IMutableProperty.
public class PropertyBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.IMutableModel>, Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Internal.InternalPropertyBuilder>
[System.Runtime.CompilerServices.Nullable(0)]
public class PropertyBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder>
public class PropertyBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Internal.InternalPropertyBuilder>
public class PropertyBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder>
type PropertyBuilder = class
interface IInfrastructure<IMutableModel>
interface IInfrastructure<InternalPropertyBuilder>
[<System.Runtime.CompilerServices.Nullable(0)>]
type PropertyBuilder = class
interface IInfrastructure<IConventionPropertyBuilder>
type PropertyBuilder = class
interface IInfrastructure<InternalPropertyBuilder>
type PropertyBuilder = class
interface IInfrastructure<IConventionPropertyBuilder>
Public Class PropertyBuilder
Implements IInfrastructure(Of IMutableModel), IInfrastructure(Of InternalPropertyBuilder)
Public Class PropertyBuilder
Implements IInfrastructure(Of IConventionPropertyBuilder)
Public Class PropertyBuilder
Implements IInfrastructure(Of InternalPropertyBuilder)
- Наследование
-
PropertyBuilder
- Производный
- Атрибуты
- Реализации
-
IInfrastructure<IMutableModel> IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Internal.InternalPropertyBuilder> IInfrastructure<IConventionPropertyBuilder>
Комментарии
Экземпляры этого класса возвращаются из методов при использовании ModelBuilder API и не предназначены для непосредственного создания в коде приложения.
Дополнительные сведения и примеры см. в разделе " Типы сущностей моделирования" и "Связи ".
Конструкторы
| Имя. | Описание |
|---|---|
| PropertyBuilder(IMutableProperty) |
Это внутренний API, который поддерживает инфраструктуру Entity Framework Core и не соответствует тем же стандартам совместимости, что и общедоступные API. Его можно изменить или удалить без уведомления в любом выпуске. Его следует использовать непосредственно в коде с крайней осторожностью и зная, что это может привести к сбоям приложений при обновлении до нового выпуска Entity Framework Core. |
| PropertyBuilder(InternalPropertyBuilder) |
Этот API поддерживает инфраструктуру Entity Framework Core и не предназначен для использования непосредственно из кода. Этот API может изменяться или удаляться в будущих выпусках. |
Свойства
| Имя. | Описание |
|---|---|
| Metadata |
Настраиваемое свойство. |
Методы
| Имя. | Описание |
|---|---|
| HasAnnotation(String, Object) |
Добавляет или обновляет заметку для свойства. Если заметка с ключом, указанным в |
| HasConversion(Type, Type, Type) |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось перед записью в базу данных и преобразуется обратно при чтении из базы данных. |
| HasConversion(Type, Type) |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось перед записью в базу данных и преобразуется обратно при чтении из базы данных. |
| HasConversion(Type, ValueComparer, ValueComparer) |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось перед записью в базу данных и преобразуется обратно при чтении из базы данных. |
| HasConversion(Type, ValueComparer) |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось перед записью в базу данных и преобразуется обратно при чтении из базы данных. |
| HasConversion(Type) |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось перед записью в базу данных и преобразуется обратно при чтении из базы данных. |
| HasConversion(ValueConverter, ValueComparer, ValueComparer) |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось в базу данных и из нее с помощью заданного ValueConverterзначения. |
| HasConversion(ValueConverter, ValueComparer) |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось в базу данных и из нее с помощью заданного ValueConverterзначения. |
| HasConversion(ValueConverter) |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось в базу данных и из нее с помощью заданного ValueConverterзначения. |
| HasConversion<TConversion,TComparer,TProviderComparer>() |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось перед записью в базу данных и преобразуется обратно при чтении из базы данных. |
| HasConversion<TConversion,TComparer>() |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось перед записью в базу данных и преобразуется обратно при чтении из базы данных. |
| HasConversion<TConversion>() |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось перед записью в базу данных и преобразуется обратно при чтении из базы данных. |
| HasConversion<TConversion>(ValueComparer, ValueComparer) |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось перед записью в базу данных и преобразуется обратно при чтении из базы данных. |
| HasConversion<TConversion>(ValueComparer) |
Настраивает свойство таким образом, чтобы значение свойства преобразовылось перед записью в базу данных и преобразуется обратно при чтении из базы данных. |
| HasField(String) |
Задает резервное поле, используемое для этого свойства. |
| HasMaxLength(Int32) |
Настраивает максимальную длину данных, которые могут храниться в этом свойстве. Максимальная длина может быть задана только для свойств массива (включая String свойства). |
| HasPrecision(Int32, Int32) |
Настраивает точность и масштаб свойства. |
| HasPrecision(Int32) |
Настраивает точность свойства. |
| HasSentinel(Object) |
Настраивает значение, которое будет использоваться для определения того, задано ли свойство. Если свойству присвоено значение sentinel, то считается не задано. По умолчанию значение sentinel — это значение по умолчанию среды CLR для типа свойства. |
| HasValueGenerator(Func<IProperty,IEntityType,ValueGenerator>) |
Настраивает фабрику для создания используемого ValueGenerator значения для этого свойства. |
| HasValueGenerator(Func<IProperty,ITypeBase,ValueGenerator>) |
Настраивает фабрику для создания используемого ValueGenerator значения для этого свойства. |
| HasValueGenerator(Type) |
Настраивает ValueGenerator значение, которое создаст значения для этого свойства. |
| HasValueGenerator<TGenerator>() |
Настраивает ValueGenerator значение, которое создаст значения для этого свойства. |
| HasValueGeneratorFactory(Type) |
Настраивает ValueGeneratorFactory создание используемого ValueGenerator значения для создания значений для этого свойства. |
| HasValueGeneratorFactory<TFactory>() |
Настраивает ValueGeneratorFactory создание используемого ValueGenerator значения для создания значений для этого свойства. |
| IsConcurrencyToken(Boolean) |
Указывает, следует ли использовать это свойство в качестве маркера параллелизма. Если свойство настроено как маркер параллелизма, значение в базе данных будет проверяться, когда экземпляр этого типа сущности обновляется или удаляется во время SaveChanges() , чтобы убедиться, что он не изменился после получения экземпляра из базы данных. Если он изменился, исключение будет создано, и изменения не будут применены к базе данных. |
| IsRequired(Boolean) |
Настраивает, должно ли это свойство назначать значение или |
| IsRowVersion() |
Настраивает свойство как ValueGeneratedOnAddOrUpdate() и IsConcurrencyToken(Boolean). |
| IsUnicode(Boolean) |
Указывает, может ли свойство сохранять символы юникода. Можно задать только для String свойств. |
| UsePropertyAccessMode(PropertyAccessMode) |
Задает значение, используемое PropertyAccessMode для этого свойства. По умолчанию резервное поле, если оно найдено по соглашению или было указано, используется при создании новых объектов, как правило, когда сущности запрашиваются из базы данных. Свойства используются для всех других доступа. Вызов этого метода witll изменяет это поведение для этого свойства, как описано в перечислении PropertyAccessMode . Вызов этого метода переопределяет для этого свойства любой режим доступа, заданный в типе сущности или модели. |
| UsePropertyAccessMode(PropertyAccessMode) |
Задает значение, используемое PropertyAccessMode для этого свойства. |
| ValueGeneratedNever() |
Настраивает свойство, которое никогда не создает значение базы данных при сохранении экземпляра этого типа сущности. |
| ValueGeneratedOnAdd() |
Настраивает свойство для создания значения только при сохранении новой сущности, если только не задано ненулевое, не временное значение, в этом случае значение набора будет сохранено. Значение может быть создано генератором значений на стороне клиента или может быть создано базой данных в рамках сохранения сущности. |
| ValueGeneratedOnAddOrUpdate() |
Настраивает свойство для создания значения при сохранении новой или существующей сущности. |
| ValueGeneratedOnUpdate() |
Настраивает свойство для создания значения при сохранении существующей сущности. |
| ValueGeneratedOnUpdateSometimes() |
Настраивает свойство для создания значения в определенных условиях при сохранении существующей сущности. |
Явные реализации интерфейса
| Имя. | Описание |
|---|---|
| IInfrastructure<IConventionPropertyBuilder>.Instance |
Внутренний построитель, используемый для настройки свойства. |
| IInfrastructure<IMutableModel>.Instance |
Модель, к которой принадлежит свойство. |
| IInfrastructure<InternalPropertyBuilder>.Instance |
Внутренний построитель, используемый для настройки свойства. |
Методы расширения
| Имя. | Описание |
|---|---|
| EnableFullTextSearch(PropertyBuilder, String, Boolean) |
Включает полнотекстовый поиск этого свойства с помощью указанного языка. |
| ForSqliteHasColumnName(PropertyBuilder, String) |
Настраивает столбец, с которым сопоставляется свойство при выборе SQLite. |
| ForSqliteHasColumnType(PropertyBuilder, String) |
Настраивает тип данных столбца, с которым сопоставляется свойство при выборе SQLite. |
| ForSqliteHasDefaultValue(PropertyBuilder, Object) |
Настраивает значение по умолчанию для столбца, с которым сопоставляется свойство при выборе SQLite. |
| ForSqliteHasDefaultValueSql(PropertyBuilder, String) |
Настраивает выражение значения по умолчанию для столбца, с которым сопоставляется свойство при выборе SQLite. |
| ForSqliteHasDimension(PropertyBuilder, Ordinates) |
Настраивает измерение столбца, с которым сопоставляется свойство при выборе SQLite. |
| ForSqliteHasDimension(PropertyBuilder, Ordinates) |
Устаревшие.
Настраивает измерение столбца, с которым сопоставляется свойство при выборе SQLite. |
| ForSqliteHasSrid(PropertyBuilder, Int32) |
Устаревшие.
Настраивает SRID столбца, с которым сопоставляется свойство при выборе SQLite. |
| ForSqlServerHasColumnName(PropertyBuilder, String) |
Настраивает столбец, с которым сопоставляется свойство при выборе SQL Server. |
| ForSqlServerHasColumnType(PropertyBuilder, String) |
Настраивает тип данных столбца, с которым сопоставляется свойство при выборе SQL Server. Это должно быть полное имя типа, включая точность, масштаб, длину и т. д. |
| ForSqlServerHasComputedColumnSql(PropertyBuilder, String) |
Настраивает свойство для сопоставления с вычисляемого столбца при выборе SQL Server. |
| ForSqlServerHasDefaultValue(PropertyBuilder, Object) |
Настраивает значение по умолчанию для столбца, с которым сопоставляется свойство при выборе SQL Server. |
| ForSqlServerHasDefaultValueSql(PropertyBuilder, String) |
Настраивает выражение значения по умолчанию для столбца, с которым сопоставляется свойство при выборе SQL Server. |
| ForSqlServerUseSequenceHiLo(PropertyBuilder, String, String) |
Устаревшие.
Настраивает свойство ключа для использования шаблона hi-lo на основе последовательности для создания значений для новых сущностей при целевом SQL Server. Этот метод задает свойство OnAdd. |
| GetInfrastructure<T>(IInfrastructure<T>) |
Возвращает значение из свойства, скрытого с помощью IInfrastructure<T>. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения. |
| HasColumnName(PropertyBuilder, String) |
Настраивает столбец, с которым сопоставляется свойство при выборе реляционной базы данных. |
| HasColumnOrder(PropertyBuilder, Nullable<Int32>) |
Настраивает порядок столбца, с который сопоставляется свойство. |
| HasColumnType(PropertyBuilder, String) |
Настраивает тип данных столбца, с которым сопоставляется свойство при выборе реляционной базы данных. Это должно быть полное имя типа, включая точность, масштаб, длину и т. д. |
| HasComment(PropertyBuilder, String) |
Настройка комментария для применения к столбцу |
| HasComputedColumnSql(PropertyBuilder, String, Nullable<Boolean>) |
Настраивает свойство для сопоставления с вычисляемого столбца при выборе реляционной базы данных. |
| HasComputedColumnSql(PropertyBuilder, String) |
Настраивает свойство для сопоставления с вычисляемого столбца при выборе реляционной базы данных. |
| HasComputedColumnSql(PropertyBuilder) |
Настраивает свойство для сопоставления с вычисляемого столбца при выборе реляционной базы данных. |
| HasDefaultValue(PropertyBuilder, Object, String) |
Настраивает значение по умолчанию для столбца, с которым сопоставляется свойство при выборе SQL Server. |
| HasDefaultValue(PropertyBuilder, Object) |
Настраивает значение по умолчанию для столбца, с которым сопоставляется свойство при выборе реляционной базы данных. |
| HasDefaultValue(PropertyBuilder) |
Настраивает значение по умолчанию для столбца, с которым сопоставляется свойство при выборе реляционной базы данных. |
| HasDefaultValueSql(PropertyBuilder, String, String) |
Настраивает выражение значения по умолчанию для столбца, с которым сопоставляется свойство при выборе SQL Server. |
| HasDefaultValueSql(PropertyBuilder, String) |
Настраивает выражение значения по умолчанию для столбца, с которым сопоставляется свойство при выборе реляционной базы данных. |
| HasDefaultValueSql(PropertyBuilder) |
Настраивает выражение значения по умолчанию для столбца, с которым сопоставляется свойство при выборе реляционной базы данных. |
| HasGeometricDimension(PropertyBuilder, Ordinates) |
Настраивает измерение столбца, с которым сопоставляется свойство при выборе SQLite. |
| HasJsonPropertyName(PropertyBuilder, String) |
Настраивает свойство сущности, сопоставленной со столбцом JSON, сопоставляя свойство сущности с определенным свойством JSON, а не с использованием имени свойства сущности. |
| HasSrid(PropertyBuilder, Int32) |
Настраивает SRID столбца, с которым сопоставляется свойство при выборе SQLite. |
| IsETagConcurrency(PropertyBuilder) |
Настраивает это свойство для маркера параллелизма etag. |
| IsFixedLength(PropertyBuilder, Boolean) |
Настраивает свойство как способное хранить только данные фиксированной длины, такие как строки. |
| IsSparse(PropertyBuilder, Boolean) |
Указывает, создается ли столбец свойства как разреженный при выборе SQL Server. |
| IsVector(PropertyBuilder, DistanceFunction, Int32) |
Настраивает свойство в качестве вектора для Azure Cosmos DB. |
| IsVectorProperty(PropertyBuilder, DistanceFunction, Int32) |
Настраивает свойство в качестве вектора для Azure Cosmos DB. |
| ToJsonProperty(PropertyBuilder, String) |
Настраивает имя свойства, сопоставленное свойству при выборе Azure Cosmos. |
| UseAutoincrement(PropertyBuilder) |
Настраивает свойство для использования функции SQLite AUTOINCREMENT для создания значений для новых сущностей при назначении SQLite. Этот метод задает свойство OnAdd. |
| UseCollation(PropertyBuilder, String) |
Настраивает свойство для использования заданной сортировки. Столбец базы данных будет создан с заданным параметрами сортировки, и он будет использоваться неявно во всех операциях сортировки. |
| UseHiLo(PropertyBuilder, String, String) |
Настраивает свойство ключа для использования шаблона hi-lo на основе последовательности для создания значений для новых сущностей при целевом SQL Server. Этот метод задает свойство OnAdd. |
| UseIdentityColumn(PropertyBuilder, Int32, Int32) |
Настраивает свойство ключа для использования функции SQL Server IDENTITY для создания значений для новых сущностей при выборе SQL Server. Этот метод задает свойство OnAdd. |
| UseIdentityColumn(PropertyBuilder, Int64, Int32) |
Настраивает свойство ключа для использования функции SQL Server IDENTITY для создания значений для новых сущностей при выборе SQL Server. Этот метод задает свойство OnAdd. |
| UseSequence(PropertyBuilder, String, String) |
Настраивает свойство ключа для использования шаблона создания значений на основе последовательности для создания значений для новых сущностей при целевом SQL Server. Этот метод задает свойство OnAdd. |
| UseSqlServerIdentityColumn(PropertyBuilder, Int32, Int32) |
Устаревшие.
Настраивает свойство ключа для использования функции SQL Server IDENTITY для создания значений для новых сущностей при выборе SQL Server. Этот метод задает свойство OnAdd. |
| UseSqlServerIdentityColumn(PropertyBuilder) |
Настраивает свойство ключа для использования функции SQL Server IDENTITY для создания значений для новых сущностей при выборе SQL Server. Этот метод задает свойство OnAdd. |