Microsoft.EntityFrameworkCore.Metadata.Conventions Namespace

A convention that configures a property as having a backing field based on the BackingFieldAttribute attribute.

A convention that finds backing fields for properties based on their names:

• <[property name]>k__BackingField
• _[camel-cased property name]
• _[property name]
• m_[camel-cased property name]
• m_[property name]
• [property name]_

A convention that finds base and derived entity types that are already part of the model based on the associated CLR type hierarchy.

A convention that sets the delete behavior to Cascade for required foreign keys and ClientSetNull for optional ones.

A convention that sets a flag on the model to always skip detecting changes if no entity type is using the Snapshot strategy.

A convention that ensures that the check constraints on the derived types are compatible with the check constraints on the base type. And also ensures that the declaring type is current.

A convention that configures relationships between entity types based on the navigation properties as long as there is no ambiguity as to which is the corresponding inverse navigation.

A convention that configures types that have the ComplexTypeAttribute.

A convention that configures a property as a concurrency token if it has the ConcurrencyCheckAttribute.

A convention that binds entity type constructor parameters to existing properties and service properties based on their names:

• [parameter name]
• [pascal-cased parameter name]
• _[parameter name]
• _[pascal-cased parameter name]
• m_[parameter name]
• m_[pascal-cased parameter name]

A convention that configures the default container name as the context type name.

Represents a set of conventions used to build a model.

A convention that configures the discriminator value for entity types as the entity type name.

A convention that configures the inverse navigation property based on the InversePropertyAttribute specified on the other navigation property. All navigations are assumed to be targeting owned entity types for Cosmos.

A convention that configures mapping the PK and/or discriminator properties to the JSON 'id' property.

A convention that finds primary key property for the entity type based on the names and adds the partition key to it if present.

A convention that creates a join entity type for a many-to-many relationship and adds a partition key to it if the related types share one.

A convention that adds partition key properties to the EF primary key and adds the '__jObject' containing the JSON object returned by the store.

A convention that configures relationships between entity types based on the navigation properties as long as there is no ambiguity as to which is the corresponding inverse navigation. All navigations are assumed to be targeting owned entity types for Cosmos.

A convention that creates an optimized copy of the mutable model. This convention is typically implemented by database providers to update provider annotations when creating a read-only model.

A convention that configures store value generation as OnAdd on properties that are part of the primary key and not part of any foreign keys or were configured to have a database default value.

A convention that configures a property as OnAdd if Identity is specified, OnAddOrUpdate if Computed is specified or Never if None is specified using a DatabaseGeneratedAttribute.

A convention configure type mapping for IDbFunction instances.

A convention that adds entity types based on the DbSet<TEntity> properties defined on the derived DbContext class.

Convention that converts accesses of DbSet<TEntity> inside query filters and defining queries into EntityQueryRootExpression. This makes them consistent with how DbSet accesses in the actual queries are represented, which allows for easier processing in the query pipeline.

A convention that configures the delete behavior based on the DeleteBehaviorAttribute applied on the property.

A convention that finds derived entity types that are already part of the model based on the associated CLR type hierarchy.

A convention that configures the discriminator value for entity types in a hierarchy as the entity type name.

A convention that sets the maximum length for string discriminator properties.

A convention that ensures property mappings have any ElementMapping discovered by the type mapper.

A convention that reacts to changes made to element types of primitive collections.

A convention that creates linking relationships for entity splitting and manages the mapping fragments.

A base type for conventions that perform configuration based on an attribute specified on an entity type.

A convention that applies the entity type configuration specified in EntityTypeConfigurationAttribute.

A convention that applies the entity type configuration specified in EntityTypeConfigurationAttribute.

A convention that removes discriminators from non-TPH entity types and unmaps the inherited properties for TPT entity types.

A convention that adds etag metadata on the concurrency token, if present.

A convention that configures the foreign key properties associated with a navigation property based on the ForeignKeyAttribute specified on the properties or the navigation properties.

A convention that creates indexes on foreign key properties unless they are already covered by existing indexes or keys.

A convention that finds foreign key properties for relationships based on their names, ignoring case:

• [navigation property name][principal key property name]
• [navigation property name]Id
• [principal entity name][principal key property name]
• [principal entity name]Id

A convention that configures database indexes based on the IndexAttribute.

Base type for inheritance discovery conventions

A convention that configures the inverse navigation property based on the InversePropertyAttribute specified on the other navigation property.

A convention that configures the entity type key based on the KeyAttribute specified on a property or PrimaryKeyAttribute specified on a CLR type.

A convention that finds primary key property for the entity type based on the names, ignoring case:

• Id
• [entity name]Id

A convention that ignores entity types that have the KeylessAttribute.

A convention that ignores entity types that have the KeylessAttribute.

A convention which looks for matching skip navigations and automatically creates a many-to-many join entity with suitable foreign keys, sets the two matching skip navigations to use those foreign keys.

A convention that configures the maximum length based on the MaxLengthAttribute applied on the property.

