PropertyBuilder<TProperty> クラス

定義

名前空間:

Microsoft.EntityFrameworkCore.Metadata.Builders

アセンブリ:

Microsoft.EntityFrameworkCore.dll

パッケージ:

Microsoft.EntityFrameworkCore v8.0.0

を構成するための簡単な API を提供します IMutableProperty。

public class PropertyBuilder<TProperty> : Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder

type PropertyBuilder<'Property> = class
    inherit PropertyBuilder

Public Class PropertyBuilder(Of TProperty)
Inherits PropertyBuilder

型パラメーター

TProperty

継承

Object

PropertyBuilder

PropertyBuilder<TProperty>

注釈

このクラスのインスタンスは、API を使用する場合に ModelBuilder メソッドから返され、アプリケーション コードで直接構築されるようには設計されていません。

詳細と例については、「 エンティティ型とリレーションシップのモデル 化」を参照してください。

コンストラクター

PropertyBuilder<TProperty>(IMutableProperty)

これは Entity Framework Core インフラストラクチャをサポートする内部 API であり、パブリック API と同じ互換性標準の対象ではありません。 これは、いかなるリリースでも予告なしに変更または削除される可能性があります。 コード内でのみ直接使用する必要があります。これを行うと、新しい Entity Framework Core リリースに更新するときにアプリケーションエラーが発生する可能性があることを認識してください。

プロパティ

Metadata

構成されているプロパティ。 (継承元 PropertyBuilder)

メソッド

