Class DbFunction

Namespace

Microsoft.EntityFrameworkCore.Metadata.Internal

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public class DbFunction : ConventionAnnotatable, IMutableDbFunction, IMutableAnnotatable, IConventionDbFunction, IConventionAnnotatable, IRuntimeDbFunction, IDbFunction, IReadOnlyDbFunction, IReadOnlyAnnotatable, IAnnotatable

Inheritance

object

DbFunction

Implements

IMutableDbFunction

IMutableAnnotatable

IConventionDbFunction

IConventionAnnotatable

IRuntimeDbFunction

IDbFunction

IReadOnlyDbFunction

IReadOnlyAnnotatable

IAnnotatable

Constructors

DbFunction(MethodInfo, IMutableModel, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public DbFunction(MethodInfo methodInfo, IMutableModel model, ConfigurationSource configurationSource)

Parameters

methodInfo MethodInfo

model IMutableModel

configurationSource ConfigurationSource

DbFunction(string, Type, IEnumerable<(string Name, Type Type)>?, IMutableModel, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public DbFunction(string name, Type returnType, IEnumerable<(string Name, Type Type)>? parameters, IMutableModel model, ConfigurationSource configurationSource)

Parameters

name string

returnType Type

parameters IEnumerable<(string Name, Type Type)>

model IMutableModel

configurationSource ConfigurationSource

Properties

Builder

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual InternalDbFunctionBuilder Builder { get; }

Property Value

InternalDbFunctionBuilder

DebugView

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual DebugView DebugView { get; }

Property Value

DebugView

IsAggregate

public virtual bool IsAggregate { get; }

Property Value

bool

IsBuiltIn

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual bool IsBuiltIn { get; set; }

Property Value

bool

IsInModel

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual bool IsInModel { get; }

Property Value

bool

IsNullable

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual bool IsNullable { get; set; }

Property Value

bool

IsReadOnly

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public override bool IsReadOnly { get; }

Property Value

bool

IsScalar

public virtual bool IsScalar { get; }

Property Value

bool

MethodInfo

public virtual MethodInfo? MethodInfo { get; }

Property Value

MethodInfo

Model

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual IMutableModel Model { get; }

Property Value

IMutableModel

ModelName

public virtual string ModelName { get; }

Property Value

string

Name

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual string Name { get; set; }

Property Value

string

Parameters

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual IReadOnlyList<DbFunctionParameter> Parameters { get; }

Property Value

IReadOnlyList<DbFunctionParameter>

ReturnType

public virtual Type ReturnType { get; }

Property Value

Type

Schema

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual string? Schema { get; set; }

Property Value

string

StoreType

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual string? StoreType { get; set; }

Property Value

string

Translation

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual Func<IReadOnlyList<SqlExpression>, SqlExpression>? Translation { get; set; }

Property Value

Func<IReadOnlyList<SqlExpression>, SqlExpression>

TypeMapping

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual RelationalTypeMapping? TypeMapping { get; set; }

Property Value

RelationalTypeMapping

Methods

AddDbFunction(IMutableModel, MethodInfo, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public static DbFunction AddDbFunction(IMutableModel model, MethodInfo methodInfo, ConfigurationSource configurationSource)

Parameters

model IMutableModel

methodInfo MethodInfo

configurationSource ConfigurationSource

Returns

DbFunction

AddDbFunction(IMutableModel, string, Type, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public static DbFunction AddDbFunction(IMutableModel model, string name, Type returnType, ConfigurationSource configurationSource)

Parameters

model IMutableModel

name string

returnType Type

configurationSource ConfigurationSource

Returns

DbFunction

FindDbFunction(IReadOnlyModel, MethodInfo)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public static IReadOnlyDbFunction? FindDbFunction(IReadOnlyModel model, MethodInfo methodInfo)

Parameters

model IReadOnlyModel

methodInfo MethodInfo

Returns

IReadOnlyDbFunction

FindDbFunction(IReadOnlyModel, string)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public static IReadOnlyDbFunction? FindDbFunction(IReadOnlyModel model, string name)

Parameters

model IReadOnlyModel

name string

Returns

IReadOnlyDbFunction

FindParameter(string)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual DbFunctionParameter? FindParameter(string name)

Parameters

name string

Returns

DbFunctionParameter

GetConfigurationSource()

public virtual ConfigurationSource GetConfigurationSource()

Returns

ConfigurationSource

GetDbFunctions(IReadOnlyModel)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public static IEnumerable<IDbFunction> GetDbFunctions(IReadOnlyModel model)

Parameters

model IReadOnlyModel

Returns

IEnumerable<IDbFunction>

GetFunctionName(MethodInfo)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public static string GetFunctionName(MethodInfo methodInfo)

Parameters

methodInfo MethodInfo

Returns

string

GetIsBuiltInConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource? GetIsBuiltInConfigurationSource()

Returns

ConfigurationSource?

GetIsNullableConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource? GetIsNullableConfigurationSource()

Returns

ConfigurationSource?

GetNameConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource? GetNameConfigurationSource()

Returns

ConfigurationSource?

GetSchemaConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource? GetSchemaConfigurationSource()

Returns

ConfigurationSource?

GetStoreTypeConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource? GetStoreTypeConfigurationSource()

Returns

ConfigurationSource?

GetTranslationConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource? GetTranslationConfigurationSource()

Returns

ConfigurationSource?

GetTypeMappingConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource? GetTypeMappingConfigurationSource()

Returns

ConfigurationSource?

RemoveDbFunction(IMutableModel, MethodInfo)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public static DbFunction? RemoveDbFunction(IMutableModel model, MethodInfo methodInfo)

Parameters

model IMutableModel

methodInfo MethodInfo

Returns

DbFunction

RemoveDbFunction(IMutableModel, string)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public static DbFunction? RemoveDbFunction(IMutableModel model, string name)

Parameters

model IMutableModel

name string

Returns

DbFunction

SetIsBuiltIn(bool, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual bool SetIsBuiltIn(bool builtIn, ConfigurationSource configurationSource)

Parameters

builtIn bool

configurationSource ConfigurationSource

Returns

bool

SetIsNullable(bool, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual bool SetIsNullable(bool nullable, ConfigurationSource configurationSource)

Parameters

nullable bool

configurationSource ConfigurationSource

Returns

bool

SetName(string?, ConfigurationSource?)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual string? SetName(string? name, ConfigurationSource? configurationSource)

Parameters

name string

configurationSource ConfigurationSource

Returns

string

SetRemovedFromModel()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual void SetRemovedFromModel()

SetSchema(string?, ConfigurationSource?)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual string? SetSchema(string? schema, ConfigurationSource? configurationSource)

Parameters

schema string

configurationSource ConfigurationSource

Returns

string

SetStoreType(string?, ConfigurationSource?)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual string? SetStoreType(string? storeType, ConfigurationSource? configurationSource)

Parameters

storeType string

configurationSource ConfigurationSource

Returns

string

SetTranslation(Func<IReadOnlyList<SqlExpression>, SqlExpression>?, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual Func<IReadOnlyList<SqlExpression>, SqlExpression>? SetTranslation(Func<IReadOnlyList<SqlExpression>, SqlExpression>? translation, ConfigurationSource configurationSource)

Parameters

translation Func<IReadOnlyList<SqlExpression>, SqlExpression>

configurationSource ConfigurationSource

Returns

Func<IReadOnlyList<SqlExpression>, SqlExpression>

SetTypeMapping(RelationalTypeMapping?, ConfigurationSource?)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual RelationalTypeMapping? SetTypeMapping(RelationalTypeMapping? typeMapping, ConfigurationSource? configurationSource)

Parameters

typeMapping RelationalTypeMapping

configurationSource ConfigurationSource

Returns

RelationalTypeMapping

ToString()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public override string ToString()

Returns

string

UpdateConfigurationSource(ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual void UpdateConfigurationSource(ConfigurationSource configurationSource)

Parameters

configurationSource ConfigurationSource