Table of Contents

Interface IDbFunction

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

Represents a relational database function in an Microsoft.EntityFrameworkCore.Metadata.IModel.

public interface IDbFunction : IAnnotatable
Extension Methods

Properties

IsAggregate

Gets the value indicating whether this function is an aggregate function.

bool IsAggregate { get; }

Property Value

bool

IsBuiltIn

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

bool IsBuiltIn { get; }

Property Value

bool

IsNullable

Gets the value indicating whether the database function can return null.

bool IsNullable { get; }

Property Value

bool

IsScalar

Gets the value indicating whether this function returns scalar value.

bool IsScalar { get; }

Property Value

bool

MethodInfo

Gets the CLR method which maps to the function in the database.

MethodInfo MethodInfo { get; }

Property Value

MethodInfo

Model

Gets the Microsoft.EntityFrameworkCore.Metadata.IModel in which this function is defined.

IModel Model { get; }

Property Value

IModel

ModelName

Gets the name of the function in the model.

string ModelName { get; }

Property Value

string

Name

Gets the name of the function in the database.

string Name { get; }

Property Value

string

Parameters

Gets the parameters for this function.

IReadOnlyList<IDbFunctionParameter> Parameters { get; }

Property Value

IReadOnlyList<IDbFunctionParameter>

ReturnType

Gets the returned CLR type.

Type ReturnType { get; }

Property Value

Type

Schema

Gets the schema of the function in the database.

string Schema { get; }

Property Value

string

StoreFunction

Gets the associated IStoreFunction.

IStoreFunction StoreFunction { get; }

Property Value

IStoreFunction

StoreType

Gets the configured store type string.

string StoreType { get; }

Property Value

string

Translation

Gets the translation callback for performing custom translation of the method call into a SQL expression fragment.

Func<IReadOnlyCollection<SqlExpression>, SqlExpression> Translation { get; }

Property Value

Func<IReadOnlyCollection<SqlExpression>, SqlExpression>

TypeMapping

Gets the type mapping for the function's return type.

RelationalTypeMapping TypeMapping { get; }

Property Value

RelationalTypeMapping