Class ForeignKeyIndexConvention

Namespace

Microsoft.EntityFrameworkCore.Metadata.Conventions

Assembly

Microsoft.EntityFrameworkCore.dll

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

public class ForeignKeyIndexConvention : IForeignKeyAddedConvention, IForeignKeyRemovedConvention, IForeignKeyPropertiesChangedConvention, IForeignKeyUniquenessChangedConvention, IKeyAddedConvention, IKeyRemovedConvention, IEntityTypeBaseTypeChangedConvention, IIndexAddedConvention, IIndexRemovedConvention, IIndexUniquenessChangedConvention, IModelFinalizingConvention, IConvention

Inheritance

object

ForeignKeyIndexConvention

Implements

IForeignKeyAddedConvention

IForeignKeyRemovedConvention

IForeignKeyPropertiesChangedConvention

IForeignKeyUniquenessChangedConvention

IKeyAddedConvention

IKeyRemovedConvention

IEntityTypeBaseTypeChangedConvention

IIndexAddedConvention

IIndexRemovedConvention

IIndexUniquenessChangedConvention

IModelFinalizingConvention

IConvention

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

See Model building conventions for more information and examples.

Constructors

ForeignKeyIndexConvention(ProviderConventionSetBuilderDependencies)

Creates a new instance of ForeignKeyIndexConvention.

public ForeignKeyIndexConvention(ProviderConventionSetBuilderDependencies dependencies)

Parameters

dependencies ProviderConventionSetBuilderDependencies

Parameter object containing dependencies for this convention.

Properties

Dependencies

Dependencies for this service.

protected virtual ProviderConventionSetBuilderDependencies Dependencies { get; }

Property Value

ProviderConventionSetBuilderDependencies

Methods

AreIndexedBy(IReadOnlyList<IConventionProperty>, bool, IReadOnlyList<IConventionProperty>, bool)

Returns a value indicating whether the given properties are already covered by an existing index.

protected virtual bool AreIndexedBy(IReadOnlyList<IConventionProperty> properties, bool unique, IReadOnlyList<IConventionProperty> coveringIndexProperties, bool coveringIndexUnique)

Parameters

properties IReadOnlyList<IConventionProperty>

The properties to check.

unique bool

Whether the index to create should be unique.

coveringIndexProperties IReadOnlyList<IConventionProperty>

The properties of an existing index.

coveringIndexUnique bool

Whether the existing index is unique.

Returns

bool

true if the existing index covers the given properties.

CreateIndex(IReadOnlyList<IConventionProperty>, bool, IConventionEntityTypeBuilder)

Creates an IConventionIndex.

protected virtual IConventionIndex? CreateIndex(IReadOnlyList<IConventionProperty> properties, bool unique, IConventionEntityTypeBuilder entityTypeBuilder)

Parameters

properties IReadOnlyList<IConventionProperty>

The properties that constitute the index.

unique bool

Whether the index to create should be unique.

entityTypeBuilder IConventionEntityTypeBuilder

The builder for the entity type.

Returns

IConventionIndex

The created index.

ProcessEntityTypeBaseTypeChanged(IConventionEntityTypeBuilder, IConventionEntityType?, IConventionEntityType?, IConventionContext<IConventionEntityType>)

Called after the base type of an entity type changes.

public virtual void ProcessEntityTypeBaseTypeChanged(IConventionEntityTypeBuilder entityTypeBuilder, IConventionEntityType? newBaseType, IConventionEntityType? oldBaseType, IConventionContext<IConventionEntityType> context)

Parameters

entityTypeBuilder IConventionEntityTypeBuilder

The builder for the entity type.

newBaseType IConventionEntityType

The new base entity type.

oldBaseType IConventionEntityType

The old base entity type.

context IConventionContext<IConventionEntityType>

Additional information associated with convention execution.

ProcessForeignKeyAdded(IConventionForeignKeyBuilder, IConventionContext<IConventionForeignKeyBuilder>)

Called after a foreign key is added to the entity type.

public virtual void ProcessForeignKeyAdded(IConventionForeignKeyBuilder relationshipBuilder, IConventionContext<IConventionForeignKeyBuilder> context)

Parameters

relationshipBuilder IConventionForeignKeyBuilder

The builder for the foreign key.

context IConventionContext<IConventionForeignKeyBuilder>

Additional information associated with convention execution.

ProcessForeignKeyPropertiesChanged(IConventionForeignKeyBuilder, IReadOnlyList<IConventionProperty>, IConventionKey, IConventionContext<IReadOnlyList<IConventionProperty>>)

