Table of Contents

Interface IStoreFunction

Namespace
Microsoft.EntityFrameworkCore.Metadata
Assembly
Microsoft.EntityFrameworkCore.Relational.dll

Represents a function in the database.

public interface IStoreFunction : ITableBase, IAnnotatable, IReadOnlyAnnotatable
Inherited Members

Remarks

See Database functions for more information and examples.

Properties

Columns

Gets the columns defined for the returned row set.

IEnumerable<IFunctionColumn> Columns { get; }

Property Value

IEnumerable<IFunctionColumn>

DbFunctions

Gets the associated model functions.

IEnumerable<IDbFunction> DbFunctions { get; }

Property Value

IEnumerable<IDbFunction>

EntityTypeMappings

Gets the entity type mappings for the returned row set.

IEnumerable<IFunctionMapping> EntityTypeMappings { get; }

Property Value

IEnumerable<IFunctionMapping>

IsBuiltIn

Gets the value indicating whether the database function is built-in.

bool IsBuiltIn { get; }

Property Value

bool

Parameters

Gets the parameters for this function.

IEnumerable<IStoreFunctionParameter> Parameters { get; }

Property Value

IEnumerable<IStoreFunctionParameter>

ReturnType

Gets the scalar return type.

string? ReturnType { get; }

Property Value

string

Methods

FindColumn(IProperty)

Gets the column mapped to the given property. Returns null if no column is mapped to the given property.

IFunctionColumn? FindColumn(IProperty property)

Parameters

property IProperty

Returns

IFunctionColumn

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.

IFunctionColumn? FindColumn(string name)

Parameters

name string

Returns

IFunctionColumn

ToDebugString(MetadataDebugStringOptions, int)

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. 

string ToDebugString(MetadataDebugStringOptions options = 0, int indent = 0)

Parameters

options MetadataDebugStringOptions

Options for generating the string.

indent int

The number of indent spaces to use before each new line.

Returns

string

A human-readable representation.