HasAnnotation(String, Object)	プロパティの注釈を追加または更新します。 で指定されたキーを持つ注釈が既に annotation 存在する場合、その値は更新されます。
HasConversion(Type)	データベースに書き込む前にプロパティ値が変換され、データベースから読み取るときに元に戻されるようにプロパティを構成します。
HasConversion(Type, Type)	データベースに書き込む前にプロパティ値が変換され、データベースから読み取るときに元に戻されるようにプロパティを構成します。
HasConversion(Type, Type, Type)	データベースに書き込む前にプロパティ値が変換され、データベースから読み取るときに元に戻されるようにプロパティを構成します。
HasConversion(Type, ValueComparer)	データベースに書き込む前にプロパティ値が変換され、データベースから読み取るときに元に戻されるようにプロパティを構成します。
HasConversion(Type, ValueComparer, ValueComparer)	データベースに書き込む前にプロパティ値が変換され、データベースから読み取るときに元に戻されるようにプロパティを構成します。
HasConversion(ValueConverter)	プロパティ値が、指定 ValueConverterされた を使用してデータベースとの間で変換されるようにプロパティを構成します。
HasConversion(ValueConverter, ValueComparer)	プロパティ値が、指定 ValueConverterされた を使用してデータベースとの間で変換されるようにプロパティを構成します。
HasConversion(ValueConverter, ValueComparer, ValueComparer)	プロパティ値が、指定 ValueConverterされた を使用してデータベースとの間で変換されるようにプロパティを構成します。
HasConversion<TConversion,TComparer,TProviderComparer>()	データベースに書き込む前にプロパティ値が変換され、データベースから読み取るときに元に戻されるようにプロパティを構成します。
HasConversion<TConversion,TComparer>()	データベースに書き込む前にプロパティ値が変換され、データベースから読み取るときに元に戻されるようにプロパティを構成します。
HasConversion<TConversion>()	データベースに書き込む前にプロパティ値が変換され、データベースから読み取るときに元に戻されるようにプロパティを構成します。
HasConversion<TConversion>(ValueComparer)	データベースに書き込む前にプロパティ値が変換され、データベースから読み取るときに元に戻されるようにプロパティを構成します。
HasConversion<TConversion>(ValueComparer, ValueComparer)	データベースに書き込む前にプロパティ値が変換され、データベースから読み取るときに元に戻されるようにプロパティを構成します。
HasConversion<TProvider>(Expression<Func<TProperty,TProvider>>, Expression<Func<TProvider,TProperty>>)	プロパティ値が、指定された変換式を使用してデータベースとの間で変換されるようにプロパティを構成します。
HasConversion<TProvider>(Expression<Func<TProperty,TProvider>>, Expression<Func<TProvider,TProperty>>, ValueComparer)	プロパティ値が、指定された変換式を使用してデータベースとの間で変換されるようにプロパティを構成します。
HasConversion<TProvider>(Expression<Func<TProperty,TProvider>>, Expression<Func<TProvider,TProperty>>, ValueComparer, ValueComparer)	プロパティ値が、指定された変換式を使用してデータベースとの間で変換されるようにプロパティを構成します。
HasConversion<TProvider>(ValueConverter<TProperty,TProvider>)	プロパティ値が、指定 ValueConverter<TModel,TProvider>された を使用してデータベースとの間で変換されるようにプロパティを構成します。
HasConversion<TProvider>(ValueConverter<TProperty,TProvider>, ValueComparer)	プロパティ値が、指定 ValueConverter<TModel,TProvider>された を使用してデータベースとの間で変換されるようにプロパティを構成します。
HasConversion<TProvider>(ValueConverter<TProperty,TProvider>, ValueComparer, ValueComparer)	プロパティ値が、指定 ValueConverter<TModel,TProvider>された を使用してデータベースとの間で変換されるようにプロパティを構成します。
HasField(String)	このプロパティに使用するバッキング フィールドを設定します。
HasMaxLength(Int32)	このプロパティに格納できるデータの最大長を構成します。 最大長は、配列プロパティ (プロパティを含む String ) でのみ設定できます。
HasPrecision(Int32)	プロパティの有効桁数を構成します。
HasPrecision(Int32, Int32)	プロパティの有効桁数と小数点以下桁数を構成します。
HasSentinel(Object)	プロパティが設定されているかどうかを判断するために使用される値を構成します。 プロパティが sentinel 値に設定されている場合は、設定されていないと見なされます。 既定では、Sentinel の値は、 プロパティの型の CLR の既定値です。
HasValueGenerator(Func<IProperty,IEntityType,ValueGenerator>)	このプロパティの値を生成するために使用する を ValueGenerator 作成するためのファクトリを構成します。 (継承元 PropertyBuilder)
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)	このプロパティに値を割り当てる必要があるかどうか、または null が有効な値であるかどうかを構成します。 プロパティは、 を割り当て nullることができる CLR 型に基づいている場合にのみ、必須として構成できます。
IsRowVersion()	プロパティを と IsConcurrencyToken(Boolean)としてValueGeneratedOnAddOrUpdate()構成します。
IsUnicode(Boolean)	Unicode 文字を永続化できるプロパティを構成します。 プロパティに対 String してのみ設定できます。
UsePropertyAccessMode(PropertyAccessMode)	このプロパティに PropertyAccessMode 使用する を設定します。
UsePropertyAccessMode(PropertyAccessMode)	このプロパティに PropertyAccessMode 使用する を設定します。 既定では、バッキング フィールドは、規則で見つかった場合、または指定されている場合は、新しいオブジェクトが構築されるときに使用されます。通常は、データベースからエンティティが照会されるときに使用されます。 プロパティは、他のすべてのアクセスに使用されます。 このメソッドを呼び出すと、列挙型で説明されているように、このプロパティの動作が PropertyAccessMode 変更されます。 このメソッドを呼び出すと、エンティティ型またはモデルで設定されたすべてのアクセス モードがこのプロパティに対して優先されます。 (継承元 PropertyBuilder)
ValueGeneratedNever()	このエンティティ型のインスタンスが保存されるときに値が生成されないようにプロパティを構成します。
ValueGeneratedOnAdd()	null 以外の非一時的な値が設定されていない限り、新しいエンティティを保存する場合にのみ生成される値を持つプロパティを構成します。その場合は、設定された値が代わりに保存されます。 値は、クライアント側の値ジェネレーターによって生成されるか、エンティティの保存の一部としてデータベースによって生成される場合があります。
ValueGeneratedOnAddOrUpdate()	新しいエンティティまたは既存のエンティティを保存するときに生成される値を持つプロパティを構成します。
ValueGeneratedOnUpdate()	既存のエンティティを保存するときに生成される値を持つプロパティを構成します。
ValueGeneratedOnUpdateSometimes()	既存のエンティティを保存するときに、特定の条件下で生成される値を持つプロパティを構成します。

明示的なインターフェイスの実装

IInfrastructure<IConventionPropertyBuilder>.Instance

