IConventionModel Interface

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Package:

Microsoft.EntityFrameworkCore v9.0.0

Source:

IConventionModel.cs

Metadata about the shape of entities, the relationships between them, and how they map to the database. A model is typically created by overriding the OnModelCreating(ModelBuilder) method on a derived 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

Attributes

UnconditionalSuppressMessageAttribute

Implements

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyModel

Remarks

This interface is used during model creation and allows the metadata to be modified. Once the model is built, IModel represents a read-only view of the same metadata.

See Model building conventions for more information and examples.

Properties

Builder	Gets the builder that can be used to configure this model.
IsInModel	Indicates whether this object is in a model, i.e. hasn't been removed from one. (Inherited from IConventionAnnotatable)
Item[String]	Gets the value of the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
ModelId	This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. (Inherited from IReadOnlyModel)

Methods

AddAnnotation(String, Object, Boolean)	Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Adds annotations to an object. (Inherited from IConventionAnnotatable)
AddEntityType(String, Boolean)	Adds a state entity type of default type to the model.
AddEntityType(String, String, IConventionEntityType, Boolean)	Adds an owned entity type with a defining navigation to the model.
AddEntityType(String, Type, Boolean)	Adds a shared type entity type to the model.
AddEntityType(Type, Boolean)	Adds an entity type to the model.
AddEntityType(Type, String, IConventionEntityType, Boolean)	Adds an owned entity type with a defining navigation to the model.
AddIgnored(String, Boolean)	Marks the given entity type name as ignored.
AddIgnored(Type, Boolean)	Marks the given entity type as ignored.
AddOwned(Type, Boolean)	Marks the given entity type as owned, indicating that when discovered entity types using the given type should be configured as owned.
AddOwnedEntityType(String, Boolean)	Adds an owned entity type of default type to the model.
AddOwnedEntityType(String, Type, Boolean)	Adds an owned shared type entity type to the model.
AddOwnedEntityType(Type, Boolean)	Adds an owned entity type to the model.
AddShared(Type, Boolean)	Marks the given entity type as shared, indicating that when discovered matching entity types should be configured as shared type entity type.
AnnotationsToDebugString(Int32)	Gets the debug string for all annotations declared on the object. (Inherited from IReadOnlyAnnotatable)
DelayConventions()	Prevents conventions from being executed immediately when a metadata aspect is modified. All the delayed conventions will be executed after the returned object is disposed.
FinalizeModel()	Forces post-processing on the model such that it is ready for use by the runtime. This post- processing happens automatically when using OnModelCreating(ModelBuilder); this method allows it to be run explicitly in cases where the automatic execution is not possible.
FindAnnotation(String)	Gets the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
FindEntityType(String, String, IConventionEntityType)	Gets the entity type for the given name, defining navigation name and the defining entity type. Returns null if no matching entity type is found.
FindEntityType(String, String, IReadOnlyEntityType)	Gets the entity type for the given base name, defining navigation name and the defining entity type. Returns null if no matching entity type is found. (Inherited from IReadOnlyModel)
FindEntityType(String)	Gets the entity with the given name. Returns null if no entity type with the given name is found or the given CLR type is being used by shared type entity type or the entity type has a defining navigation.
FindEntityType(Type, String, IConventionEntityType)	Gets the entity type for the given name, defining navigation name and the defining entity type. Returns null if no matching entity type is found.
FindEntityType(Type, String, IReadOnlyEntityType)	Gets the entity type for the given type, defining navigation name and the defining entity type. Returns null if no matching entity type is found. (Inherited from IReadOnlyModel)
FindEntityType(Type)	Gets the entity that maps the given entity class. Returns null if no entity type with the given name is found.
FindEntityTypes(Type)	Gets the entity types matching the given type.
FindIgnoredConfigurationSource(String)	Indicates whether the given entity type name is ignored.
FindIgnoredConfigurationSource(Type)	Indicates whether the given entity type is ignored.
FindIsOwnedConfigurationSource(Type)	Returns the configuration source if the given type is marked as owned.
FindIsSharedConfigurationSource(Type)	Returns the configuration source if the given type is marked as shared.
FindLeastDerivedEntityTypes(Type, Func<IReadOnlyEntityType,Boolean>)	Returns the entity types corresponding to the least derived types from the given one.
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist. (Inherited from IReadOnlyAnnotatable)
GetAnnotations()	Gets all annotations on the current object. (Inherited from IReadOnlyAnnotatable)
GetChangeTrackingStrategy()	Gets the default change tracking strategy being used for entities in the model. This strategy indicates how the context detects changes to properties for an instance of an entity type. (Inherited from IReadOnlyModel)
GetChangeTrackingStrategyConfigurationSource()	Returns the configuration source for GetChangeTrackingStrategy().
GetEmbeddedDiscriminatorName()	Gets the name to use for discriminator properties embedded in JSON documents. The default is "$type". (Inherited from IReadOnlyModel)
GetEmbeddedDiscriminatorNameConfigurationSource()	Returns the configuration source for GetEmbeddedDiscriminatorName().
GetEntityTypes()	Gets all entity types defined in the model.
GetProductVersion()	Gets the EF Core assembly version used to build this model. (Inherited from IReadOnlyModel)
GetPropertyAccessMode()	Gets the PropertyAccessMode being used for properties of entity types in this model. (Inherited from IReadOnlyModel)
GetPropertyAccessModeConfigurationSource()	Returns the configuration source for GetPropertyAccessMode().
IsIgnored(String)	Indicates whether the given entity type name is ignored.
IsIgnored(Type)	Indicates whether the given entity type is ignored.
IsIgnoredType(Type)	Indicates whether entity types and properties with the given type should be ignored. This configuration is independent from IsIgnored(Type)
IsOwned(Type)	Returns a value indicating whether the entity types using the given type should be configured as owned types when discovered.
RemoveAnnotation(String)	Removes the annotation with the given name from this object. (Inherited from IConventionAnnotatable)
RemoveEntityType(IConventionEntityType)	Removes an entity type from the model.
RemoveEntityType(String, String, IConventionEntityType)	Removes an entity type with the given type, defining navigation name and the defining entity type.
RemoveEntityType(String)	Removes an entity type without a defining navigation from the model.
RemoveEntityType(Type, String, IConventionEntityType)	Removes an entity type with the given type, defining navigation name and the defining entity type.
RemoveEntityType(Type)	Removes an entity type from the model.
RemoveIgnored(String)	Removes the ignored entity type name.
RemoveOwned(Type)	Removes the given owned type, indicating that when discovered matching entity types should not be configured as owned.
RemoveShared(Type)	Marks the given type as not shared, indicating that when discovered matching entity types should not be configured as shared type entity types.
SetAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from IConventionAnnotatable)
SetChangeTrackingStrategy(Nullable<ChangeTrackingStrategy>, Boolean)	Sets the default change tracking strategy to use for entities in the model. This strategy indicates how the context detects changes to properties for an instance of an entity type.
SetEmbeddedDiscriminatorName(String, Boolean)	Sets the name to use for discriminator properties embedded in JSON documents. The default is "$type".
SetOrRemoveAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. Removes the existing annotation if null is supplied. (Inherited from IConventionAnnotatable)
SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)	Sets the PropertyAccessMode to use for properties of all entity types in this model.
ToDebugString(MetadataDebugStringOptions, Int32)	Creates a human-readable representation of the given metadata. Warning: Do not rely on the format of the returned string. It is designed for debugging only and may change arbitrarily between releases. (Inherited from IReadOnlyModel)

