RuntimeEntityType Class

Definition

Represents an entity type in a model.

public class RuntimeEntityType : Microsoft.EntityFrameworkCore.Infrastructure.AnnotatableBase, Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeEntityType
type RuntimeEntityType = class
    inherit AnnotatableBase
    interface IRuntimeEntityType
    interface IEntityType
    interface IReadOnlyEntityType
    interface IReadOnlyTypeBase
    interface IReadOnlyAnnotatable
    interface ITypeBase
    interface IAnnotatable
Public Class RuntimeEntityType
Inherits AnnotatableBase
Implements IRuntimeEntityType
Inheritance
RuntimeEntityType
Implements
IAnnotatable IReadOnlyAnnotatable IEntityType Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeEntityType IReadOnlyEntityType IReadOnlyTypeBase ITypeBase

Remarks

See Modeling entity types and relationships for more information.

Constructors

RuntimeEntityType(String, Type, Boolean, RuntimeModel, RuntimeEntityType, String, ChangeTrackingStrategy, PropertyInfo, Boolean)

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

ConstructorBinding

Gets or sets the InstantiationBinding for the preferred constructor.

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.

IsReadOnly

Indicates whether the current object is read-only.

Annotations cannot be changed when the object is read-only. Runtime annotations cannot be changed when the object is not read-only.

(Inherited from AnnotatableBase)
Item[String]

Gets the value annotation with the given name, returning null if it does not exist.

(Inherited from AnnotatableBase)
Model

Gets the model that this type belongs to.

Name

Gets the name of this type.

ServiceOnlyConstructorBinding

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, Annotation)

Adds an annotation to this object. Throws if an annotation with the specified name already exists.

(Inherited from AnnotatableBase)
AddAnnotation(String, Object)

Adds an annotation to this object. Throws if an annotation with the specified name already exists.

(Inherited from AnnotatableBase)
AddAnnotations(IEnumerable<IAnnotation>)

Adds annotations to this object.

(Inherited from AnnotatableBase)
AddAnnotations(IReadOnlyDictionary<String,Object>)

Adds annotations to this object.

(Inherited from AnnotatableBase)
AddForeignKey(IReadOnlyList<RuntimeProperty>, RuntimeKey, RuntimeEntityType, DeleteBehavior, Boolean, Boolean, Boolean, Boolean)

Adds a new relationship to this entity type.

AddIndex(IReadOnlyList<RuntimeProperty>, String, Boolean)

Adds an index to this entity type.

AddKey(IReadOnlyList<RuntimeProperty>)

Adds a new alternate key to this entity type.

AddNavigation(String, RuntimeForeignKey, Boolean, Type, PropertyInfo, FieldInfo, PropertyAccessMode, Boolean)

Adds a new navigation property to this entity type.

AddProperty(String, Type, PropertyInfo, FieldInfo, PropertyAccessMode, Boolean, Boolean, ValueGenerated, PropertySaveBehavior, PropertySaveBehavior, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Type, Func<IProperty,IEntityType,ValueGenerator>, ValueConverter, ValueComparer, ValueComparer, CoreTypeMapping)

Adds a property to this entity type.

AddRuntimeAnnotation(String, Annotation)

Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists.

(Inherited from AnnotatableBase)
AddRuntimeAnnotation(String, Object)

Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists.

(Inherited from AnnotatableBase)
AddRuntimeAnnotations(IEnumerable<Annotation>)

Adds runtime annotations to this object.

(Inherited from AnnotatableBase)
AddRuntimeAnnotations(IReadOnlyDictionary<String,Object>)

Adds runtime annotations to this object.

(Inherited from AnnotatableBase)
AddServiceProperty(String, PropertyInfo, FieldInfo, PropertyAccessMode)

Adds a service property to this entity type.

AddSkipNavigation(String, RuntimeEntityType, RuntimeForeignKey, Boolean, Boolean, Type, PropertyInfo, FieldInfo, PropertyAccessMode, Boolean)

Adds a new skip navigation property to this entity type.

CreateAnnotation(String, Object)

Creates a new annotation.

(Inherited from AnnotatableBase)
CreateRuntimeAnnotation(String, Object)

Creates a new runtime annotation.

(Inherited from AnnotatableBase)
EnsureMutable()