プロパティの構成に使用される内部ビルダー。 (継承元 PropertyBuilder)

拡張メソッド

IsETagConcurrency(PropertyBuilder)	このプロパティを etag コンカレンシー トークンとして構成します。
IsETagConcurrency<TProperty>(PropertyBuilder<TProperty>)	このプロパティを etag コンカレンシー トークンとして構成します。
ToJsonProperty(PropertyBuilder, String)	Azure Cosmos を対象とする場合にプロパティがマップされるプロパティ名を構成します。
ToJsonProperty<TProperty>(PropertyBuilder<TProperty>, String)	Azure Cosmos を対象とする場合にプロパティがマップされるプロパティ名を構成します。
HasColumnName(PropertyBuilder, String)	リレーショナル データベースを対象とする場合にプロパティがマップされる列を構成します。
HasColumnName<TProperty>(PropertyBuilder<TProperty>, String)	リレーショナル データベースを対象とする場合にプロパティがマップされる列を構成します。
HasColumnOrder(PropertyBuilder, Nullable<Int32>)	プロパティがマップされる列の順序を構成します。
HasColumnOrder<TProperty>(PropertyBuilder<TProperty>, Nullable<Int32>)	プロパティがマップされる列の順序を構成します。
HasColumnType(PropertyBuilder, String)	リレーショナル データベースを対象とする場合にプロパティがマップされる列のデータ型を構成します。 これは、有効桁数、小数点以下桁数、長さなどを含む完全な型名である必要があります。
HasColumnType<TProperty>(PropertyBuilder<TProperty>, String)	リレーショナル データベースを対象とする場合にプロパティがマップされる列のデータ型を構成します。 これは、有効桁数、小数点以下桁数、長さなどを含む完全な型名である必要があります。
HasComment(PropertyBuilder, String)	列に適用するコメントを構成します
HasComment<TProperty>(PropertyBuilder<TProperty>, String)	列に適用するコメントを構成します
HasComputedColumnSql(PropertyBuilder)	リレーショナル データベースを対象とする場合に、計算列にマップするように プロパティを構成します。
HasComputedColumnSql(PropertyBuilder, String)	リレーショナル データベースを対象とする場合に、計算列にマップするように プロパティを構成します。
HasComputedColumnSql(PropertyBuilder, String, Nullable<Boolean>)	リレーショナル データベースを対象とする場合に、計算列にマップするように プロパティを構成します。
HasComputedColumnSql<TProperty>(PropertyBuilder<TProperty>)	リレーショナル データベースを対象とする場合に、計算列にマップするように プロパティを構成します。
HasComputedColumnSql<TProperty>(PropertyBuilder<TProperty>, String)	リレーショナル データベースを対象とする場合に、計算列にマップするように プロパティを構成します。
HasComputedColumnSql<TProperty>(PropertyBuilder<TProperty>, String, Nullable<Boolean>)	リレーショナル データベースを対象とする場合に、計算列にマップするように プロパティを構成します。
HasDefaultValue(PropertyBuilder)	リレーショナル データベースを対象とする場合にプロパティがマップされる列の既定値を構成します。
HasDefaultValue(PropertyBuilder, Object)	リレーショナル データベースを対象とする場合にプロパティがマップされる列の既定値を構成します。
HasDefaultValue<TProperty>(PropertyBuilder<TProperty>)	リレーショナル データベースを対象とする場合にプロパティがマップされる列の既定値を構成します。
HasDefaultValue<TProperty>(PropertyBuilder<TProperty>, Object)	リレーショナル データベースを対象とする場合にプロパティがマップされる列の既定値を構成します。
HasDefaultValueSql(PropertyBuilder)	リレーショナル データベースを対象とする場合にプロパティがマップされる列の既定値の式を構成します。
HasDefaultValueSql(PropertyBuilder, String)	リレーショナル データベースを対象とする場合にプロパティがマップされる列の既定値の式を構成します。
HasDefaultValueSql<TProperty>(PropertyBuilder<TProperty>)	リレーショナル データベースを対象とする場合にプロパティがマップされる列の既定値の式を構成します。
HasDefaultValueSql<TProperty>(PropertyBuilder<TProperty>, String)	リレーショナル データベースを対象とする場合にプロパティがマップされる列の既定値の式を構成します。
HasJsonPropertyName(PropertyBuilder, String)	エンティティ プロパティ名を使用するのではなく、JSON 列にマップされたエンティティのプロパティを構成し、エンティティ プロパティを特定の JSON プロパティにマッピングします。
HasJsonPropertyName<TProperty>(PropertyBuilder<TProperty>, String)	エンティティ プロパティ名を使用するのではなく、JSON 列にマップされたエンティティのプロパティを構成し、エンティティ プロパティを特定の JSON プロパティにマッピングします。
IsFixedLength(PropertyBuilder, Boolean)	文字列などの固定長データのみを格納できるプロパティを構成します。
IsFixedLength<TProperty>(PropertyBuilder<TProperty>, Boolean)	文字列などの固定長データのみを格納できるプロパティを構成します。
UseCollation(PropertyBuilder, String)	指定された照合順序を使用するように プロパティを構成します。 データベース列は、指定された照合順序で作成され、照合順序に依存するすべての操作で暗黙的に使用されます。
UseCollation<TProperty>(PropertyBuilder<TProperty>, String)	指定された照合順序を使用するように プロパティを構成します。 データベース列は、指定された照合順序で作成され、照合順序に依存するすべての操作で暗黙的に使用されます。
HasSrid(PropertyBuilder, Int32)	SQLite を対象とする場合にプロパティがマップされる列の SRID を構成します。
HasSrid<TProperty>(PropertyBuilder<TProperty>, Int32)	SQLite を対象とする場合にプロパティがマップされる列の SRID を構成します。
IsSparse(PropertyBuilder, Boolean)	SQL Serverをターゲットにするときに、プロパティの列をスパースとして作成するかどうかを構成します。
IsSparse<TProperty>(PropertyBuilder<TProperty>, Boolean)	SQL Serverをターゲットにするときに、プロパティの列をスパースとして作成するかどうかを構成します。
UseHiLo(PropertyBuilder, String, String)	SQL Serverをターゲットにするときに、シーケンスベースの hi-lo パターンを使用して新しいエンティティの値を生成するように key プロパティを構成します。 このメソッドは、 プロパティを に OnAdd設定します。
UseHiLo<TProperty>(PropertyBuilder<TProperty>, String, String)	SQL Serverをターゲットにするときに、シーケンスベースの hi-lo パターンを使用して新しいエンティティの値を生成するように key プロパティを構成します。 このメソッドは、 プロパティを に OnAdd設定します。
UseIdentityColumn(PropertyBuilder, Int32, Int32)	SQL Serverをターゲットにするときに、SQL Server IDENTITY 機能を使用して新しいエンティティの値を生成するようにキー プロパティを構成します。 このメソッドは、 プロパティを に OnAdd設定します。
UseIdentityColumn(PropertyBuilder, Int64, Int32)	SQL Serverをターゲットにするときに、SQL Server IDENTITY 機能を使用して新しいエンティティの値を生成するようにキー プロパティを構成します。 このメソッドは、 プロパティを に OnAdd設定します。
UseIdentityColumn<TProperty>(PropertyBuilder<TProperty>, Int32, Int32)	SQL Serverをターゲットにするときに、SQL Server IDENTITY 機能を使用して新しいエンティティの値を生成するようにキー プロパティを構成します。 このメソッドは、 プロパティを に OnAdd設定します。
UseIdentityColumn<TProperty>(PropertyBuilder<TProperty>, Int64, Int32)	SQL Serverをターゲットにするときに、SQL Server IDENTITY 機能を使用して新しいエンティティの値を生成するようにキー プロパティを構成します。 このメソッドは、 プロパティを に OnAdd設定します。
UseSequence(PropertyBuilder, String, String)	SQL Serverを対象とする場合に、シーケンスベースのキー値生成パターンを使用して新しいエンティティの値を生成するように key プロパティを構成します。 このメソッドは、 プロパティを に OnAdd設定します。
UseSequence<TProperty>(PropertyBuilder<TProperty>, String, String)	SQL Serverを対象とする場合に、シーケンスベースのキー値生成パターンを使用して新しいエンティティの値を生成するように key プロパティを構成します。 このメソッドは、 プロパティを に OnAdd設定します。