ISqlQueryMapping Interface

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v9.0.0

Source:

ISqlQueryMapping.cs

Represents entity type mapping to a SQL query.

public interface ISqlQueryMapping : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.ITableMappingBase

type ISqlQueryMapping = interface
    interface ITableMappingBase
    interface IAnnotatable
    interface IReadOnlyAnnotatable

Public Interface ISqlQueryMapping
Implements IAnnotatable, ITableMappingBase

Implements

IAnnotatable ITableMappingBase IReadOnlyAnnotatable

Remarks

See Executing raw SQL commands with EF Core for more information and examples.

Properties

ColumnMappings	Gets the properties mapped to columns on the target SQL query.
IncludesDerivedTypes	Gets the value indicating whether the mapped table-like object includes rows for the derived entity types. Set to false for inherited mappings. null if the entity type has no derived types. (Inherited from ITableMappingBase)
IsDefaultSqlQueryMapping	Gets the value indicating whether this is the SQL query mapping that should be used when the entity type is queried.
IsSharedTablePrincipal	Gets the value indicating whether this is the mapping for the principal entity type if the table-like object is shared. null if the table-like object is not shared. (Inherited from ITableMappingBase)
IsSplitEntityTypePrincipal	Gets the value indicating whether this is the mapping for the principal table-like object if the entity type is split. null if the entity type is not split. (Inherited from ITableMappingBase)
Item[String]	Gets the value of the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
SqlQuery	Gets the target SQL query.
Table	Gets the target table-like object. (Inherited from ITableMappingBase)
TypeBase	Gets the mapped type base. (Inherited from ITableMappingBase)

Methods

AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from IAnnotatable)
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 IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning null if it does not exist. (Inherited from IAnnotatable)
FindRuntimeAnnotationValue(String)	Gets the value of the runtime annotation with the given name, returning null if it does not exist. (Inherited from IAnnotatable)
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist. (Inherited from IReadOnlyAnnotatable)
GetAnnotations()	Gets all annotations on the current object. (Inherited from IReadOnlyAnnotatable)
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 IAnnotatable)
GetRuntimeAnnotations()	Gets all the runtime annotations on the current object. (Inherited from IAnnotatable)
RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from 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 IAnnotatable)

Explicit Interface Implementations

ITableMappingBase.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.

Extension Methods