Throws if the model is read-only.

(Inherited from AnnotatableBase)
EnsureReadOnly()

Throws if the model is not read-only.

(Inherited from AnnotatableBase)
FindAnnotation(String)

Gets the annotation with the given name, returning null if it does not exist.

(Inherited from AnnotatableBase)
FindDeclaredForeignKeys(IReadOnlyList<IReadOnlyProperty>)

Gets the foreign keys declared on this entity type using the given properties.

FindForeignKey(IReadOnlyList<IReadOnlyProperty>, IReadOnlyKey, IReadOnlyEntityType)

Gets the foreign key for the given properties that points to a given primary or alternate key. Returns null if no foreign key is found.

FindIndex(IReadOnlyList<IReadOnlyProperty>)

Gets the unnamed index defined on the given properties. Returns null if no such index is defined.

Named indexes will not be returned even if the list of properties matches.

FindIndex(String)

Gets the index with the given name. Returns null if no such index exists.

FindIndexerProperty(Type)

Returns the default indexer property that takes a String value if one exists.

FindIndexerPropertyInfo()

Returns the PropertyInfo for the indexer on the associated CLR type if one exists.

FindKey(IReadOnlyList<IReadOnlyProperty>)

Gets the primary or alternate key that is defined on the given properties. Returns null if no key is defined for the given properties.

FindNavigation(String)

Gets a navigation property on the given entity type. Returns null if no navigation property is found.

FindProperties(IEnumerable<String>)

Finds matching properties on the given entity type. Returns null if any property is not found.

This API only finds scalar properties and does not find navigations or service properties.

FindProperty(String)

Gets the property with a given name. Returns null if no property with the given name is defined.

This API only finds scalar properties and does not find navigation properties. Use FindNavigation(String) to find a navigation property.

FindRuntimeAnnotation(String)

Gets the runtime annotation with the given name, returning null if it does not exist.

(Inherited from AnnotatableBase)
FindServiceProperty(String)

Gets the service property with a given name. Returns null if no property with the given name is defined.

This API only finds service properties and does not find scalar or navigation properties.

FindSkipNavigation(String)

Gets a skip navigation property on this entity type. Returns null if no skip navigation property is found.

GetAnnotation(String)

Gets the annotation with the given name, throwing if it does not exist.

(Inherited from AnnotatableBase)
GetAnnotations()

Gets all annotations on the current object.

(Inherited from AnnotatableBase)
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 AnnotatableBase)
GetRuntimeAnnotations()

Gets all runtime annotations on the current object.

(Inherited from AnnotatableBase)
OnAnnotationSet(String, Annotation, Annotation)

Called when an annotation was set or removed.

(Inherited from AnnotatableBase)
RemoveAnnotation(String)

Removes the given annotation from this object.

(Inherited from AnnotatableBase)
RemoveRuntimeAnnotation(String)

Removes the given runtime annotation from this object.

(Inherited from AnnotatableBase)
SetAnnotation(String, Annotation, Annotation)

Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists.

(Inherited from AnnotatableBase)
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 AnnotatableBase)
SetPrimaryKey(RuntimeKey)

Sets the primary key for this entity type.

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 AnnotatableBase)
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 AnnotatableBase)
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 AnnotatableBase)
IAnnotatable.FindRuntimeAnnotation(String)

Gets the runtime annotation with the given name, returning null if it does not exist.

(Inherited from AnnotatableBase)
IAnnotatable.GetRuntimeAnnotations()

Gets all the runtime annotations on the current object.

(Inherited from AnnotatableBase)
IAnnotatable.RemoveRuntimeAnnotation(String)

Removes the given runtime annotation from this object.

(Inherited from AnnotatableBase)
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 AnnotatableBase)
IEntityType.BaseType

Gets the base type of this entity type. Returns null if this is not a derived type in an inheritance hierarchy.

IEntityType.FindDeclaredForeignKeys(IReadOnlyList<IReadOnlyProperty>)

Gets the foreign keys declared on the given IEntityType using the given properties.

IEntityType.FindDeclaredNavigation(String)

Gets a navigation property on the given entity type. Does not return navigation properties defined on a base type. Returns null if no navigation property is found.

IEntityType.FindDeclaredProperty(String)

