IConventionEntityTypeMappingFragment Interface

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Metadata

Assembly:: Microsoft.EntityFrameworkCore.Relational.dll

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.

Represents entity type mapping for a particular table-like store object.

public interface IConventionEntityTypeMappingFragment : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyEntityTypeMappingFragment

type IConventionEntityTypeMappingFragment = interface
    interface IReadOnlyEntityTypeMappingFragment
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionEntityTypeMappingFragment
Implements IConventionAnnotatable, IReadOnlyEntityTypeMappingFragment

Implements: IReadOnlyAnnotatable IConventionAnnotatable IReadOnlyEntityTypeMappingFragment

Remarks

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

Properties

Builder	Gets the builder that can be used to configure this fragment.
EntityType	Gets the entity type for which the fragment is defined.
IsInModel	Indicates whether this object is in a model, i.e. hasn't been removed from one. (Inherited from IConventionAnnotatable)
IsTableExcludedFromMigrations	Gets a value indicating whether the associated table is ignored by Migrations. (Inherited from IReadOnlyEntityTypeMappingFragment)
Item[String]	Gets the value of the annotation with the given name, returning `null` if it does not exist. (Inherited from IReadOnlyAnnotatable)
StoreObject	Gets store object for which the configuration is applied. (Inherited from IReadOnlyEntityTypeMappingFragment)

Methods

AddAnnotation(String, Object, Boolean)	Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Adds annotations to an object. (Inherited from IConventionAnnotatable)
AnnotationsToDebugString(Int32)	Gets the debug string for all annotations declared on the object. (Inherited from IReadOnlyAnnotatable)
FindAnnotation(String)	Gets the annotation with the given name, returning `null` if it does not exist. (Inherited from IConventionAnnotatable)
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist. (Inherited from IConventionAnnotatable)
GetAnnotations()	Gets all annotations on the current object. (Inherited from IConventionAnnotatable)
GetConfigurationSource()	Returns the configuration source for this fragment.
GetIsTableExcludedFromMigrationsConfigurationSource()	Gets the ConfigurationSource for IsTableExcludedFromMigrations.
RemoveAnnotation(String)	Removes the annotation with the given name from this object. (Inherited from IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from IConventionAnnotatable)
SetIsTableExcludedFromMigrations(Nullable<Boolean>, Boolean)	Sets a value indicating whether the associated table is ignored by Migrations.
SetOrRemoveAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. Removes the existing annotation if `null` is supplied. (Inherited from IConventionAnnotatable)
ToDebugString(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. (Inherited from IReadOnlyEntityTypeMappingFragment)

Extension Methods

GetUseSqlReturningClauseConfigurationSource(IConventionEntityTypeMappingFragment)	Gets the configuration source for whether to use the SQL RETURNING clause when saving changes to the associated table.
IsSqlReturningClauseUsed(IReadOnlyEntityTypeMappingFragment)	Returns a value indicating whether to use the SQL RETURNING clause when saving changes to the table. The RETURNING clause is incompatible with certain Sqlite features, such as virtual tables or tables with AFTER triggers.
UseSqlReturningClause(IConventionEntityTypeMappingFragment, Nullable<Boolean>, Boolean)	Sets a value indicating whether to use the SQL RETURNING clause when saving changes to the table. The RETURNING clause is incompatible with certain Sqlite features, such as virtual tables or tables with AFTER triggers.
GetUseSqlOutputClauseConfigurationSource(IConventionEntityTypeMappingFragment)	Gets the configuration source for the setting whether to use the SQL OUTPUT clause when saving changes to the associated table.
IsSqlOutputClauseUsed(IReadOnlyEntityTypeMappingFragment)	Returns a value indicating whether to use the SQL OUTPUT clause when saving changes to the associated table. The OUTPUT clause is incompatible with certain SQL Server features, such as tables with triggers.
UseSqlOutputClause(IConventionEntityTypeMappingFragment, Nullable<Boolean>, Boolean)	Sets whether to use the SQL OUTPUT clause when saving changes to the associated table. The OUTPUT clause is incompatible with certain SQL Server features, such as tables with triggers.

Applies to