Extension Methods

GetDefaultContainer(IReadOnlyModel)	Returns the default container name.
GetDefaultContainerConfigurationSource(IConventionModel)	Returns the configuration source for the default container name.
GetDiscriminatorInKey(IReadOnlyModel)	Returns a value indicating whether the entity type discriminator should be included in the JSON "id" value. Prior to EF Core 9, it was always included. Starting with EF Core 9, it is not included by default.
GetDiscriminatorInKeyConfigurationSource(IConventionModel)	Gets the ConfigurationSource for GetDiscriminatorInKey(IReadOnlyModel).
GetHasShadowIds(IReadOnlyModel)	Returns a value indicating whether the setting for always creating the "__id" property can be set from the current configuration source
GetHasShadowIdsConfigurationSource(IConventionModel)	Gets the ConfigurationSource for GetHasShadowIds(IReadOnlyModel).
GetThroughput(IReadOnlyModel)	Returns the provisioned throughput at database scope.
GetThroughputConfigurationSource(IConventionModel)	Gets the ConfigurationSource for the provisioned throughput at database scope.
SetDefaultContainer(IConventionModel, String, Boolean)	Sets the default container name.
SetDiscriminatorInKey(IConventionModel, Nullable<IdDiscriminatorMode>, Boolean)	Includes the entity type discriminator in the JSON "id".
SetHasShadowIds(IConventionModel, Nullable<Boolean>, Boolean)	Forces model building to always create a "__id" shadow property mapped to the JSON "id". This was the default behavior before EF Core 9.0.
SetThroughput(IConventionModel, Nullable<Int32>, Nullable<Boolean>, Boolean)	Sets the provisioned throughput at database scope.
AddDbFunction(IConventionModel, MethodInfo, Boolean)	Creates a function mapped to the given method.
AddDbFunction(IConventionModel, String, Type, Boolean)	Creates a function.
AddSequence(IConventionModel, String, String, Boolean)	Either returns the existing IMutableSequence with the given name in the given schema or creates a new sequence with the given name and schema.
FindDbFunction(IConventionModel, MethodInfo)	Finds a function that is mapped to the method represented by the given MethodInfo.
FindDbFunction(IConventionModel, String)	Finds a function that is mapped to the method represented by the given name.
FindDbFunction(IReadOnlyModel, MethodInfo)	Finds a function that is mapped to the method represented by the given MethodInfo.
FindDbFunction(IReadOnlyModel, String)	Finds a function that is mapped to the method represented by the given name.
FindSequence(IConventionModel, String, String)	Finds a sequence with the given name.
FindSequence(IReadOnlyModel, String, String)	Finds a sequence with the given name.
GetCollation(IReadOnlyModel)	Returns the database collation.
GetCollationConfigurationSource(IConventionModel)	Returns the configuration source for the collation.
GetDbFunctions(IConventionModel)	Returns all functions contained in the model.
GetDbFunctions(IReadOnlyModel)	Returns all functions contained in the model.
GetDefaultSchema(IReadOnlyModel)	Returns the default schema to use for the model, or null if none has been set.
GetDefaultSchemaConfigurationSource(IConventionModel)	Returns the configuration source for the default schema.
GetMaxIdentifierLength(IReadOnlyModel)	Returns the maximum length allowed for store identifiers.
GetMaxIdentifierLengthConfigurationSource(IConventionModel)	Returns the configuration source for GetMaxIdentifierLength(IReadOnlyModel).
GetSequences(IConventionModel)	Returns all sequences contained in the model.
GetSequences(IReadOnlyModel)	Returns all sequences contained in the model.
RemoveDbFunction(IConventionModel, MethodInfo)	Removes the function that is mapped to the method represented by the given MethodInfo.
RemoveDbFunction(IConventionModel, String)	Removes the function that is mapped to the method represented by the given MethodInfo.
RemoveSequence(IConventionModel, String, String)	Removes the IConventionSequence with the given name.
SetCollation(IConventionModel, String, Boolean)	Sets the database collation.
SetDefaultSchema(IConventionModel, String, Boolean)	Sets the default schema.
SetMaxIdentifierLength(IConventionModel, Nullable<Int32>, Boolean)	Sets the maximum length allowed for store identifiers.
GetDatabaseMaxSize(IReadOnlyModel)	Returns the maximum size of the database.
GetDatabaseMaxSizeConfigurationSource(IConventionModel)	Returns the ConfigurationSource for the maximum size of the database.
GetHiLoSequenceName(IReadOnlyModel)	Returns the name to use for the default hi-lo sequence.
GetHiLoSequenceNameConfigurationSource(IConventionModel)	Returns the ConfigurationSource for the default hi-lo sequence name.
GetHiLoSequenceSchema(IReadOnlyModel)	Returns the schema to use for the default hi-lo sequence. UseHiLo(PropertyBuilder, String, String)
GetHiLoSequenceSchemaConfigurationSource(IConventionModel)	Returns the ConfigurationSource for the default hi-lo sequence schema.
GetIdentityIncrement(IReadOnlyModel)	Returns the default identity increment.
GetIdentityIncrementConfigurationSource(IConventionModel)	Returns the ConfigurationSource for the default identity increment.
GetIdentitySeed(IReadOnlyModel)	Returns the default identity seed.
GetIdentitySeedConfigurationSource(IConventionModel)	Returns the ConfigurationSource for the default schema.
GetPerformanceLevelSql(IReadOnlyModel)	Returns the performance level of the database.
GetPerformanceLevelSqlConfigurationSource(IConventionModel)	Returns the ConfigurationSource for the performance level of the database.
GetSequenceNameSuffix(IReadOnlyModel)	Returns the suffix to append to the name of automatically created sequences.
GetSequenceNameSuffixConfigurationSource(IConventionModel)	Returns the ConfigurationSource for the default value generation sequence name suffix.
GetSequenceSchema(IReadOnlyModel)	Returns the schema to use for the default value generation sequence. UseSequence(PropertyBuilder, String, String)
GetSequenceSchemaConfigurationSource(IConventionModel)	Returns the ConfigurationSource for the default key value generation sequence schema.
GetServiceTierSql(IReadOnlyModel)	Returns the service tier of the database.
GetServiceTierSqlConfigurationSource(IConventionModel)	Returns the ConfigurationSource for the service tier of the database.
GetValueGenerationStrategy(IReadOnlyModel)	Returns the SqlServerValueGenerationStrategy to use for properties of keys in the model, unless the property has a strategy explicitly set.
GetValueGenerationStrategyConfigurationSource(IConventionModel)	Returns the ConfigurationSource for the default SqlServerValueGenerationStrategy.
SetDatabaseMaxSize(IConventionModel, String, Boolean)	Sets the maximum size of the database.
SetHiLoSequenceName(IConventionModel, String, Boolean)	Sets the name to use for the default hi-lo sequence.
SetHiLoSequenceSchema(IConventionModel, String, Boolean)	Sets the schema to use for the default hi-lo sequence.
SetIdentityIncrement(IConventionModel, Nullable<Int32>, Boolean)	Sets the default identity increment.
SetIdentitySeed(IConventionModel, Nullable<Int64>, Boolean)	Sets the default identity seed.
SetPerformanceLevelSql(IConventionModel, String, Boolean)	Sets the performance level of the database.
SetSequenceNameSuffix(IConventionModel, String, Boolean)	Sets the suffix to append to the name of automatically created sequences.
SetSequenceSchema(IConventionModel, String, Boolean)	Sets the schema to use for the default key value generation sequence.
SetServiceTierSql(IConventionModel, String, Boolean)	Sets the service tier of the database.
SetValueGenerationStrategy(IConventionModel, Nullable<SqlServerValueGenerationStrategy>, Boolean)	Sets the SqlServerValueGenerationStrategy to use for properties of keys in the model that don't have a strategy explicitly set.