IConventionPropertyBuilder インターフェイス

定義

from 規則を構成 IConventionProperty するための単純な API サーフェスを提供します。

このインターフェイスは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

public interface IConventionPropertyBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionAnnotatableBuilder
public interface IConventionPropertyBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBaseBuilder
public interface IConventionPropertyBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBaseBuilder<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder>
type IConventionPropertyBuilder = interface
    interface IConventionAnnotatableBuilder
type IConventionPropertyBuilder = interface
    interface IConventionPropertyBaseBuilder
    interface IConventionAnnotatableBuilder
type IConventionPropertyBuilder = interface
    interface IConventionPropertyBaseBuilder<IConventionPropertyBuilder>
    interface IConventionAnnotatableBuilder
Public Interface IConventionPropertyBuilder
Implements IConventionAnnotatableBuilder
Public Interface IConventionPropertyBuilder
Implements IConventionPropertyBaseBuilder
Public Interface IConventionPropertyBuilder
Implements IConventionPropertyBaseBuilder(Of 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)

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

CanSetField(FieldInfo, Boolean)

現在の構成ソースからこのプロパティに対してバッキング フィールドを設定できるかどうかを示す値を返します。

CanSetField(String, Boolean)

現在の構成ソースからこのプロパティに対してバッキング フィールドを設定できるかどうかを示す値を返します。

CanSetIsConcurrencyToken(Nullable<Boolean>, Boolean)

プロパティを現在の構成ソースからコンカレンシー トークンとして構成できるかどうかを示す値を返します。

CanSetIsRequired(Nullable<Boolean>, Boolean)

現在の構成ソースからこのプロパティの必須性を構成できるかどうかを示す値を返します。

CanSetIsUnicode(Nullable<Boolean>, Boolean)

現在の構成ソースから Unicode 文字を永続化できるように プロパティを構成できるかどうかを示す値を返します。

CanSetKeyValueComparer(ValueComparer, Boolean)
互換性のために残されています。

指定された を現在の ValueComparer 構成ソースからこのプロパティに対して構成できるかどうかを示す値を返します。

CanSetMaxLength(Nullable<Int32>, Boolean)

現在の構成ソースからこのプロパティに対して許可されるデータの最大長を設定できるかどうかを示す値を返します。

CanSetPrecision(Nullable<Int32>, Boolean)

現在の構成ソースからこのプロパティに対して許可されるデータの有効桁数を設定できるかどうかを示す値を返します。

CanSetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)

現在の構成ソースからこのプロパティに PropertyAccessMode を設定できるかどうかを示す値を返します。

CanSetProviderValueComparer(Type, Boolean)

指定された を現在の ValueComparer 構成ソースからこのプロパティに対して構成できるかどうかを示す値を返します。

CanSetProviderValueComparer(ValueComparer, Boolean)

指定された を現在の ValueComparer 構成ソースからこのプロパティに対して構成できるかどうかを示す値を返します。

CanSetScale(Nullable<Int32>, Boolean)

現在の構成ソースからこのプロパティに対して許可されるデータのスケールを設定できるかどうかを示す値を返します。

CanSetSentinel(Object, Boolean)

現在の構成ソースからこのプロパティに対して Sentinel を設定できるかどうかを示す値を返します。

CanSetStructuralValueComparer(ValueComparer, Boolean)
互換性のために残されています。

指定された を現在の ValueComparer 構成ソースからこのプロパティに対して構成できるかどうかを示す値を返します。

CanSetTypeMapping(CoreTypeMapping, Boolean)

指定された を現在の CoreTypeMapping 構成ソースからこのプロパティに対して構成できるかどうかを示す値を返します。

CanSetValueComparer(Type, Boolean)

指定された を現在の ValueComparer 構成ソースからこのプロパティに対して構成できるかどうかを示す値を返します。

CanSetValueComparer(ValueComparer, Boolean)

指定された を現在の ValueComparer 構成ソースからこのプロパティに対して構成できるかどうかを示す値を返します。

CanSetValueGenerated(Nullable<ValueGenerated>, Boolean)

プロパティ値の生成を現在の構成ソースから構成できるかどうかを示す値を返します。

CanSetValueGenerator(Func<IProperty,IEntityType,ValueGenerator>, Boolean)

を現在の構成ソースからこのプロパティに対して構成できるかどうかを ValueGenerator 示す値を返します。

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された を使用してデータベースとの間で変換されるようにプロパティを構成します。

HasField(FieldInfo, Boolean)

このプロパティに使用するバッキング フィールドを設定します。

HasField(String, Boolean)

このプロパティに使用するバッキング フィールドを設定します。

HasKeyValueComparer(ValueComparer, Boolean)
互換性のために残されています。

このプロパティの ValueComparer キー比較に使用する を構成します。

HasMaxLength(Nullable<Int32>, Boolean)

このプロパティに格納できるデータの最大長を構成します。

HasNoAnnotation(String, Boolean)

指定した名前の注釈をこのオブジェクトから削除します。

(継承元 IConventionPropertyBaseBuilder<TBuilder>)
HasNonNullAnnotation(String, Object, Boolean)

指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に同じまたはそれより低い ConfigurationSourceと存在する場合は、既存の注釈を上書きします。 value が指定されている場合 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 の既定値です。

HasStructuralValueComparer(ValueComparer, Boolean)
互換性のために残されています。

このプロパティの ValueComparer 構造比較に使用する を構成します。

