IConventionModel 介面

定義

命名空間:

Microsoft.EntityFrameworkCore.Metadata

組件:

Microsoft.EntityFrameworkCore.dll

套件:

Microsoft.EntityFrameworkCore v8.0.0

實體圖形、實體之間的關聯性，以及它們如何對應至資料庫的中繼資料。 模型通常是藉由覆 OnModelCreating(ModelBuilder) 寫衍生 DbContext 上的 方法所建立。

[System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2072", Justification="TODO")]
public interface IConventionModel : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyModel

[<System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2072", Justification="TODO")>]
type IConventionModel = interface
    interface IReadOnlyModel
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionModel
Implements IConventionAnnotatable, IReadOnlyModel

屬性

UnconditionalSuppressMessageAttribute

實作

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyModel

備註

此介面會在模型建立期間使用，並允許修改中繼資料。 建置模型之後， IModel 表示相同中繼資料的唯讀檢視。

如需詳細資訊和範例，請參閱 模型建置慣例 。

屬性

Builder	取得可用來設定此模型的產生器。
IsInModel	指出這個物件是否在模型中，亦即尚未從其中一個物件中移除。 (繼承來源 IConventionAnnotatable)
Item[String]	取得具有指定名稱之注釋的值，如果不存在，則傳 null 回 。 (繼承來源 IReadOnlyAnnotatable)
ModelId	這是支援 Entity Framework Core 基礎結構的內部 API，不受與公用 API 相同的相容性標準。 它可能會在任何版本中變更或移除，而不需任何通知。 您應該只在程式碼中直接使用它，並特別小心，並知道這麼做可能會導致應用程式在更新至新的 Entity Framework Core 版本時失敗。 (繼承來源 IReadOnlyModel)

方法

AddAnnotation(String, Object, Boolean)	將注釋加入至這個物件。 如果具有指定名稱的注釋已經存在，則會擲回 。 (繼承來源 IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	將批註加入物件。 (繼承來源 IConventionAnnotatable)
AddEntityType(String, Boolean)	將預設類型的狀態實體類型新增至模型。
AddEntityType(String, String, IConventionEntityType, Boolean)	將具有定義導覽的擁有實體類型新增至模型。
AddEntityType(String, Type, Boolean)	將共用類型實體類型新增至模型。
AddEntityType(Type, Boolean)	將實體類型加入模型。
AddEntityType(Type, String, IConventionEntityType, Boolean)	將具有定義導覽的擁有實體類型新增至模型。
AddIgnored(String, Boolean)	將指定的實體類型名稱標示為忽略。
AddIgnored(Type, Boolean)	將指定的實體類型標示為忽略。
AddOwned(Type, Boolean)	將指定的實體類型標示為擁有，指出使用指定類型的探索到實體類型何時應設定為擁有。
AddOwnedEntityType(String, Boolean)	將預設類型的擁有實體類型新增至模型。
AddOwnedEntityType(String, Type, Boolean)	將擁有的共用類型實體類型新增至模型。
AddOwnedEntityType(Type, Boolean)	將擁有的實體類型新增至模型。
AddShared(Type, Boolean)	將指定的實體類型標示為共用，指出探索到的相符實體類型何時應設定為共用類型實體類型。
AnnotationsToDebugString(Int32)	取得 物件上宣告之所有注釋的偵錯字串。 (繼承來源 IReadOnlyAnnotatable)
DelayConventions()	防止在修改元資料層面時立即執行慣例。 所有延遲慣例都會在處置傳回的物件之後執行。
FinalizeModel()	強制在模型上進行後處理，使其可供執行時間使用。 這個後置處理會在使用 OnModelCreating(ModelBuilder) 時自動發生;這個方法允許在無法自動執行的情況下明確執行。
FindAnnotation(String)	取得具有指定名稱的注釋，如果不存在，則傳 null 回 。 (繼承來源 IReadOnlyAnnotatable)
FindEntityType(String)	取得具有指定名稱的實體。 null如果找不到具有指定名稱的實體類型，或共用類型實體類型正在使用指定的 CLR 類型，或實體類型具有定義導覽，則傳回 。
FindEntityType(String, String, IConventionEntityType)	取得指定名稱的實體類型，定義導覽名稱和定義實體類型。 如果找不到相符的實體類型，則傳 null 回 。
FindEntityType(String, String, IReadOnlyEntityType)	取得指定基底名稱的實體類型，定義導覽名稱和定義實體類型。 如果找不到相符的實體類型，則傳 null 回 。 (繼承來源 IReadOnlyModel)
FindEntityType(Type)	取得對應指定實體類別的實體。 null如果找不到具有指定名稱的實體類型，則傳回 。
FindEntityType(Type, String, IConventionEntityType)	取得指定名稱的實體類型，定義導覽名稱和定義實體類型。 如果找不到相符的實體類型，則傳 null 回 。
FindEntityType(Type, String, IReadOnlyEntityType)	取得指定型別的實體類型，定義導覽名稱和定義實體類型。 如果找不到相符的實體類型，則傳 null 回 。 (繼承來源 IReadOnlyModel)
FindEntityTypes(Type)	取得符合指定型別的實體類型。
FindIgnoredConfigurationSource(String)	指出是否忽略指定的實體類型名稱。
FindIgnoredConfigurationSource(Type)	指出是否忽略指定的實體類型。
FindIsOwnedConfigurationSource(Type)	如果指定的型別標示為擁有，則傳回組態來源。
FindIsSharedConfigurationSource(Type)	如果指定的類型標示為共用，則傳回組態來源。
FindLeastDerivedEntityTypes(Type, Func<IReadOnlyEntityType,Boolean>)	傳回對應至指定類型中最小衍生類型的實體類型。
GetAnnotation(String)	取得具有指定名稱的注釋，如果不存在，則會擲回。 (繼承來源 IReadOnlyAnnotatable)
GetAnnotations()	取得目前 物件上的所有批註。 (繼承來源 IReadOnlyAnnotatable)
GetChangeTrackingStrategy()	取得模型中實體所使用的預設變更追蹤策略。 此策略指出內容如何偵測實體類型實例的屬性變更。 (繼承來源 IReadOnlyModel)
GetChangeTrackingStrategyConfigurationSource()	傳回 的 GetChangeTrackingStrategy() 組態來源。
GetEntityTypes()	取得模型中定義的所有實體類型。
GetProductVersion()	取得用來建置此模型的 EF Core 元件版本。 (繼承來源 IReadOnlyModel)
GetPropertyAccessMode()	PropertyAccessMode取得用於這個模型中實體類型屬性的 。 (繼承來源 IReadOnlyModel)
GetPropertyAccessModeConfigurationSource()	傳回 的 GetPropertyAccessMode() 組態來源。
IsIgnored(String)	指出是否忽略指定的實體類型名稱。
IsIgnored(Type)	指出是否忽略指定的實體類型。
IsIgnoredType(Type)	指出是否應該忽略具有指定型別的實體類型和屬性。 此組態與 IsIgnored(Type)
IsOwned(Type)	傳回值，指出使用指定型別的實體類型是否應該在探索時設定為擁有的類型。
RemoveAnnotation(String)	從這個 物件中移除具有指定名稱的批註。 (繼承來源 IConventionAnnotatable)
RemoveEntityType(IConventionEntityType)	從模型移除實體類型。
RemoveEntityType(String)	從模型移除實體類型，而不定義導覽。
RemoveEntityType(String, String, IConventionEntityType)	移除具有指定類型的實體類型，定義導覽名稱和定義實體類型。
RemoveEntityType(Type)	從模型移除實體類型。
RemoveEntityType(Type, String, IConventionEntityType)	移除具有指定類型的實體類型，定義導覽名稱和定義實體類型。
RemoveIgnored(String)	移除忽略的實體類型名稱。
RemoveOwned(Type)	移除指定的擁有類型，指出探索到的相符實體類型不應該設定為擁有。
RemoveShared(Type)	將指定的類型標示為未共用，表示探索到的相符實體類型不應設定為共用類型實體類型時。
SetAnnotation(String, Object, Boolean)	設定儲存在指定名稱底下的批註。 如果具有指定名稱的注釋已經存在，則會覆寫現有的批註。 (繼承來源 IConventionAnnotatable)
SetChangeTrackingStrategy(Nullable<ChangeTrackingStrategy>, Boolean)	設定要用於模型中實體的預設變更追蹤策略。 此策略指出內容如何偵測實體類型實例的屬性變更。
SetOrRemoveAnnotation(String, Object, Boolean)	設定儲存在指定名稱底下的批註。 如果具有指定名稱的注釋已經存在，則會覆寫現有的批註。 如果 null 已提供，則會移除現有的批註。 (繼承來源 IConventionAnnotatable)
SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)	PropertyAccessMode設定要用於此模型中所有實體類型之屬性的 。
ToDebugString(MetadataDebugStringOptions, Int32)	建立人類可讀取的指定中繼資料標記法。 警告：請勿依賴傳回字串的格式。 它是專為偵錯而設計，而且可能會在發行之間任意變更。 (繼承來源 IReadOnlyModel)

擴充方法

GetDefaultContainer(IReadOnlyModel)	傳回預設容器名稱。
GetDefaultContainerConfigurationSource(IConventionModel)	傳回預設容器名稱的組態來源。
GetThroughput(IReadOnlyModel)	傳回資料庫範圍中布建的輸送量。
GetThroughputConfigurationSource(IConventionModel)	ConfigurationSource取得資料庫範圍中布建輸送量的 。
SetDefaultContainer(IConventionModel, String, Boolean)	設定預設容器名稱。
SetThroughput(IConventionModel, Nullable<Int32>, Nullable<Boolean>, Boolean)	在資料庫範圍設定布建的輸送量。
AddDbFunction(IConventionModel, MethodInfo, Boolean)	建立對應至指定方法的函式。
AddDbFunction(IConventionModel, String, Type, Boolean)	建立函式。
AddSequence(IConventionModel, String, String, Boolean)	傳回 IMutableSequence 具有指定架構中指定名稱的現有 ，或建立具有指定名稱和架構的新序列。
FindDbFunction(IConventionModel, MethodInfo)	尋找對應至指定 MethodInfo 所表示之 方法的函式。
FindDbFunction(IConventionModel, String)	尋找對應至指定名稱所表示之方法的函式。
FindDbFunction(IReadOnlyModel, MethodInfo)	尋找對應至指定 MethodInfo 所表示之 方法的函式。
FindDbFunction(IReadOnlyModel, String)	尋找對應至指定名稱所表示之方法的函式。
FindSequence(IConventionModel, String, String)	尋找具有指定名稱的序列。
FindSequence(IReadOnlyModel, String, String)	尋找具有指定名稱的序列。
GetCollation(IReadOnlyModel)	傳回資料庫定序。
GetCollationConfigurationSource(IConventionModel)	傳回定序的組態來源。
GetDbFunctions(IConventionModel)	傳回模型中包含的所有函式。
GetDbFunctions(IReadOnlyModel)	傳回模型中包含的所有函式。
GetDefaultSchema(IReadOnlyModel)	傳回要用於模型的預設架構，如果沒有設定，則 null 傳回 。
GetDefaultSchemaConfigurationSource(IConventionModel)	傳回預設架構的組態來源。
GetMaxIdentifierLength(IReadOnlyModel)	傳回存放區識別碼允許的最大長度。
GetMaxIdentifierLengthConfigurationSource(IConventionModel)	傳回 的 GetMaxIdentifierLength(IReadOnlyModel) 組態來源。
GetSequences(IConventionModel)	傳回模型中包含的所有序列。
GetSequences(IReadOnlyModel)	傳回模型中包含的所有序列。
RemoveDbFunction(IConventionModel, MethodInfo)	移除對應至指定 MethodInfo 所表示之 方法的函式。
RemoveDbFunction(IConventionModel, String)	移除對應至指定 MethodInfo 所表示之 方法的函式。
RemoveSequence(IConventionModel, String, String)	IConventionSequence移除具有指定名稱的 。
SetCollation(IConventionModel, String, Boolean)	設定資料庫定序。
SetDefaultSchema(IConventionModel, String, Boolean)	設定預設架構。
SetMaxIdentifierLength(IConventionModel, Nullable<Int32>, Boolean)	設定存放區識別碼允許的最大長度。
GetDatabaseMaxSize(IReadOnlyModel)	傳回資料庫的大小上限。
GetDatabaseMaxSizeConfigurationSource(IConventionModel)	傳 ConfigurationSource 回資料庫大小上限的 。
GetHiLoSequenceName(IReadOnlyModel)	傳回要用於預設 hi-lo 序列的名稱。
GetHiLoSequenceNameConfigurationSource(IConventionModel)	傳 ConfigurationSource 回預設 hi-lo 序列名稱的 。
GetHiLoSequenceSchema(IReadOnlyModel)	傳回要用於預設 hi-lo 序列的架構。 UseHiLo(PropertyBuilder, String, String)
GetHiLoSequenceSchemaConfigurationSource(IConventionModel)	傳 ConfigurationSource 回預設 hi-lo 序列架構的 。
GetIdentityIncrement(IReadOnlyModel)	傳回預設識別增量。
GetIdentityIncrementConfigurationSource(IConventionModel)	傳 ConfigurationSource 回預設識別增量的 。
GetIdentitySeed(IReadOnlyModel)	傳回預設身分識別種子。
GetIdentitySeedConfigurationSource(IConventionModel)	傳 ConfigurationSource 回預設架構的 。
GetPerformanceLevelSql(IReadOnlyModel)	傳回資料庫的效能層級。
GetPerformanceLevelSqlConfigurationSource(IConventionModel)	傳 ConfigurationSource 回資料庫效能層級的 。
GetSequenceNameSuffix(IReadOnlyModel)	傳回要附加至自動建立序列名稱的後置詞。
GetSequenceNameSuffixConfigurationSource(IConventionModel)	傳 ConfigurationSource 回預設值產生序列名稱尾碼的 。
GetSequenceSchema(IReadOnlyModel)	傳回要用於預設值產生序列的架構。 UseSequence(PropertyBuilder, String, String)
GetSequenceSchemaConfigurationSource(IConventionModel)	傳 ConfigurationSource 回預設索引鍵值產生順序架構的 。
GetServiceTierSql(IReadOnlyModel)	傳回資料庫的服務層級。
GetServiceTierSqlConfigurationSource(IConventionModel)	傳 ConfigurationSource 回資料庫之服務層級的 。
GetValueGenerationStrategy(IReadOnlyModel)	SqlServerValueGenerationStrategy傳回要用於模型中索引鍵屬性的 ，除非屬性已明確設定策略。
GetValueGenerationStrategyConfigurationSource(IConventionModel)	傳 ConfigurationSource 回預設 SqlServerValueGenerationStrategy 的 。
SetDatabaseMaxSize(IConventionModel, String, Boolean)	設定資料庫的大小上限。
SetHiLoSequenceName(IConventionModel, String, Boolean)	設定要用於預設 hi-lo 序列的名稱。
SetHiLoSequenceSchema(IConventionModel, String, Boolean)	設定要用於預設 hi-lo 序列的架構。
SetIdentityIncrement(IConventionModel, Nullable<Int32>, Boolean)	設定預設識別增量。
SetIdentitySeed(IConventionModel, Nullable<Int64>, Boolean)	設定預設身分識別種子。
SetPerformanceLevelSql(IConventionModel, String, Boolean)	設定資料庫的效能層級。
SetSequenceNameSuffix(IConventionModel, String, Boolean)	設定要附加至自動建立序列名稱的後置詞。
SetSequenceSchema(IConventionModel, String, Boolean)	設定要用於預設索引鍵值產生序列的架構。
SetServiceTierSql(IConventionModel, String, Boolean)	設定資料庫的服務層級。
SetValueGenerationStrategy(IConventionModel, Nullable<SqlServerValueGenerationStrategy>, Boolean)	SqlServerValueGenerationStrategy設定 ，用於模型中未明確設定策略的索引鍵屬性。