Class Key

Namespace

Microsoft.EntityFrameworkCore.Metadata.Internal

Assembly

Microsoft.EntityFrameworkCore.dll

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.

public class Key : ConventionAnnotatable, IMutableKey, IMutableAnnotatable, IConventionKey, IConventionAnnotatable, IRuntimeKey, IKey, IReadOnlyKey, IAnnotatable, IReadOnlyAnnotatable

Inheritance

object

AnnotatableBase

Annotatable

ConventionAnnotatable

Key

Implements

IMutableKey

IMutableAnnotatable

IConventionKey

IConventionAnnotatable

IRuntimeKey

IKey

IReadOnlyKey

IAnnotatable

IReadOnlyAnnotatable

Inherited Members

ConventionAnnotatable.GetAnnotations()

ConventionAnnotatable.AddAnnotation(string, object, ConfigurationSource)

ConventionAnnotatable.SetAnnotation(string, object)

ConventionAnnotatable.SetAnnotation(string, object, ConfigurationSource)

ConventionAnnotatable.SetOrRemoveAnnotation(string, object, ConfigurationSource)

ConventionAnnotatable.OnAnnotationSet(string, Annotation, Annotation)

ConventionAnnotatable.FindAnnotation(string)

ConventionAnnotatable.CreateAnnotation(string, object)

Annotatable.EnsureReadOnly()

Annotatable.EnsureMutable()

AnnotatableBase.AddAnnotation(string, object)

AnnotatableBase.AddAnnotation(string, Annotation)

AnnotatableBase.AddAnnotations(IEnumerable<IAnnotation>)

AnnotatableBase.AddAnnotations(IReadOnlyDictionary<string, object>)

AnnotatableBase.SetAnnotation(string, Annotation, Annotation)

AnnotatableBase.GetAnnotation(string)

AnnotatableBase.RemoveAnnotation(string)

AnnotatableBase.GetRuntimeAnnotations()

AnnotatableBase.AddRuntimeAnnotation(string, object)

AnnotatableBase.AddRuntimeAnnotation(string, Annotation)

AnnotatableBase.AddRuntimeAnnotations(IEnumerable<Annotation>)

AnnotatableBase.AddRuntimeAnnotations(IReadOnlyDictionary<string, object>)

AnnotatableBase.SetRuntimeAnnotation(string, object)

AnnotatableBase.SetRuntimeAnnotation(string, Annotation, Annotation)

AnnotatableBase.GetOrAddRuntimeAnnotationValue<TValue, TArg>(string, Func<TArg, TValue>, TArg)

AnnotatableBase.FindRuntimeAnnotation(string)

AnnotatableBase.RemoveRuntimeAnnotation(string)

AnnotatableBase.CreateRuntimeAnnotation(string, object)

AnnotatableBase.this[string]

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

KeyExtensions.IndexOf(IReadOnlyKey, IReadOnlyProperty)

Constructors

Key(IReadOnlyList<Property>, ConfigurationSource)

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.

public Key(IReadOnlyList<Property> properties, ConfigurationSource configurationSource)

Parameters

properties IReadOnlyList<Property>

configurationSource ConfigurationSource

Properties

Builder

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.

public virtual InternalKeyBuilder Builder { get; }

Property Value

InternalKeyBuilder

DebugView

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.

public virtual DebugView DebugView { get; }

Property Value

DebugView

DeclaringEntityType

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.

public virtual EntityType DeclaringEntityType { get; }

Property Value

EntityType

IdentityMapFactory

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.

public virtual Func<bool, IIdentityMap> IdentityMapFactory { get; }

Property Value

Func<bool, IIdentityMap>

IsInModel

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.

public virtual bool IsInModel { get; }

Property Value

bool

IsReadOnly

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.

public override bool IsReadOnly { get; }

Property Value

bool

Properties

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.

public virtual IReadOnlyList<Property> Properties { get; }

Property Value

IReadOnlyList<Property>

ReferencingForeignKeys

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.

public virtual ISet<ForeignKey>? ReferencingForeignKeys { get; set; }

Property Value

ISet<ForeignKey>

Methods

GetConfigurationSource()

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.

public virtual ConfigurationSource GetConfigurationSource()

Returns

ConfigurationSource

GetReferencingForeignKeys()

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.

public virtual IEnumerable<ForeignKey> GetReferencingForeignKeys()

Returns

IEnumerable<ForeignKey>

OnAnnotationSet(string, IConventionAnnotation?, IConventionAnnotation?)

Runs the conventions when an annotation was set or removed.

protected override IConventionAnnotation? OnAnnotationSet(string name, IConventionAnnotation? annotation, IConventionAnnotation? oldAnnotation)

Parameters

name string

The key of the set annotation.

annotation IConventionAnnotation

The annotation set.

oldAnnotation IConventionAnnotation

The old annotation.

Returns

IConventionAnnotation

The annotation that was set.

SetRemovedFromModel()

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.

public virtual void SetRemovedFromModel()

ToString()

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.

public override string ToString()

Returns

string

UpdateConfigurationSource(ConfigurationSource)

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.

public virtual void UpdateConfigurationSource(ConfigurationSource configurationSource)

Parameters

configurationSource ConfigurationSource