Called after the foreign key properties or principal key are changed.

public virtual void ProcessForeignKeyPropertiesChanged(IConventionForeignKeyBuilder relationshipBuilder, IReadOnlyList<IConventionProperty> oldDependentProperties, IConventionKey oldPrincipalKey, IConventionContext<IReadOnlyList<IConventionProperty>> context)

Parameters

relationshipBuilder IConventionForeignKeyBuilder

The builder for the foreign key.

oldDependentProperties IReadOnlyList<IConventionProperty>

The old foreign key properties.

oldPrincipalKey IConventionKey

The old principal key.

context IConventionContext<IReadOnlyList<IConventionProperty>>

Additional information associated with convention execution.

ProcessForeignKeyRemoved(IConventionEntityTypeBuilder, IConventionForeignKey, IConventionContext<IConventionForeignKey>)

Called after a foreign key is removed.

public virtual void ProcessForeignKeyRemoved(IConventionEntityTypeBuilder entityTypeBuilder, IConventionForeignKey foreignKey, IConventionContext<IConventionForeignKey> context)

Parameters

entityTypeBuilder IConventionEntityTypeBuilder

The builder for the entity type.

foreignKey IConventionForeignKey

The removed foreign key.

context IConventionContext<IConventionForeignKey>

Additional information associated with convention execution.

ProcessForeignKeyUniquenessChanged(IConventionForeignKeyBuilder, IConventionContext<bool?>)

Called after the uniqueness for a foreign key is changed.

public virtual void ProcessForeignKeyUniquenessChanged(IConventionForeignKeyBuilder relationshipBuilder, IConventionContext<bool?> context)

Parameters

relationshipBuilder IConventionForeignKeyBuilder

The builder for the foreign key.

context IConventionContext<bool?>

Additional information associated with convention execution.

ProcessIndexAdded(IConventionIndexBuilder, IConventionContext<IConventionIndexBuilder>)

Called after an index is added to the entity type.

public virtual void ProcessIndexAdded(IConventionIndexBuilder indexBuilder, IConventionContext<IConventionIndexBuilder> context)

Parameters

indexBuilder IConventionIndexBuilder

The builder for the index.

context IConventionContext<IConventionIndexBuilder>

Additional information associated with convention execution.

ProcessIndexRemoved(IConventionEntityTypeBuilder, IConventionIndex, IConventionContext<IConventionIndex>)

Called after an index is removed.

public virtual void ProcessIndexRemoved(IConventionEntityTypeBuilder entityTypeBuilder, IConventionIndex index, IConventionContext<IConventionIndex> context)

Parameters

entityTypeBuilder IConventionEntityTypeBuilder

The builder for the entity type.

index IConventionIndex

The removed index.

context IConventionContext<IConventionIndex>

Additional information associated with convention execution.

ProcessIndexUniquenessChanged(IConventionIndexBuilder, IConventionContext<bool?>)

Called after the uniqueness for an index is changed.

public virtual void ProcessIndexUniquenessChanged(IConventionIndexBuilder indexBuilder, IConventionContext<bool?> context)

Parameters

indexBuilder IConventionIndexBuilder

The builder for the index.

context IConventionContext<bool?>

Additional information associated with convention execution.

ProcessKeyAdded(IConventionKeyBuilder, IConventionContext<IConventionKeyBuilder>)

Called after a key is added to the entity type.

public virtual void ProcessKeyAdded(IConventionKeyBuilder keyBuilder, IConventionContext<IConventionKeyBuilder> context)

Parameters

keyBuilder IConventionKeyBuilder

The builder for the key.

context IConventionContext<IConventionKeyBuilder>

Additional information associated with convention execution.

ProcessKeyRemoved(IConventionEntityTypeBuilder, IConventionKey, IConventionContext<IConventionKey>)

Called after a key is removed from the entity type.

public virtual void ProcessKeyRemoved(IConventionEntityTypeBuilder entityTypeBuilder, IConventionKey key, IConventionContext<IConventionKey> context)

Parameters

entityTypeBuilder IConventionEntityTypeBuilder

The builder for the entity type.

key IConventionKey

The key.

context IConventionContext<IConventionKey>

Additional information associated with convention execution.

ProcessModelFinalizing(IConventionModelBuilder, IConventionContext<IConventionModelBuilder>)

public virtual void ProcessModelFinalizing(IConventionModelBuilder modelBuilder, IConventionContext<IConventionModelBuilder> context)

Parameters

modelBuilder IConventionModelBuilder

context IConventionContext<IConventionModelBuilder>