HasTypeMapping(CoreTypeMapping, Boolean)

このプロパティの を CoreTypeMapping 構成します。

HasValueComparer(Type, Boolean)

このプロパティの を ValueComparer 構成します。

HasValueComparer(ValueComparer, Boolean)

このプロパティの を ValueComparer 構成します。

HasValueGenerator(Func<IProperty,IEntityType,ValueGenerator>, Boolean)

このプロパティの ValueGenerator 値を生成する を構成します。

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 必要があるか、有効な値であるかを構成します。 プロパティは、 を割り当て nullることができる CLR 型に基づいている場合にのみ、必須として構成できます。

IsUnicode(Nullable<Boolean>, Boolean)

プロパティが Unicode 文字を保持できるかどうかを構成します。

RemoveAnnotation(String, Boolean)
互換性のために残されています。

指定した名前の注釈をこのオブジェクトから削除します。

(継承元 IConventionAnnotatableBuilder)
SetElementType(Type, Boolean)

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

SetOrRemoveAnnotation(String, Object, Boolean)
互換性のために残されています。

指定した名前の下に格納されている注釈を設定または削除します。

(継承元 IConventionAnnotatableBuilder)
UsePropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)

このプロパティに PropertyAccessMode 使用する を設定します。

ValueGenerated(Nullable<ValueGenerated>, Boolean)

このプロパティの値がデータベースによって生成されるタイミングを示す値を設定します。 プロパティがデータベースによって生成されるように設定されている場合でも、エンティティが追加され、値が割り当てられている場合、またはプロパティが既存のエンティティに対して変更済みとしてマークされている場合、EF は (データベースによって生成される値ではなく) 特定の値を保存しようとする可能性があります。 詳細とGetAfterSaveBehavior()例についてはGetBeforeSaveBehavior()、 と を参照してください。

拡張メソッド

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, Object, 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)

指定された照合順序を使用するように プロパティを構成します。 データベース列は、指定された照合順序で作成され、照合順序に依存するすべての操作で暗黙的に使用されます。

CanSetGeometricDimension(IConventionPropertyBuilder, String, Boolean)

指定した値を列のディメンションとして設定できるかどうかを示す値を返します。

CanSetSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

指定した値を列の SRID として設定できるかどうかを示す値を返します。

ForSqliteHasDimension(IConventionPropertyBuilder, String, Boolean)
互換性のために残されています。

SQLite を対象とする場合にプロパティがマップされる列のディメンションを構成します。

ForSqliteHasSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)
互換性のために残されています。

SQLite を対象とする場合にプロパティがマップされる列の SRID を構成します。

HasGeometricDimension(IConventionPropertyBuilder, String, Boolean)

SQLite を対象とする場合にプロパティがマップされる列のディメンションを構成します。

HasSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

SQLite を対象とする場合にプロパティがマップされる列の SRID を構成します。

CanSetHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)

指定した名前とスキーマを hi-lo シーケンスに設定できるかどうかを示す値を返します。

CanSetIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, StoreObjectIdentifier, Boolean)

指定した値を特定のテーブルの ID の増分として設定できるかどうかを示す値SQL Server返します。

CanSetIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

指定した値を IDENTITY のインクリメントとして設定できるかどうかを示す値SQL Server返します。

CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

指定した値を IDENTITY のシードとして設定できるかどうかを示す値SQL Server返します。

CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, StoreObjectIdentifier, Boolean)

指定した値を特定のテーブルの ID のシードとして設定できるかどうかを示す値SQL Server返します。

CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, Boolean)

指定した値を IDENTITY のシードとして設定できるかどうかを示す値SQL Server返します。

CanSetIsSparse(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)

SQL Serverを対象とする場合に、プロパティの列をスパースとして構成できるかどうかを示す値を返します。

CanSetSequence(IConventionPropertyBuilder, String, String, Boolean)

キー値生成シーケンスに対して指定された名前とスキーマを設定できるかどうかを示す値を返します。

CanSetValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, StoreObjectIdentifier, Boolean)

指定した値を特定のテーブルの値生成戦略として設定できるかどうかを示す値を返します。

CanSetValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, Boolean)

指定した値を値生成戦略として設定できるかどうかを示す値を返します。

ForSqlServerHasHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)
互換性のために残されています。

SQL Serverを対象とする場合に、キー プロパティの値を生成するように hi-lo パターンに使用されるデータベース シーケンスを構成します。

ForSqlServerHasIdentityIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)
互換性のために残されています。

SQL SERVER IDENTITY の増分を構成します。

ForSqlServerHasIdentitySeed(IConventionPropertyBuilder, Nullable<Int32>, Boolean)
互換性のために残されています。

SQL SERVER IDENTITY のシードを構成します。

ForSqlServerHasValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, Boolean)
互換性のために残されています。

SQL Serverを対象とする場合に、キー プロパティの値生成戦略を構成します。

HasHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)

SQL Serverを対象とする場合に、キー プロパティの値を生成するように hi-lo パターンに使用されるデータベース シーケンスを構成します。

HasIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, StoreObjectIdentifier, Boolean)

特定のテーブルの SQL SERVER IDENTITY の増分を構成します。

HasIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

SQL SERVER IDENTITY の増分を構成します。

HasIdentityColumnSeed(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をターゲットにするときに、プロパティの列をスパースとして作成するかどうかを構成します。

適用対象