IFunctionMapping Interface

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Metadata

Assembly:: Microsoft.EntityFrameworkCore.Relational.dll

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

Package:: Microsoft.EntityFrameworkCore.Relational v9.0.0

Source:: IFunctionMapping.cs

Source:: IFunctionMapping.cs

Source:: IFunctionMapping.cs

Source:: IFunctionMapping.cs

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 to a function.

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

type IFunctionMapping = interface
    interface ITableMappingBase
    interface IAnnotatable

type IFunctionMapping = interface
    interface ITableMappingBase
    interface IAnnotatable
    interface IReadOnlyAnnotatable

Public Interface IFunctionMapping
Implements IAnnotatable, ITableMappingBase

Implements: IAnnotatable ITableMappingBase IReadOnlyAnnotatable

Remarks

See Database functions for more information and examples.

Properties

ColumnMappings	Gets the properties mapped to columns on the target function.
DbFunction	Gets the target function.
EntityType	Gets the mapped entity type. (Inherited from ITableMappingBase)
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)
IsDefaultFunctionMapping	Gets the value indicating whether this is the function 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)
StoreFunction	Gets the target function.
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)
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.