KeyDiscoveryConvention Class

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata.Conventions

Assembly:

Microsoft.EntityFrameworkCore.dll

Package:

Microsoft.EntityFrameworkCore v9.0.0

Source:

KeyDiscoveryConvention.cs

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

• Id
• [entity name]Id

public class KeyDiscoveryConvention : Microsoft.EntityFrameworkCore.Metadata.Conventions.IEntityTypeAddedConvention, Microsoft.EntityFrameworkCore.Metadata.Conventions.IEntityTypeBaseTypeChangedConvention, Microsoft.EntityFrameworkCore.Metadata.Conventions.IEntityTypeMemberIgnoredConvention, Microsoft.EntityFrameworkCore.Metadata.Conventions.IForeignKeyAddedConvention, Microsoft.EntityFrameworkCore.Metadata.Conventions.IForeignKeyOwnershipChangedConvention, Microsoft.EntityFrameworkCore.Metadata.Conventions.IForeignKeyPropertiesChangedConvention, Microsoft.EntityFrameworkCore.Metadata.Conventions.IForeignKeyRemovedConvention, Microsoft.EntityFrameworkCore.Metadata.Conventions.IForeignKeyUniquenessChangedConvention, Microsoft.EntityFrameworkCore.Metadata.Conventions.IKeyRemovedConvention, Microsoft.EntityFrameworkCore.Metadata.Conventions.IPropertyAddedConvention, Microsoft.EntityFrameworkCore.Metadata.Conventions.ISkipNavigationForeignKeyChangedConvention

type KeyDiscoveryConvention = class
    interface IEntityTypeAddedConvention
    interface IConvention
    interface IPropertyAddedConvention
    interface IKeyRemovedConvention
    interface IEntityTypeBaseTypeChangedConvention
    interface IEntityTypeMemberIgnoredConvention
    interface IForeignKeyAddedConvention
    interface IForeignKeyRemovedConvention
    interface IForeignKeyPropertiesChangedConvention
    interface IForeignKeyUniquenessChangedConvention
    interface IForeignKeyOwnershipChangedConvention
    interface ISkipNavigationForeignKeyChangedConvention

Public Class KeyDiscoveryConvention
Implements IEntityTypeAddedConvention, IEntityTypeBaseTypeChangedConvention, IEntityTypeMemberIgnoredConvention, IForeignKeyAddedConvention, IForeignKeyOwnershipChangedConvention, IForeignKeyPropertiesChangedConvention, IForeignKeyRemovedConvention, IForeignKeyUniquenessChangedConvention, IKeyRemovedConvention, IPropertyAddedConvention, ISkipNavigationForeignKeyChangedConvention

Inheritance

Object

KeyDiscoveryConvention

Derived

Microsoft.EntityFrameworkCore.Metadata.Conventions.CosmosKeyDiscoveryConvention

Microsoft.EntityFrameworkCore.Metadata.Conventions.RelationalKeyDiscoveryConvention

Implements

IConvention IEntityTypeAddedConvention IEntityTypeBaseTypeChangedConvention IForeignKeyAddedConvention IForeignKeyOwnershipChangedConvention IForeignKeyPropertiesChangedConvention IForeignKeyRemovedConvention IForeignKeyUniquenessChangedConvention IKeyRemovedConvention IPropertyAddedConvention ISkipNavigationForeignKeyChangedConvention IEntityTypeMemberIgnoredConvention

Remarks

If the entity type is owned through a reference navigation property then the corresponding foreign key properties are used.

If the entity type is owned through a collection navigation property then a composite primary key is configured using the foreign key properties with an extra property that matches the naming convention above.

If the entity type is a many-to-many join entity type then the many-to-many foreign key properties are used.

See Model building conventions for more information and examples.

Constructors

KeyDiscoveryConvention(ProviderConventionSetBuilderDependencies)

Creates a new instance of KeyDiscoveryConvention.

Properties

Dependencies

Dependencies for this service.

Methods

DiscoverKeyProperties(IConventionEntityType, IEnumerable<IConventionProperty>)	Returns the properties that should be used for the primary key.
DiscoverKeyProperties(IConventionEntityType)	Returns the properties that should be used for the primary key.
ProcessEntityTypeAdded(IConventionEntityTypeBuilder, IConventionContext<IConventionEntityTypeBuilder>)	Called after an entity type is added to the model.
ProcessEntityTypeBaseTypeChanged(IConventionEntityTypeBuilder, IConventionEntityType, IConventionEntityType, IConventionContext<IConventionEntityType>)	Called after the base type of an entity type changes.
ProcessEntityTypeMemberIgnored(IConventionEntityTypeBuilder, String, IConventionContext<String>)	Called after an entity type member is ignored.
ProcessForeignKeyAdded(IConventionForeignKeyBuilder, IConventionContext<IConventionForeignKeyBuilder>)	Called after a foreign key is added to the entity type.
ProcessForeignKeyOwnershipChanged(IConventionForeignKeyBuilder, IConventionContext<Nullable<Boolean>>)	Called after the ownership value for a foreign key is changed.
ProcessForeignKeyPropertiesChanged(IConventionForeignKeyBuilder, IReadOnlyList<IConventionProperty>, IConventionKey, IConventionContext<IReadOnlyList<IConventionProperty>>)	Called after the foreign key properties or principal key are changed.
ProcessForeignKeyRemoved(IConventionEntityTypeBuilder, IConventionForeignKey, IConventionContext<IConventionForeignKey>)	Called after a foreign key is removed.
ProcessForeignKeyUniquenessChanged(IConventionForeignKeyBuilder, IConventionContext<Nullable<Boolean>>)	Called after the uniqueness for a foreign key is changed.
ProcessKeyProperties(IList<IConventionProperty>, IConventionEntityType)	Adds or removes properties to be used for the primary key.
ProcessKeyRemoved(IConventionEntityTypeBuilder, IConventionKey, IConventionContext<IConventionKey>)	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.
ProcessPropertyAdded(IConventionPropertyBuilder, IConventionContext<IConventionPropertyBuilder>)	Called after a property is added to the entity type.
ProcessSkipNavigationForeignKeyChanged(IConventionSkipNavigationBuilder, IConventionForeignKey, IConventionForeignKey, IConventionContext<IConventionForeignKey>)	Called after a skip navigation inverse is changed.
ShouldDiscoverKeyProperties(IConventionEntityType)	Determines whether key properties should be discovered for the entity type.
TryConfigurePrimaryKey(IConventionEntityTypeBuilder)	Discovers primary key candidates and configures the primary key if found.