Finds a property declared on the type with the given name. Does not return properties defined on a base type.

IEntityType.FindForeignKey(IReadOnlyList<IReadOnlyProperty>, IReadOnlyKey, IReadOnlyEntityType)

Gets the foreign key for the given properties that points to a given primary or alternate key. Returns null if no foreign key is found.

IEntityType.FindForeignKeys(IReadOnlyList<IReadOnlyProperty>)

Gets the foreign keys defined on the given properties. Only foreign keys that are defined on exactly the specified set of properties are returned.

IEntityType.FindIndex(IReadOnlyList<IReadOnlyProperty>)

Gets the unnamed index defined on the given properties. Returns null if no such index is defined.

Named indexes will not be returned even if the list of properties matches.

IEntityType.FindIndex(String)

Gets the index with the given name. Returns null if no such index exists.

IEntityType.FindKey(IReadOnlyList<IReadOnlyProperty>)

Gets the primary or alternate key that is defined on the given properties. Returns null if no key is defined for the given properties.

IEntityType.FindPrimaryKey()

Gets primary key for this entity type. Returns null if no primary key is defined.

IEntityType.FindProperty(String)

Gets the property with a given name. Returns null if no property with the given name is defined.

This API only finds scalar properties and does not find navigation properties. Use FindNavigation(String) to find a navigation property.

IEntityType.FindServiceProperty(String)

Gets the service property with a given name. Returns null if no property with the given name is defined.

This API only finds service properties and does not find scalar or navigation properties.

IEntityType.FindSkipNavigation(MemberInfo)

Gets a skip navigation property on this entity type. Returns null if no navigation property is found.

IEntityType.FindSkipNavigation(String)

Gets a skip navigation property on this entity type. Returns null if no skip navigation property is found.

IEntityType.GetDeclaredForeignKeys()

Gets all foreign keys declared on the given IEntityType.

This method does not return foreign keys declared on base types. It is useful when iterating over all entity types to avoid processing the same foreign key more than once. Use GetForeignKeys() to also return foreign keys declared on base types.

IEntityType.GetDeclaredIndexes()

Gets all indexes declared on the given IEntityType.

This method does not return indexes declared on base types. It is useful when iterating over all entity types to avoid processing the same index more than once. Use GetIndexes() to also return indexes declared on base types.

IEntityType.GetDeclaredKeys()

Gets all keys declared on the given IReadOnlyEntityType.

This method does not return keys declared on base types. It is useful when iterating over all entity types to avoid processing the same key more than once. Use GetKeys() to also return keys declared on base types.

IEntityType.GetDeclaredNavigations()

Gets all navigation properties declared on the given IEntityType.

This method does not return navigation properties declared on base types. It is useful when iterating over all entity types to avoid processing the same navigation property more than once. Use GetNavigations() to also return navigation properties declared on base types.

IEntityType.GetDeclaredProperties()

Gets all non-navigation properties declared on the given IEntityType.

This method does not return properties declared on base types. It is useful when iterating over all entity types to avoid processing the same property more than once. Use GetProperties() to also return properties declared on base types.

IEntityType.GetDeclaredReferencingForeignKeys()

Gets all foreign keys that target a given entity type (i.e. foreign keys where the given entity type is the principal).

IEntityType.GetDeclaredServiceProperties()

Gets all service properties declared on the given IEntityType.

This method does not return properties declared on base types. It is useful when iterating over all entity types to avoid processing the same property more than once. Use GetServiceProperties() to also return properties declared on base types.

IEntityType.GetDeclaredSkipNavigations()

Gets all skip navigation properties declared on this entity type.

This method does not return skip navigation properties declared declared on base types. It is useful when iterating over all entity types to avoid processing the same foreign key more than once. Use GetSkipNavigations() to also return skip navigation properties declared on base types.

IEntityType.GetDerivedForeignKeys()

Gets all foreign keys declared on the types derived from the given IEntityType.

IEntityType.GetDerivedIndexes()

Gets all indexes declared on the types derived from the given IEntityType.

IEntityType.GetDerivedSkipNavigations()

Gets all skip navigation properties declared on the types derived from this entity type.

This method does not return skip navigation properties declared on the given entity type itself. Use GetSkipNavigations() to return skip navigation properties declared on this and base entity typed types.

