RelationalEntityTypeExtensions Class

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore

Assembly:: Microsoft.EntityFrameworkCore.Relational.dll

Package:: Microsoft.EntityFrameworkCore.Relational v3.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v3.1.0

Package:: Microsoft.EntityFrameworkCore.Relational v5.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v6.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v7.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Entity type extension methods for relational database metadata.

public static class RelationalEntityTypeExtensions

type RelationalEntityTypeExtensions = class

Public Module RelationalEntityTypeExtensions

Inheritance: Object
RelationalEntityTypeExtensions

Remarks

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

Fields

DefaultQueryNameBase

Gets the name used for the ISqlQuery mapped using RelationalEntityTypeBuilderExtensions.ToSqlQuery.

Methods

AddCheckConstraint(IConventionEntityType, String, String, Boolean)	Creates a new check constraint with the given name on entity type. Throws an exception if a check constraint with the same name exists on the same entity type.
AddCheckConstraint(IMutableEntityType, String, String)	Creates a new check constraint with the given name on entity type. Throws an exception if a check constraint with the same name exists on the same entity type.
FindCheckConstraint(IConventionEntityType, String)	Finds an IConventionCheckConstraint with the given name.
FindCheckConstraint(IEntityType, String)	Finds an ICheckConstraint with the given name.
FindCheckConstraint(IMutableEntityType, String)	Finds an IMutableCheckConstraint with the given name.
FindCheckConstraint(IReadOnlyEntityType, String)	Finds an IReadOnlyCheckConstraint with the given name.
FindMappingFragment(IConventionEntityType, StoreObjectIdentifier)	Returns the entity type mapping for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindMappingFragment(IEntityType, StoreObjectIdentifier)	Returns the entity type mapping for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindMappingFragment(IMutableEntityType, StoreObjectIdentifier)	Returns the entity type mapping for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindMappingFragment(IReadOnlyEntityType, StoreObjectIdentifier)	Returns the entity type mapping for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
FindRowInternalForeignKeys(IConventionEntityType, 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(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(IMutableEntityType, 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(IConventionEntityType)	Returns all check constraints contained in the entity type.
GetCheckConstraints(IEntityType)	Returns all check constraints contained in the entity type.
GetCheckConstraints(IMutableEntityType)	Returns all check constraints contained in the entity type.
GetCheckConstraints(IReadOnlyEntityType)	Returns all check constraints contained in the entity type.
GetComment(IEntityType)	Returns the comment for the table this entity is mapped to.
GetComment(IReadOnlyEntityType)	Returns the comment for the table this entity is mapped to.
GetCommentConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the table comment.
GetContainerColumnName(IReadOnlyEntityType)	Gets the container column name to which the entity type is mapped.
GetContainerColumnNameConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the container column name.
GetContainerColumnTypeMapping(IReadOnlyEntityType)	Obsolete. Gets the container column type mapping to which the entity type is mapped.
GetContainerColumnTypeMappingConfigurationSource(IConventionEntityType)	Obsolete. Gets the ConfigurationSource for the container column type mapping.
GetDeclaredCheckConstraints(IConventionEntityType)	Returns all check constraints declared on the entity type.
GetDeclaredCheckConstraints(IEntityType)	Returns all check constraints declared on the entity type.
GetDeclaredCheckConstraints(IMutableEntityType)	Returns all check constraints declared on the entity type.
GetDeclaredCheckConstraints(IReadOnlyEntityType)	Returns all check constraints declared on the entity type.
GetDefaultMappings(IEntityType)	Returns the default mappings that the entity type would use.
GetDefaultSchema(IEntityType)	Returns the default database schema that would be used for this entity type.
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)	Returns the default table name that would be used for this entity type.
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.
GetDeleteStoredProcedure(IConventionEntityType)	Returns the stored procedure to which the entity type is mapped for deletes or `null` if not mapped to a stored procedure.
GetDeleteStoredProcedure(IEntityType)	Returns the stored procedure to which the entity type is mapped for deletes or `null` if not mapped to a stored procedure.
GetDeleteStoredProcedure(IMutableEntityType)	Returns the stored procedure to which the entity type is mapped for deletes or `null` if not mapped to a stored procedure.
GetDeleteStoredProcedure(IReadOnlyEntityType)	Returns the stored procedure to which the entity type is mapped for deletes or `null` if not mapped to a stored procedure.
GetDeleteStoredProcedureConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the delete stored procedure.
GetDeleteStoredProcedureMappings(IEntityType)	Returns the delete stored procedures to which the entity type is mapped.
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.
GetFunctionNameConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the function name.
GetInsertStoredProcedure(IConventionEntityType)	Returns the stored procedure to which the entity type is mapped for inserts or `null` if not mapped to a stored procedure.
GetInsertStoredProcedure(IEntityType)	Returns the stored procedure to which the entity type is mapped for inserts or `null` if not mapped to a stored procedure.
GetInsertStoredProcedure(IMutableEntityType)	Returns the stored procedure to which the entity type is mapped for inserts or `null` if not mapped to a stored procedure.
GetInsertStoredProcedure(IReadOnlyEntityType)	Returns the stored procedure to which the entity type is mapped for inserts or `null` if not mapped to a stored procedure.
GetInsertStoredProcedureConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the insert stored procedure.
GetInsertStoredProcedureMappings(IEntityType)	Returns the insert stored procedures to which the entity type is mapped.
GetIsTableExcludedFromMigrationsConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for IsTableExcludedFromMigrations(IReadOnlyEntityType).
GetIsTableExcludedFromMigrationsConfigurationSource(IConventionEntityType, StoreObjectIdentifier)	Gets the ConfigurationSource for IsTableExcludedFromMigrations(IReadOnlyEntityType, StoreObjectIdentifier).
GetJsonPropertyName(IReadOnlyEntityType)	Gets the value of JSON property name used for the given entity mapped to a JSON column.
GetJsonPropertyNameConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the JSON property name for a given entity type.
GetMappingFragments(IConventionEntityType)	Returns all configured entity type mapping fragments. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetMappingFragments(IConventionEntityType, StoreObjectType)	Returns all configured entity type mapping fragments of the given type. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetMappingFragments(IEntityType)	Returns all configured entity type mapping fragments. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetMappingFragments(IEntityType, StoreObjectType)	Returns all configured entity type mapping fragments of the given type. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetMappingFragments(IMutableEntityType)	Returns all configured entity type mapping fragments. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetMappingFragments(IMutableEntityType, StoreObjectType)	Returns all configured entity type mapping fragments of the given type. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetMappingFragments(IReadOnlyEntityType)	Returns all configured entity type mapping fragments. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetMappingFragments(IReadOnlyEntityType, StoreObjectType)	Returns all configured entity type mapping fragments of the given type. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetMappingStrategy(IReadOnlyEntityType)	Gets the mapping strategy for the derived types.
GetMappingStrategyConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for GetMappingStrategy(IReadOnlyEntityType).
GetOrCreateMappingFragment(IConventionEntityType, StoreObjectIdentifier, Boolean)	Returns the entity type mapping for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetOrCreateMappingFragment(IMutableEntityType, StoreObjectIdentifier)	Returns the entity type mapping for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetSchema(IEntityType)	Returns the database schema that contains the mapped table.
GetSchema(IReadOnlyEntityType)	Returns the database schema that contains the mapped table.
GetSchemaConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the database schema.
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.
GetSqlQueryConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the query SQL string.
GetSqlQueryMappings(IEntityType)	Returns the SQL string mappings.
GetTableMappings(IEntityType)	Returns the tables to which the entity type is mapped.
GetTableName(IEntityType)	Returns the name of the table to which the entity type is mapped or `null` if not mapped to a table.
GetTableName(IReadOnlyEntityType)	Returns the name of the table to which the entity type is mapped or `null` if not mapped to a table.
GetTableNameConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the table name.
GetUpdateStoredProcedure(IConventionEntityType)	Returns the stored procedure to which the entity type is mapped for updates or `null` if not mapped to a stored procedure.
GetUpdateStoredProcedure(IEntityType)	Returns the stored procedure to which the entity type is mapped for updates or `null` if not mapped to a stored procedure.
GetUpdateStoredProcedure(IMutableEntityType)	Returns the stored procedure to which the entity type is mapped for updates or `null` if not mapped to a stored procedure.
GetUpdateStoredProcedure(IReadOnlyEntityType)	Returns the stored procedure to which the entity type is mapped for updates or `null` if not mapped to a stored procedure.
GetUpdateStoredProcedureConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the update stored procedure.
GetUpdateStoredProcedureMappings(IEntityType)	Returns the update stored procedures to which the entity type is mapped.
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.
GetViewNameConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the view name.
GetViewSchema(IEntityType)	Returns the database schema that contains the mapped view.
GetViewSchema(IReadOnlyEntityType)	Returns the database schema that contains the mapped view.
GetViewSchemaConfigurationSource(IConventionEntityType)	Gets the ConfigurationSource for the view schema.
IsIgnoredByMigrations(IEntityType)	Gets a value indicating whether the entity type is ignored by Migrations.
IsMappedToJson(IReadOnlyEntityType)	Gets a value indicating whether the specified entity is mapped to a JSON column.
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.
IsTableExcludedFromMigrations(IReadOnlyEntityType, StoreObjectIdentifier)	Gets a value indicating whether the specified table is ignored by Migrations.
RemoveCheckConstraint(IConventionEntityType, String)	Removes the IConventionCheckConstraint with the given name.
RemoveCheckConstraint(IMutableEntityType, String)	Removes the ICheckConstraint with the given name.
RemoveDeleteStoredProcedure(IConventionEntityType)	Removes the mapped delete stored procedure for this entity type.
RemoveDeleteStoredProcedure(IMutableEntityType)	Removes the mapped delete stored procedure for this entity type.
RemoveInsertStoredProcedure(IConventionEntityType)	Removes the mapped insert stored procedure for this entity type.
RemoveInsertStoredProcedure(IMutableEntityType)	Removes the mapped insert stored procedure for this entity type.
RemoveMappingFragment(IConventionEntityType, StoreObjectIdentifier)	Removes the entity type mapping for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
RemoveMappingFragment(IMutableEntityType, StoreObjectIdentifier)	Removes the entity type mapping for a particular table-like store object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
RemoveUpdateStoredProcedure(IConventionEntityType)	Removes the mapped update stored procedure for this entity type.
RemoveUpdateStoredProcedure(IMutableEntityType)	Removes the mapped update stored procedure for this entity type.
SetComment(IConventionEntityType, String, Boolean)	Configures a comment to be applied to the table this entity is mapped to.
SetComment(IMutableEntityType, String)	Configures a comment to be applied to the table this entity is mapped to.
SetContainerColumnName(IConventionEntityType, String, Boolean)	Sets the name of the container column to which the entity type is mapped.
SetContainerColumnName(IMutableEntityType, String)	Sets the name of the container column to which the entity type is mapped.
SetContainerColumnTypeMapping(IConventionEntityType, RelationalTypeMapping, Boolean)	Obsolete. Sets the type mapping for the container column to which the entity type is mapped.
SetContainerColumnTypeMapping(IMutableEntityType, RelationalTypeMapping)	Obsolete. Sets the type mapping for the container column to which the entity type is mapped.
SetDeleteStoredProcedure(IConventionEntityType, Boolean)	Maps the entity type to a stored procedure for deletes.
SetDeleteStoredProcedure(IMutableEntityType)	Maps the entity type to a stored procedure for deletes.
SetFunctionName(IConventionEntityType, String, Boolean)	Sets the name of the function to which the entity type is mapped.
SetFunctionName(IMutableEntityType, String)	Sets the name of the function to which the entity type is mapped.
SetInsertStoredProcedure(IConventionEntityType, Boolean)	Maps the entity type to a stored procedure for inserts.
SetInsertStoredProcedure(IMutableEntityType)	Maps the entity type to a stored procedure for inserts.
SetIsTableExcludedFromMigrations(IConventionEntityType, Nullable<Boolean>, Boolean)	Sets a value indicating whether the associated table is ignored by Migrations.
SetIsTableExcludedFromMigrations(IConventionEntityType, Nullable<Boolean>, StoreObjectIdentifier, Boolean)	Sets a value indicating whether the associated table is ignored by Migrations.
SetIsTableExcludedFromMigrations(IMutableEntityType, Nullable<Boolean>)	Sets a value indicating whether the associated table is ignored by Migrations.
SetIsTableExcludedFromMigrations(IMutableEntityType, Nullable<Boolean>, StoreObjectIdentifier)	Sets a value indicating whether the associated table is ignored by Migrations.
SetJsonPropertyName(IConventionEntityType, String, Boolean)	Sets the value of JSON property name used for the given entity mapped to a JSON column.
SetJsonPropertyName(IMutableEntityType, String)	Sets the value of JSON property name used for the given entity mapped to a JSON column.
SetMappingStrategy(IConventionEntityType, String, Boolean)	Sets the mapping strategy for the derived types.
SetMappingStrategy(IMutableEntityType, String)	Sets the mapping strategy for the derived types.
SetSchema(IConventionEntityType, String, Boolean)	Sets the database schema that contains the mapped table.
SetSchema(IMutableEntityType, String)	Sets the database schema that contains the mapped table.
SetSqlQuery(IConventionEntityType, String, Boolean)	Sets the SQL string used to provide data for the entity type.
SetSqlQuery(IMutableEntityType, String)	Sets the SQL string used to provide data for the entity type.
SetTableName(IConventionEntityType, String, Boolean)	Sets the name of the table to which the entity type is mapped.
SetTableName(IMutableEntityType, String)	Sets the name of the table to which the entity type is mapped.
SetUpdateStoredProcedure(IConventionEntityType, Boolean)	Maps the entity type to a stored procedure for updates.
SetUpdateStoredProcedure(IMutableEntityType)	Maps the entity type to a stored procedure for updates.
SetViewName(IConventionEntityType, String, Boolean)	Sets the name of the view to which the entity type is mapped.
SetViewName(IMutableEntityType, String)	Sets the name of the view to which the entity type is mapped.
SetViewSchema(IConventionEntityType, String, Boolean)	Sets the database schema that contains the mapped view.
SetViewSchema(IMutableEntityType, String)	Sets the database schema that contains the mapped view.

Applies to