Table of Contents

Class ReferenceCollectionBuilder

Namespace
Microsoft.EntityFrameworkCore.Metadata.Builders
Assembly
Microsoft.EntityFrameworkCore.dll

Provides a simple API for configuring a one-to-many relationship.

public class ReferenceCollectionBuilder : RelationshipBuilderBase, IInfrastructure<IConventionForeignKeyBuilder>
Inheritance
ReferenceCollectionBuilder
Implements
Derived
Inherited Members
Extension Methods

Remarks

Instances of this class are returned from methods when using the ModelBuilder API and it is not designed to be directly constructed in your application code.

See Modeling entity types and relationships for more information and examples.

Constructors

ReferenceCollectionBuilder(IMutableEntityType, IMutableEntityType, IMutableForeignKey)

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.

[EntityFrameworkInternal]
public ReferenceCollectionBuilder(IMutableEntityType principalEntityType, IMutableEntityType dependentEntityType, IMutableForeignKey foreignKey)

Parameters

principalEntityType IMutableEntityType
dependentEntityType IMutableEntityType
foreignKey IMutableForeignKey

ReferenceCollectionBuilder(InternalForeignKeyBuilder, ReferenceCollectionBuilder, bool, bool, bool)

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.

[EntityFrameworkInternal]
protected ReferenceCollectionBuilder(InternalForeignKeyBuilder builder, ReferenceCollectionBuilder oldBuilder, bool foreignKeySet = false, bool principalKeySet = false, bool requiredSet = false)

Parameters

builder InternalForeignKeyBuilder
oldBuilder ReferenceCollectionBuilder
foreignKeySet bool
principalKeySet bool
requiredSet bool

Methods

HasAnnotation(string, object?)

Adds or updates an annotation on the relationship. If an annotation with the key specified in annotation already exists its value will be updated.

public virtual ReferenceCollectionBuilder HasAnnotation(string annotation, object? value)

Parameters

annotation string

The key of the annotation to be added or updated.

value object

The value to be stored in the annotation.

Returns

ReferenceCollectionBuilder

The same builder instance so that multiple configuration calls can be chained.

HasForeignKey(params string[])

Configures the property(s) to use as the foreign key for this relationship.

public virtual ReferenceCollectionBuilder HasForeignKey(params string[] foreignKeyPropertyNames)

Parameters

foreignKeyPropertyNames string[]

The name(s) of the foreign key property(s).

Returns

ReferenceCollectionBuilder

The same builder instance so that multiple configuration calls can be chained.

Remarks

If the specified property name(s) do not exist on the entity type then a new shadow state property(s) will be added to serve as the foreign key. A shadow state property is one that does not have a corresponding property in the entity class. The current value for the property is stored in the ChangeTracker rather than being stored in instances of the entity class.

If HasPrincipalKey(params string[]) is not specified, then an attempt will be made to match the data type and order of foreign key properties against the primary key of the principal entity type. If they do not match, new shadow state properties that form a unique index will be added to the principal entity type to serve as the reference key.

HasForeignKeyBuilder(IReadOnlyList<MemberInfo>)

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.

[EntityFrameworkInternal]
protected virtual InternalForeignKeyBuilder HasForeignKeyBuilder(IReadOnlyList<MemberInfo> foreignKeyMembers)

Parameters

foreignKeyMembers IReadOnlyList<MemberInfo>

Returns

InternalForeignKeyBuilder

HasForeignKeyBuilder(IReadOnlyList<string>)

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.

[EntityFrameworkInternal]
protected virtual InternalForeignKeyBuilder HasForeignKeyBuilder(IReadOnlyList<string> foreignKeyPropertyNames)

Parameters

foreignKeyPropertyNames IReadOnlyList<string>

Returns

InternalForeignKeyBuilder

HasPrincipalKey(params string[])

Configures the unique property(s) that this relationship targets. Typically you would only call this method if you want to use a property(s) other than the primary key as the principal property(s). If the specified property(s) is not already a unique constraint (or the primary key) then a new unique constraint will be introduced.

public virtual ReferenceCollectionBuilder HasPrincipalKey(params string[] keyPropertyNames)

Parameters

keyPropertyNames string[]

The name(s) of the referenced key property(s).

Returns

ReferenceCollectionBuilder

The same builder instance so that multiple configuration calls can be chained.

HasPrincipalKeyBuilder(IReadOnlyList<MemberInfo>)

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.

[EntityFrameworkInternal]
protected virtual InternalForeignKeyBuilder HasPrincipalKeyBuilder(IReadOnlyList<MemberInfo> keyMembers)

Parameters

keyMembers IReadOnlyList<MemberInfo>

Returns

InternalForeignKeyBuilder

HasPrincipalKeyBuilder(IReadOnlyList<string>)

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.

[EntityFrameworkInternal]
protected virtual InternalForeignKeyBuilder HasPrincipalKeyBuilder(IReadOnlyList<string> keyPropertyNames)

Parameters

keyPropertyNames IReadOnlyList<string>

Returns

InternalForeignKeyBuilder

IsRequired(bool)

Configures whether this is a required relationship (i.e. whether the foreign key property(s) can be assigned null).

public virtual ReferenceCollectionBuilder IsRequired(bool required = true)

Parameters

required bool

A value indicating whether this is a required relationship.

Returns

ReferenceCollectionBuilder

The same builder instance so that multiple configuration calls can be chained.

OnDelete(DeleteBehavior)

Configures the operation applied to dependent entities in the relationship when the principal is deleted or the relationship is severed.

public virtual ReferenceCollectionBuilder OnDelete(DeleteBehavior deleteBehavior)

Parameters

deleteBehavior DeleteBehavior

The action to perform.

Returns

ReferenceCollectionBuilder

The same builder instance so that multiple configuration calls can be chained.