Class ReferenceReferenceBuilder

Namespace

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly

Microsoft.EntityFrameworkCore.dll

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

public class ReferenceReferenceBuilder : InvertibleRelationshipBuilderBase, IInfrastructure<IConventionForeignKeyBuilder>

Inheritance

object

InvertibleRelationshipBuilderBase

ReferenceReferenceBuilder

Implements

IInfrastructure<IConventionForeignKeyBuilder>

Derived

ReferenceReferenceBuilder<TEntity, TRelatedEntity>

Inherited Members

InvertibleRelationshipBuilderBase.DeclaringEntityType

InvertibleRelationshipBuilderBase.RelatedEntityType

InvertibleRelationshipBuilderBase.Builder

InvertibleRelationshipBuilderBase.Metadata

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AccessorExtensions.GetInfrastructure<T>(IInfrastructure<T>)

Remarks

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

Constructors

ReferenceReferenceBuilder(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 ReferenceReferenceBuilder(IMutableEntityType declaringEntityType, IMutableEntityType relatedEntityType, IMutableForeignKey foreignKey)

Parameters

declaringEntityType IMutableEntityType

relatedEntityType IMutableEntityType

foreignKey IMutableForeignKey

ReferenceReferenceBuilder(InternalForeignKeyBuilder, ReferenceReferenceBuilder, bool, 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 ReferenceReferenceBuilder(InternalForeignKeyBuilder builder, ReferenceReferenceBuilder oldBuilder, bool inverted = false, bool foreignKeySet = false, bool principalKeySet = false, bool requiredSet = false)

Parameters

builder InternalForeignKeyBuilder

oldBuilder ReferenceReferenceBuilder

inverted bool

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 ReferenceReferenceBuilder 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

ReferenceReferenceBuilder

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

HasForeignKey(string, params string[])

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

public virtual ReferenceReferenceBuilder HasForeignKey(string dependentEntityTypeName, params string[] foreignKeyPropertyNames)

Parameters

dependentEntityTypeName string

The name of the entity type that is the dependent in this relationship (the type that has the foreign key properties).

foreignKeyPropertyNames string[]

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

Returns

ReferenceReferenceBuilder

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(Type, 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.

HasForeignKey(Type, params string[])

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

public virtual ReferenceReferenceBuilder HasForeignKey(Type dependentEntityType, params string[] foreignKeyPropertyNames)

Parameters

dependentEntityType Type

The entity type that is the dependent in this relationship (the type that has the foreign key properties).

foreignKeyPropertyNames string[]

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

Returns

ReferenceReferenceBuilder

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(Type, 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(EntityType, string, 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(EntityType dependentEntityType, string dependentEntityTypeName, IReadOnlyList<MemberInfo> foreignKeyMembers)

Parameters

dependentEntityType EntityType

dependentEntityTypeName string

foreignKeyMembers IReadOnlyList<MemberInfo>

Returns

InternalForeignKeyBuilder

HasForeignKeyBuilder(EntityType, string, 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(EntityType dependentEntityType, string dependentEntityTypeName, IReadOnlyList<string> foreignKeyPropertyNames)

Parameters

dependentEntityType EntityType

dependentEntityTypeName string

foreignKeyPropertyNames IReadOnlyList<string>

Returns

InternalForeignKeyBuilder

HasPrincipalKey(string, 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 ReferenceReferenceBuilder HasPrincipalKey(string principalEntityTypeName, params string[] keyPropertyNames)

Parameters

principalEntityTypeName string

The name of the entity type that is the principal in this relationship (the type that has the reference key properties).

keyPropertyNames string[]

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

Returns

ReferenceReferenceBuilder

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

Remarks

If multiple principal key properties are specified, the order of principal key properties should match the order that the primary key or unique constraint properties were configured on the principal entity type.

HasPrincipalKey(Type, 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 ReferenceReferenceBuilder HasPrincipalKey(Type principalEntityType, params string[] keyPropertyNames)

Parameters

principalEntityType Type

The entity type that is the principal in this relationship (the type that has the reference key properties).

keyPropertyNames string[]

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

Returns

ReferenceReferenceBuilder

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

Remarks

If multiple principal key properties are specified, the order of principal key properties should match the order that the primary key or unique constraint properties were configured on the principal entity type.

HasPrincipalKeyBuilder(EntityType, string, 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(EntityType principalEntityType, string principalEntityTypeName, IReadOnlyList<MemberInfo> foreignKeyMembers)

Parameters

principalEntityType EntityType

principalEntityTypeName string

foreignKeyMembers IReadOnlyList<MemberInfo>

Returns

InternalForeignKeyBuilder

HasPrincipalKeyBuilder(EntityType, string, 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(EntityType principalEntityType, string principalEntityTypeName, IReadOnlyList<string> foreignKeyPropertyNames)

Parameters

principalEntityType EntityType

principalEntityTypeName string

foreignKeyPropertyNames 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 ReferenceReferenceBuilder IsRequired(bool required = true)

Parameters

required bool

A value indicating whether this is a required relationship.

Returns

ReferenceReferenceBuilder

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 ReferenceReferenceBuilder OnDelete(DeleteBehavior deleteBehavior)

Parameters

deleteBehavior DeleteBehavior

The action to perform.

Returns

ReferenceReferenceBuilder

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

ResolveEntityType(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 EntityType? ResolveEntityType(string entityTypeName)

Parameters

entityTypeName string

Returns

EntityType

ResolveEntityType(Type)

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 EntityType? ResolveEntityType(Type entityType)

Parameters

entityType Type

Returns

EntityType