IEntityType.GetDirectlyDerivedTypes()

Gets all types in the model that directly derive from a given entity type.

IEntityType.GetForeignKeyProperties()

Returns the properties contained in foreign keys.

IEntityType.GetForeignKeys()

Gets the foreign keys defined on this entity type.

IEntityType.GetIndexes()

Gets the indexes defined on this entity type.

IEntityType.GetKeys()

Gets the primary and alternate keys for this entity type.

IEntityType.GetNavigations()

Gets all navigation properties on the given entity type.

IEntityType.GetProperties()

Gets the properties defined on this entity type.

This API only returns scalar properties and does not return navigation properties. Use GetNavigations() to get navigation properties.

IEntityType.GetReferencingForeignKeys()

Gets all foreign keys that target a given entity type (i.e. foreign keys where the given entity type or a type it's derived from is the principal).

IEntityType.GetServiceProperties()

Gets all the IServiceProperty defined on this entity type.

This API only returns service properties and does not return scalar or navigation properties.

IEntityType.GetSkipNavigations()

Gets the skip navigation properties on this entity type.

IEntityType.GetValueGeneratingProperties()

Returns the properties that need a value to be generated when the entity entry transitions to the Added state.

IReadOnlyAnnotatable.FindAnnotation(String)

Gets the annotation with the given name, returning null if it does not exist.

(Inherited from AnnotatableBase)
IReadOnlyAnnotatable.GetAnnotations()

Gets all annotations on the current object.

(Inherited from AnnotatableBase)
IReadOnlyAnnotatable.Item[String]

Gets the value of the annotation with the given name, returning null if it does not exist.

(Inherited from AnnotatableBase)
IReadOnlyEntityType.BaseType

Gets the base type of this entity type. Returns null if this is not a derived type in an inheritance hierarchy.

IReadOnlyEntityType.FindDeclaredForeignKeys(IReadOnlyList<IReadOnlyProperty>)

Gets the foreign keys declared on this entity type using the given properties.

IReadOnlyEntityType.FindDeclaredNavigation(String)

Gets a navigation property on the given entity type. Does not return navigation properties defined on a base type. Returns null if no navigation property is found.

IReadOnlyEntityType.FindDeclaredProperty(String)

Finds a property declared on the type with the given name. Does not return properties defined on a base type.

IReadOnlyEntityType.FindDeclaredSkipNavigation(String)

Gets a skip navigation property on this entity type.

Does not return skip navigation properties defined on a base type. Returns null if no skip navigation property is found.

IReadOnlyEntityType.FindForeignKey(IReadOnlyList<IReadOnlyProperty>, IReadOnlyKey, IReadOnlyEntityType)

Gets the foreign key for the given properties that points to a given primary or alternate key. Returns null if no foreign key is found.

IReadOnlyEntityType.FindForeignKeys(IReadOnlyList<IReadOnlyProperty>)

Gets the foreign keys defined on the given properties. Only foreign keys that are defined on exactly the specified set of properties are returned.

IReadOnlyEntityType.FindIndex(IReadOnlyList<IReadOnlyProperty>)

Gets the unnamed index defined on the given properties. Returns null if no such index is defined.

Named indexes will not be returned even if the list of properties matches.

IReadOnlyEntityType.FindIndex(String)

Gets the index with the given name. Returns null if no such index exists.

IReadOnlyEntityType.FindKey(IReadOnlyList<IReadOnlyProperty>)

Gets the primary or alternate key that is defined on the given properties. Returns null if no key is defined for the given properties.

IReadOnlyEntityType.FindPrimaryKey()

Gets primary key for this entity type. Returns null if no primary key is defined.

IReadOnlyEntityType.FindProperties(IReadOnlyList<String>)

Finds matching properties on the given entity type. Returns null if any property is not found.

This API only finds scalar properties and does not find navigation properties.

IReadOnlyEntityType.FindProperty(String)

Gets the property with a given name. Returns null if no property with the given name is defined.

This API only finds scalar properties and does not find navigation properties. Use FindNavigation(String) to find a navigation property.

IReadOnlyEntityType.FindServiceProperty(String)

Gets the service property with a given name. Returns null if no property with the given name is defined.

This API only finds service properties and does not find scalar or navigation properties.

IReadOnlyEntityType.FindSkipNavigation(MemberInfo)

Gets a skip navigation property on this entity type. Returns null if no navigation property is found.

IReadOnlyEntityType.FindSkipNavigation(String)

Gets a skip navigation property on this entity type. Returns null if no skip navigation property is found.

IReadOnlyEntityType.GetChangeTrackingStrategy()

Gets the change tracking strategy being used for this entity type. This strategy indicates how the context detects changes to properties for an instance of the entity type.

IReadOnlyEntityType.GetDeclaredForeignKeys()

Gets all foreign keys declared on this entity type..

This method does not return foreign keys declared on base types. It is useful when iterating over all entity types to avoid processing the same foreign key more than once. Use GetForeignKeys() to also return foreign keys declared on base types.

IReadOnlyEntityType.GetDeclaredIndexes()

Gets all indexes declared on this entity type.

This method does not return indexes declared on base types. It is useful when iterating over all entity types to avoid processing the same index more than once. Use GetForeignKeys() to also return indexes declared on base types.

IReadOnlyEntityType.GetDeclaredKeys()

Gets all keys declared on this entity type.

This method does not return keys declared on base types. It is useful when iterating over all entity types to avoid processing the same key more than once. Use GetKeys() to also return keys declared on base types.

IReadOnlyEntityType.GetDeclaredNavigations()

Gets all navigation properties declared on this entity type.

This method does not return navigation properties declared on base types. It is useful when iterating over all entity types to avoid processing the same navigation property more than once. Use GetNavigations() to also return navigation properties declared on base types.

IReadOnlyEntityType.GetDeclaredProperties()

Gets all non-navigation properties declared on this entity type.

This method does not return properties declared on base types. It is useful when iterating over all entity types to avoid processing the same property more than once. Use GetProperties() to also return properties declared on base types.

IReadOnlyEntityType.GetDeclaredReferencingForeignKeys()

Gets all foreign keys that target a given entity type (i.e. foreign keys where the given entity type is the principal).

IReadOnlyEntityType.GetDeclaredServiceProperties()

Gets all service properties declared on this entity type.

This method does not return properties declared on base types. It is useful when iterating over all entity types to avoid processing the same property more than once. Use GetServiceProperties() to also return properties declared on base types.

IReadOnlyEntityType.GetDeclaredSkipNavigations()

Gets all skip navigation properties declared on this entity type.

This method does not return skip navigation properties declared declared on base types. It is useful when iterating over all entity types to avoid processing the same foreign key more than once. Use GetSkipNavigations() to also return skip navigation properties declared on base types.

IReadOnlyEntityType.GetDerivedForeignKeys()

Gets all foreign keys declared on the types derived from this entity type.

This method does not return foreign keys declared on the given entity type itself. Use GetForeignKeys() to return foreign keys declared on this and base entity typed types.

IReadOnlyEntityType.GetDerivedIndexes()

Gets all indexes declared on the types derived from this entity type.

IReadOnlyEntityType.GetDerivedNavigations()

Gets all navigation properties declared on the types derived from this entity type.

This method does not return navigation properties declared on the given entity type itself. Use GetNavigations() to return navigation properties declared on this and base entity typed types.

IReadOnlyEntityType.GetDerivedProperties()

Gets all non-navigation properties declared on the types derived from this entity type.

This method does not return properties declared on the given entity type itself. Use GetProperties() to return properties declared on this and base entity typed types.

IReadOnlyEntityType.GetDerivedServiceProperties()

Gets all service properties declared on the types derived from this entity type.

This method does not return service properties declared on the given entity type itself. Use GetServiceProperties() to return service properties declared on this and base entity typed types.

IReadOnlyEntityType.GetDerivedSkipNavigations()

Gets all skip navigation properties declared on the types derived from this entity type.

This method does not return skip navigation properties declared on the given entity type itself. Use GetSkipNavigations() to return skip navigation properties declared on this and base entity typed types.

IReadOnlyEntityType.GetDerivedTypes()

Gets all types in the model that derive from a given entity type.

IReadOnlyEntityType.GetDerivedTypesInclusive()

Returns all derived types of this entity type, including the type itself.

IReadOnlyEntityType.GetDirectlyDerivedTypes()

Gets all types in the model that directly derive from a given entity type.

IReadOnlyEntityType.GetDiscriminatorPropertyName()

Returns the name of the property that will be used for storing a discriminator value.

IReadOnlyEntityType.GetForeignKeys()

Gets the foreign keys defined on this entity type.

IReadOnlyEntityType.GetIndexes()

Gets the indexes defined on this entity type.

IReadOnlyEntityType.GetKeys()

Gets the primary and alternate keys for this entity type.

IReadOnlyEntityType.GetNavigations()

Gets all navigation properties on the given entity type.

IReadOnlyEntityType.GetProperties()

Gets the properties defined on this entity type.

This API only returns scalar properties and does not return navigation properties. Use GetNavigations() to get navigation properties.

IReadOnlyEntityType.GetQueryFilter()

Gets the LINQ expression filter automatically applied to queries for this entity type.

IReadOnlyEntityType.GetReferencingForeignKeys()

Gets all foreign keys that target a given entity type (i.e. foreign keys where the given entity type or a base type is the principal).

IReadOnlyEntityType.GetSeedData(Boolean)
IReadOnlyEntityType.GetServiceProperties()

Gets all the IReadOnlyServiceProperty defined on this entity type.

This API only returns service properties and does not return scalar or navigation properties.

IReadOnlyEntityType.GetSkipNavigations()

Gets the skip navigation properties on this entity type.

IReadOnlyTypeBase.ClrType

Gets the CLR class that is used to represent instances of this type. Returns null if the type does not have a corresponding CLR class (known as a shadow type).

Shadow types are not currently supported in a model that is used at runtime with a DbContext. Therefore, shadow types will only exist in migration model snapshots, etc.

IReadOnlyTypeBase.GetNavigationAccessMode()
IReadOnlyTypeBase.GetPropertyAccessMode()
IReadOnlyTypeBase.HasSharedClrType

Gets a value indicating whether this entity type is mapped to a Type that other entity types are also mapped to.

IReadOnlyTypeBase.IsPropertyBag

Gets a value indicating whether this entity type has an indexer which is able to contain arbitrary properties and a method that can be used to determine whether a given indexer property contains a value.

IReadOnlyTypeBase.Model

Gets the model that this type belongs to.

IRuntimeEntityType.Counts Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeEntityType.Counts
IRuntimeEntityType.EmptyShadowValuesFactory Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeEntityType.EmptyShadowValuesFactory
IRuntimeEntityType.GetConstructorBindingConfigurationSource()
IRuntimeEntityType.GetServiceOnlyConstructorBindingConfigurationSource()
IRuntimeEntityType.InstanceFactory Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeEntityType.InstanceFactory
IRuntimeEntityType.OriginalValuesFactory Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeEntityType.OriginalValuesFactory
IRuntimeEntityType.RelationshipSnapshotFactory Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeEntityType.RelationshipSnapshotFactory
IRuntimeEntityType.ShadowValuesFactory Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeEntityType.ShadowValuesFactory
IRuntimeEntityType.StoreGeneratedValuesFactory Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeEntityType.StoreGeneratedValuesFactory
IRuntimeEntityType.TemporaryValuesFactory Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeEntityType.TemporaryValuesFactory
ITypeBase.Model

Gets the model that this type belongs to.

Extension Methods

GetAnalyticalStoreTimeToLive(IReadOnlyEntityType)

Returns the time to live for analytical store in seconds at container scope.

GetContainer(IReadOnlyEntityType)

Returns the name of the container to which the entity type is mapped.

GetContainingPropertyName(IReadOnlyEntityType)

Returns the name of the parent property to which the entity type is mapped.

GetDefaultTimeToLive(IReadOnlyEntityType)

Returns the default time to live in seconds at container scope.

GetETagProperty(IEntityType)

Gets the property on this entity that is mapped to cosmos ETag, if it exists.

GetETagProperty(IReadOnlyEntityType)

Gets the property on this entity that is mapped to cosmos ETag, if it exists.

GetETagPropertyName(IEntityType)

Returns the name of the property that is used to store the etag.

GetETagPropertyName(IReadOnlyEntityType)

Returns the name of the property that is used to store the ETag.

GetPartitionKeyProperty(IEntityType)

Returns the property that is used to store the partition key.

GetPartitionKeyProperty(IReadOnlyEntityType)

Returns the property that is used to store the partition key.

GetPartitionKeyPropertyName(IReadOnlyEntityType)

Returns the name of the property that is used to store the partition key.

GetThroughput(IReadOnlyEntityType)

Returns the provisioned throughput at container scope.

FindDefiningNavigation(IEntityType)
Obsolete.

Returns the defining navigation if one exists or null otherwise.

FullName(ITypeBase)
Obsolete.

Gets the unique name for the given IReadOnlyTypeBase.

GetAllBaseTypes(IEntityType)

Gets all types in the model from which a given entity type derives, starting with the root.

GetAllBaseTypesAscending(IEntityType)

Gets all types in the model from which a given entity type derives, starting with the closest one.

GetClosestCommonParent(IEntityType, IEntityType)
Obsolete.

Returns the closest entity type that is a parent of both given entity types. If one of the given entities is a parent of the other, that parent is returned. Returns null if the two entity types aren't in the same hierarchy.

GetDefiningQuery(IEntityType)
Obsolete.

Gets the LINQ query used as the default source for queries of this type.

GetDiscriminatorProperty(IEntityType)
Obsolete.

Returns the IReadOnlyProperty that will be used for storing a discriminator value.

GetIsDiscriminatorMappingComplete(IEntityType)

Returns the value indicating whether the discriminator mapping is complete for this entity type.

GetNavigations(IEntityType)
Obsolete.

Gets all navigation properties on the given entity type.

GetProperty(IEntityType, String)

Gets a property with the given name.

This API only finds scalar properties and does not find navigation properties. Use FindNavigation(IEntityType, String) to find a navigation property.

HasDefiningNavigation(IEntityType)
Obsolete.

Gets a value indicating whether this entity type has a defining navigation.

IsInOwnershipPath(IEntityType, IEntityType)

Gets a value indicating whether given entity type is in ownership path for this entity type.

ToDebugString(IEntityType, MetadataDebugStringOptions, Int32)

Creates a human-readable representation of the given metadata.

Warning: Do not rely on the format of the returned string. It is designed for debugging only and may change arbitrarily between releases.

AnnotationsToDebugString(IAnnotatable, Int32)

Gets the debug string for all annotations declared on the object.

GetInMemoryQuery(IEntityType)

Gets the LINQ query used as the default source for queries of this type.

GetInMemoryQuery(IReadOnlyEntityType)

Gets the LINQ query used as the default source for queries of this type.

FindCheckConstraint(IEntityType, String)

Finds an ICheckConstraint with the given name.

FindCheckConstraint(IReadOnlyEntityType, String)

Finds an IReadOnlyCheckConstraint with the given name.

FindRowInternalForeignKeys(IEntityType, StoreObjectIdentifier)

Gets the foreign keys for the given entity type that point to other entity types sharing the same table-like store object.

FindRowInternalForeignKeys(IEntityType, StoreObjectIdentifier)

Gets the foreign keys for the given entity type that point to other entity types sharing the same table-like store object.

FindRowInternalForeignKeys(IReadOnlyEntityType, StoreObjectIdentifier)

Gets the foreign keys for the given entity type that point to other entity types sharing the same table-like store object.

GetCheckConstraints(IEntityType)

Returns all check constraints contained in the entity type.

GetCheckConstraints(IReadOnlyEntityType)

Returns all check constraints contained in the entity type.

GetComment(IReadOnlyEntityType)

Returns the comment for the table this entity is mapped to.

GetDeclaredCheckConstraints(IEntityType)

Returns all check constraints declared on the entity type.

This method does not return check constraints declared on base types. It is useful when iterating over all entity types to avoid processing the same check constraint more than once. Use GetCheckConstraints(IEntityType) to also return check constraints declared on base types.

GetDeclaredCheckConstraints(IReadOnlyEntityType)

Returns all check constraints declared on the entity type.

This method does not return check constraints declared on base types. It is useful when iterating over all entity types to avoid processing the same check constraint more than once. Use GetCheckConstraints(IReadOnlyEntityType) to also return check constraints declared on base types.

GetDefaultMappings(IEntityType)

Returns the default mappings that the entity type would use.

GetDefaultSchema(IReadOnlyEntityType)

Returns the default database schema that would be used for this entity type.

GetDefaultSqlQueryName(IEntityType)

Gets the default SQL query name that would be used for this entity type when mapped using RelationalEntityTypeBuilderExtensions.ToSqlQuery.

GetDefaultSqlQueryName(IReadOnlyEntityType)

Gets the default SQL query name that would be used for this entity type when mapped using RelationalEntityTypeBuilderExtensions.ToSqlQuery.

GetDefaultTableName(IEntityType, Boolean)

Returns the default table name that would be used for this entity type.

GetDefaultTableName(IReadOnlyEntityType, Boolean)

Returns the default table name that would be used for this entity type.

GetDefaultViewName(IEntityType)

Returns the default view name that would be used for this entity type.

GetDefaultViewName(IReadOnlyEntityType)

Returns the default view name that would be used for this entity type.

GetDefaultViewSchema(IEntityType)

Returns the default database schema that would be used for this entity view.

GetDefaultViewSchema(IReadOnlyEntityType)

Returns the default database schema that would be used for this entity view.

GetFunctionMappings(IEntityType)

Returns the functions to which the entity type is mapped.

GetFunctionName(IEntityType)

Returns the name of the function to which the entity type is mapped or null if not mapped to a function.

GetFunctionName(IReadOnlyEntityType)

Returns the name of the function to which the entity type is mapped or null if not mapped to a function.

GetSchema(IReadOnlyEntityType)

Returns the database schema that contains the mapped table.

GetSchemaQualifiedTableName(IEntityType)

Returns the name of the table to which the entity type is mapped prepended by the schema or null if not mapped to a table.

GetSchemaQualifiedTableName(IReadOnlyEntityType)

Returns the name of the table to which the entity type is mapped prepended by the schema or null if not mapped to a table.

GetSchemaQualifiedViewName(IEntityType)

Returns the name of the view to which the entity type is mapped prepended by the schema or null if not mapped to a view.

GetSchemaQualifiedViewName(IReadOnlyEntityType)

Returns the name of the view to which the entity type is mapped prepended by the schema or null if not mapped to a view.

GetSqlQuery(IEntityType)

Returns the SQL string used to provide data for the entity type or null if not mapped to a SQL string.

GetSqlQuery(IReadOnlyEntityType)

Returns the SQL string used to provide data for the entity type or null if not mapped to a SQL string.

GetSqlQueryMappings(IEntityType)

Returns the SQL string mappings.

GetTableMappings(IEntityType)

Returns the tables to which the entity type is mapped.

GetTableName(IReadOnlyEntityType)

Returns the name of the table to which the entity type is mapped or null if not mapped to a table.

GetViewMappings(IEntityType)

Returns the views to which the entity type is mapped.

GetViewName(IEntityType)

Returns the name of the view to which the entity type is mapped or null if not mapped to a view.

GetViewName(IReadOnlyEntityType)

Returns the name of the view to which the entity type is mapped or null if not mapped to a view.

GetViewSchema(IEntityType)

Returns the database schema that contains the mapped view.

GetViewSchema(IReadOnlyEntityType)

Returns the database schema that contains the mapped view.

IsTableExcludedFromMigrations(IEntityType)

Gets a value indicating whether the associated table is ignored by Migrations.

IsTableExcludedFromMigrations(IReadOnlyEntityType)

Gets a value indicating whether the associated table is ignored by Migrations.

GetHistoryTableName(IReadOnlyEntityType)

Returns a value representing the name of the history table associated with the entity mapped to a temporal table.

GetHistoryTableSchema(IReadOnlyEntityType)

Returns a value representing the schema of the history table associated with the entity mapped to a temporal table.

GetPeriodEndPropertyName(IReadOnlyEntityType)

Returns a value representing the name of the period end property of the entity mapped to a temporal table.

GetPeriodStartPropertyName(IReadOnlyEntityType)

Returns a value representing the name of the period start property of the entity mapped to a temporal table.

IsMemoryOptimized(IReadOnlyEntityType)

Returns a value indicating whether the entity type is mapped to a memory-optimized table.

IsTemporal(IReadOnlyEntityType)

Returns a value indicating whether the entity type is mapped to a temporal table.

Applies to