A convention that removes any state that is only used during model building.

A base type for conventions that perform configuration based on an attribute applied to a navigation.

A convention that configures a navigation property as having a backing field based on the BackingFieldAttribute attribute.

A convention that configures the navigations to owned entity types as eager loaded.

A base type for conventions that configure model aspects based on whether the member type is a non-nullable reference type.

A convention that configures the non-nullable navigations to principal entity type as required.

A convention that configures the properties of non-nullable types as required.

A convention that ignores entity types that have the NotMappedAttribute.

A convention that ignores members on entity types that have the NotMappedAttribute.

A convention that ignores entity types that have the NotMappedAttribute.

A convention that configures the entity types that have the OwnedAttribute as owned.

A convention that configures the entity types that have the OwnedAttribute as owned.

A convention that configures owned entity types with defining navigation as owned entity types without defining navigation if there's only one navigation of this type.

A convention that configures the Precision based on the PrecisionAttribute applied on the property.

A base type for conventions that perform configuration based on an attribute applied to a property.

A convention that adds properties to entity types corresponding to scalar public properties on the CLR type.

A convention that ensures that the declaring property is current for the property overrides.

Convention that converts accesses of DbSets inside query filters and defining queries into EntityQueryables. This makes them consistent with how DbSet accesses in the actual queries are represented, which allows for easier processing in the query pipeline.

Convention that converts accesses of DbSet<TEntity> inside query filters into EntityQueryRootExpression. This makes them consistent with how DbSet accesses in the actual queries are represented, which allows for easier processing in the query pipeline.

A visitor that rewrites DbSet accesses encountered in an expression to EntityQueryRootExpression.

A convention that configures column name and type for a property based on the applied ColumnAttribute.

A convention that configures the column comment for a property or field based on the applied CommentAttribute.

A convention that configures model function mappings based on public static methods on the context marked with DbFunctionAttribute.

A relational-specific convention inheriting from KeyDiscoveryConvention.

A convention that configures default settings for an entity mapped to a JSON column.

A convention that configures the maximum object identifier length supported by the database.

A convention that precomputes a relational model.

A convention that configures a JSON element name for the navigation property mapped to json based on the JsonPropertyNameAttribute attribute.

A convention that configures JSON property name based on the applied JsonPropertyNameAttribute.

Convention that converts accesses of DbSet<TEntity> inside query filters into EntityQueryRootExpression. This makes them consistent with how DbSet accesses in the actual queries are represented, which allows for easier processing in the query pipeline.

A visitor that rewrites DbSet accesses encountered in an expression to EntityQueryRootExpression.

A convention that creates an optimized copy of the mutable model. This convention is typically implemented by database providers to update provider annotations when creating a read-only model.

A convention that configures the table name and schema for entity types based on the applied TableAttribute.

A convention that configures the table comment for an entity type based on the applied CommentAttribute.

A convention that configures store value generation as OnAdd on properties that are part of the primary key and not part of any foreign keys or were configured to have a database default value. It also configures properties as OnAddOrUpdate if they were configured as computed columns.

A convention that configures relationships between entity types based on the navigation properties as long as there is no ambiguity as to which is the corresponding inverse navigation.

A convention that configures the principal side of the relationship as required if the RequiredAttribute is applied on the navigation property to the principal entity type.

A convention that configures properties as required if they have the RequiredAttribute applied.

A convention that creates an optimized copy of the mutable model. This convention is typically implemented by database providers to update provider annotations when creating a read-only model.

A visitor that rewrites EntityQueryRootExpression encountered in an expression to use a different entity type.

A convention which ensures that all sequences in the model have unique names within a schema when truncated to the maximum identifier length for the model.

A convention that adds service properties to entity types.

A convention that manipulates names of database objects for entity types that share a table to avoid clashes.

A builder for building conventions for SQLite.

A convention that creates an optimized copy of the mutable model.

A convention that manipulates names of database objects for entity types that share a table to avoid clashes.

A builder for building conventions for SQL Server.

A convention that ensures that Schema is populated for database functions which have IsBuiltIn flag set to false.

A convention that configures the filter for unique non-clustered indexes with nullable columns to filter out null values.

A convention that configures indexes as non-clustered for memory-optimized tables.

A convention that configures the OnDelete behavior for foreign keys on the join entity type for self-referencing skip navigations

A convention that configures tables with triggers to not use the OUTPUT clause when saving changes.

A convention that creates an optimized copy of the mutable model.

A convention that manipulates names of database objects for entity types that share a table to avoid clashes.

A convention that ensures that properties aren't configured to have a default value, as computed column or using a SqlServerValueGenerationStrategy at the same time.

A convention that manipulates temporal settings for an entity mapped to a temporal table.

A convention that configures store value generation as OnAdd on properties that are part of the primary key and not part of any foreign keys, were configured to have a database default value or were configured to use a SqlServerValueGenerationStrategy. It also configures properties as OnAddOrUpdate if they were configured as computed columns.

