RuntimeKey Class

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Package:

Microsoft.EntityFrameworkCore v9.0.0

Source:

RuntimeKey.cs

Represents a primary or alternate key on an entity type.

public class RuntimeKey : Microsoft.EntityFrameworkCore.Infrastructure.RuntimeAnnotatableBase, Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeKey

type RuntimeKey = class
    inherit RuntimeAnnotatableBase
    interface IRuntimeKey
    interface IKey
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IAnnotatable

Public Class RuntimeKey
Inherits RuntimeAnnotatableBase
Implements IRuntimeKey

Inheritance

Object

RuntimeAnnotatableBase

RuntimeKey

Implements

IAnnotatable IReadOnlyAnnotatable IKey Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeKey IReadOnlyKey

Remarks

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

Constructors

RuntimeKey(IReadOnlyList<RuntimeProperty>)

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.

Properties

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.
DeclaringEntityType	Gets the entity type the key is defined on. This may be different from the type that Properties are defined on when the key is defined a derived type in an inheritance hierarchy (since the properties may be defined on a base type).
Item[String]	Gets the value annotation with the given name, returning null if it does not exist. (Inherited from RuntimeAnnotatableBase)
Properties	Gets the properties that make up the key.
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.

Methods

AddAnnotation(String, Object)	Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase)
AddAnnotations(IEnumerable<IAnnotation>)	Adds annotations to this object overriding any existing annotations with the same name. (Inherited from RuntimeAnnotatableBase)
AddAnnotations(IReadOnlyDictionary<String,Object>)	Adds annotations to this object overriding any existing annotations with the same name. (Inherited from RuntimeAnnotatableBase)
AddRuntimeAnnotation(String, Annotation)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase)
AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase)
AddRuntimeAnnotations(IEnumerable<Annotation>)	Adds runtime annotations to this object. (Inherited from RuntimeAnnotatableBase)
AddRuntimeAnnotations(IReadOnlyDictionary<String,Object>)	Adds runtime annotations to this object. (Inherited from RuntimeAnnotatableBase)
CreateAnnotation(String, Object)	Creates a new annotation. (Inherited from RuntimeAnnotatableBase)
CreateRuntimeAnnotation(String, Object)	Creates a new runtime annotation. (Inherited from RuntimeAnnotatableBase)
FindAnnotation(String)	Gets the annotation with the given name, returning null if it does not exist. (Inherited from RuntimeAnnotatableBase)
FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning null if it does not exist. (Inherited from RuntimeAnnotatableBase)
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist. (Inherited from RuntimeAnnotatableBase)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	Gets the value of the runtime annotation with the given name, adding it if one does not exist. (Inherited from RuntimeAnnotatableBase)
GetRuntimeAnnotations()	Gets all runtime annotations on the current object. (Inherited from RuntimeAnnotatableBase)
RemoveAnnotation(String)	Removes the given annotation from this object. (Inherited from RuntimeAnnotatableBase)
RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from RuntimeAnnotatableBase)
SetAnnotation(String, Object)	Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase)
SetIdentityMapFactory(Func<Boolean,IIdentityMap>)	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.
SetPrincipalKeyValueFactory<TKey>(IPrincipalKeyValueFactory<TKey>)	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.
SetRuntimeAnnotation(String, Annotation, Annotation)	Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase)
SetRuntimeAnnotation(String, Object)	Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase)
ToString()	Returns a string that represents the current object.

Explicit Interface Implementations

IAnnotatable.AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase)
IAnnotatable.FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning null if it does not exist. (Inherited from RuntimeAnnotatableBase)
IAnnotatable.GetRuntimeAnnotations()	Gets all the runtime annotations on the current object. (Inherited from RuntimeAnnotatableBase)
IAnnotatable.RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from RuntimeAnnotatableBase)
IAnnotatable.SetRuntimeAnnotation(String, Object)	Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from RuntimeAnnotatableBase)
IKey.DeclaringEntityType	Gets the entity type the key is defined on. This may be different from the type that Properties are defined on when the key is defined a derived type in an inheritance hierarchy (since the properties may be defined on a base type).
IKey.GetPrincipalKeyValueFactory()	Gets a factory for key values based on the key values taken from various forms of entity data. This method is typically used by database providers (and other extensions). It is generally not used in application code.
IKey.GetPrincipalKeyValueFactory<TKey>()	Gets a factory for key values based on the key values taken from various forms of entity data. This method is typically used by database providers (and other extensions). It is generally not used in application code.
IKey.Properties	Gets the properties that make up the key.
IReadOnlyAnnotatable.FindAnnotation(String)	Gets the annotation with the given name, returning null if it does not exist. (Inherited from RuntimeAnnotatableBase)
IReadOnlyAnnotatable.GetAnnotations()	Gets all annotations on the current object. (Inherited from RuntimeAnnotatableBase)
IReadOnlyAnnotatable.Item[String]	Gets the value of the annotation with the given name, returning null if it does not exist. (Inherited from RuntimeAnnotatableBase)
IReadOnlyKey.DeclaringEntityType	Gets the entity type the key is defined on. This may be different from the type that Properties are defined on when the key is defined a derived type in an inheritance hierarchy (since the properties may be defined on a base type).
IReadOnlyKey.GetReferencingForeignKeys()	Gets all foreign keys that target a given primary or alternate key.
IReadOnlyKey.Properties	Gets the properties that make up the key.
IRuntimeKey.GetIdentityMapFactory()	Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeKey.GetIdentityMapFactory

Extension Methods

FindSharedObjectRootKey(IKey, StoreObjectIdentifier)	Finds the first IConventionKey that is mapped to the same constraint in a shared table-like object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)	Finds the first IKey that is mapped to the same constraint in a shared table-like object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)	Returns the default key constraint name that would be used for this key for a particular table.
GetDefaultName(IReadOnlyKey)	Returns the default key constraint name that would be used for this key.
GetMappedConstraints(IKey)	Gets the unique constraints to which the key is mapped.
GetName(IReadOnlyKey, StoreObjectIdentifier)	Returns the key constraint name for this key for a particular table.
GetName(IReadOnlyKey)	Returns the key constraint name for this key.
GetFluentApiCalls(IKey, IAnnotationCodeGenerator)	Gets the fluent API calls to configure a key.
IsHandledByConvention(IKey)	Gets a value indicating whether the key would be configured by conventions.
GetFillFactor(IReadOnlyKey, StoreObjectIdentifier)	Returns the fill factor that the key uses.
GetFillFactor(IReadOnlyKey)	Returns the fill factor that the key uses.
IsClustered(IReadOnlyKey, StoreObjectIdentifier)	Returns a value indicating whether the key is clustered.
IsClustered(IReadOnlyKey)	Returns a value indicating whether the key is clustered.