IStoreFunction 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

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 a function in the database.

public interface IStoreFunction : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.ITableBase

type IStoreFunction = interface
    interface ITableBase
    interface IAnnotatable

type IStoreFunction = interface
    interface ITableBase
    interface IAnnotatable
    interface IReadOnlyAnnotatable

Public Interface IStoreFunction
Implements IAnnotatable, ITableBase

Implements: IAnnotatable ITableBase IReadOnlyAnnotatable

Remarks

See Database functions for more information and examples.

Properties

Columns	Gets the columns defined for the returned row set.
ComplexTypeMappings	Gets the complex type mappings. (Inherited from ITableBase)
DbFunctions	Gets the associated model functions.
EntityTypeMappings	Gets the entity type mappings for the returned row set.
IsBuiltIn	Gets the value indicating whether the database function is built-in.
IsShared	Gets the value indicating whether multiple entity types are sharing the rows in the table. (Inherited from ITableBase)
Item[String]	Gets the value of the annotation with the given name, returning `null` if it does not exist. (Inherited from IReadOnlyAnnotatable)
Model	Gets the database model. (Inherited from ITableBase)
Name	Gets the name of the table in the database. (Inherited from ITableBase)
Parameters	Gets the parameters for this function.
ReturnType	Gets the scalar return type.
Schema	Gets the schema of the table in the database. (Inherited from ITableBase)
SchemaQualifiedName	Gets the schema-qualified name of the table in the database. (Inherited from ITableBase)

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)
FindColumn(IProperty)	Gets the column mapped to the given property. Returns `null` if no column is mapped to the given property.
FindColumn(String)	Gets the column with the given name. Returns `null` if no column with the given name is defined for the returned row set.
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)
GetReferencingRowInternalForeignKeys(IEntityType)	Gets the foreign keys referencing the given entity type from other entity types sharing this table. (Inherited from ITableBase)
GetRowInternalForeignKeys(IEntityType)	Gets the foreign keys for the given entity type that point to other entity types sharing this table. (Inherited from ITableBase)
GetRuntimeAnnotations()	Gets all the runtime annotations on the current object. (Inherited from IAnnotatable)
IsOptional(IEntityType)	Gets the value indicating whether an entity of the given type might not be present in a row. (Inherited from ITableBase)
IsOptional(ITypeBase)	Gets the value indicating whether an entity of the given type might not be present in a row. (Inherited from ITableBase)
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.