A convention that configures the default model SqlServerValueGenerationStrategy as IdentityColumn.

A convention that ensures that the entity type is current for the stored procedures.

A convention that ensures that properties aren't configured to have a default value and as computed column at the same time.

A convention that adds the 'id' property - a key required by Azure Cosmos.

A convention that configures the maximum length based on the StringLengthAttribute applied on the property.

A convention that configures the table name based on the DbSet<TEntity> property name.

A convention that finds entity types which share a table which has a concurrency token column where those entity types do not have a property mapped to that column. It then creates a shadow concurrency property mapped to that column on the base-most entity type(s).

A convention that configures the entity type to which a queryable function is mapped.

A convention that configures the property as a concurrency token if a TimestampAttribute is applied to it.

A base type for conventions that perform configuration based on an attribute specified on a structural type.

A convention that creates and assigns store type mapping to entity properties.

A convention that configures the Unicode based on the UnicodeAttribute applied on the property.

A convention that checks whether the model is valid.

A convention that configures store value generation as OnAdd on properties that are part of the primary key and not part of any foreign keys.

Represents an operation that should be performed when a complex property is added to an type-like object.

Represents an operation that should be performed when an annotation is changed on a complex property.

Represents an operation that should be performed when the backing field for a complex property is changed.

Represents an operation that should be performed when the nullability for a complex property is changed.

Represents an operation that should be performed when a complex property is removed from a type-like object.

Represents an operation that should be performed when an annotation is changed on a complex type.

Represents an operation that should be performed when a complex type member is ignored.

This is the base interface for all convention interfaces, it should not be implemented directly.

Represents an object that delays any convention invocations until it is run or disposed.

Contextual information associated with each convention call.

Contextual information associated with each convention call.

Represents an operation that should be performed when a discriminator property is set for an entity type.

Represents an operation that should be performed when an annotation is changed on the elements of a collection property.

Represents an operation that should be performed when the nullability on the elements of a collection property has changed.

Represents an operation that should be performed when an entity type is added to the model.

Represents an operation that should be performed when an annotation is changed on an entity type.

Represents an operation that should be performed when the base type of an entity type changes.

Represents an operation that should be performed when an entity type is ignored.

Represents an operation that should be performed when an entity type member is ignored.

Represents an operation that should be performed when the primary key for an entity type is changed.

Represents an operation that should be performed when an entity type is removed from the model.

Represents an operation that should be performed when a foreign key is added to the entity type.

Represents an operation that should be performed when an annotation is changed on a foreign key.

Represents an operation that should be performed when the dependent requiredness for a foreign key is changed.

Represents an operation that should be performed when a navigation is set to null on a foreign key.

Represents an operation that should be performed when the ownership value for a foreign key is changed.

Represents an operation that should be performed when the principal end of a foreign key is changed.

Represents an operation that should be performed when the foreign key properties or principal key are changed.

Represents an operation that should be performed when a foreign key is removed.

Represents an operation that should be performed when the requiredness for a foreign key is changed.

Represents an operation that should be performed when the uniqueness for a foreign key is changed.

Represents an operation that should be performed when an index is added to the entity type.

Represents an operation that should be performed when an annotation is changed on an index.

Represents an operation that should be performed when an index is removed from the entity type.

Represents an operation that should be performed when the sort order of an index is changed.

Represents an operation that should be performed when the uniqueness for an index is changed.

Represents an operation that should be performed when a key is added to the entity type.

Represents an operation that should be performed when an annotation is changed on a key.

Represents an operation that should be performed when a key is removed.

Represents an operation that should be performed when an annotation is changed on a model.

Represents an operation that should be performed when the embedded discriminator name for the model changes.

Represents an operation that should be performed after a model is finalized and can no longer be mutated.

Represents an operation that should be performed when a model is being finalized.

Represents an operation that should be performed when a model is initialized.

Represents an operation that should be performed when a navigation is added to the entity type.

Represents an operation that should be performed when an annotation is changed on a navigation.

Represents an operation that should be performed when a navigation is removed from the entity type.

Represents an operation that should be performed when a property is added to the entity type.

Represents an operation that should be performed when an annotation is changed on a property.

Represents an operation that should be performed when the IElementType for a property is changed.

Represents an operation that should be performed when the backing field for a property is changed.

Represents an operation that should be performed when the nullability for a property is changed.

Represents an operation that should be performed when a property is removed from the entity type.

Represents an operation that should be performed when a skip navigation is added to the entity type.

Represents an operation that should be performed when an annotation is changed on a skip navigation.

Represents an operation that should be performed when a skip navigation foreign key is changed.

Represents an operation that should be performed when a skip navigation inverse is changed.

Represents an operation that should be performed when a skip navigation is removed from the entity type.

Represents an operation that should be performed when a trigger is added to the entity type.

Represents an operation that should be performed when a trigger is removed from the entity type.

Represents an operation that should be performed when a type is ignored.