Class DbFunctionBuilderBase

Namespace

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

Provides a simple API for configuring a IMutableDbFunction.

public abstract class DbFunctionBuilderBase : IInfrastructure<IConventionDbFunctionBuilder>

Inheritance

object

DbFunctionBuilderBase

Implements

IInfrastructure<IConventionDbFunctionBuilder>

Derived

DbFunctionBuilder

OwnedNavigationTableValuedFunctionBuilder

TableValuedFunctionBuilder

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

See Database functions for more information and examples.

Constructors

DbFunctionBuilderBase(IMutableDbFunction)

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.

protected DbFunctionBuilderBase(IMutableDbFunction function)

Parameters

function IMutableDbFunction

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.

protected virtual InternalDbFunctionBuilder Builder { get; }

Property Value

InternalDbFunctionBuilder

Metadata

The function being configured.

public virtual IMutableDbFunction Metadata { get; }

Property Value

IMutableDbFunction

Methods

HasName(string)

Sets the name of the database function.

public virtual DbFunctionBuilderBase HasName(string name)

Parameters

name string

The name of the function in the database.

Returns

DbFunctionBuilderBase

The same builder instance so that multiple configuration calls can be chained.

Remarks

See Database functions for more information and examples.

HasParameter(string)

Returns an object that can be used to configure a parameter with the given name. If no parameter with the given name exists, then a new parameter will be added.

public virtual DbFunctionParameterBuilder HasParameter(string name)

Parameters

name string

The parameter name.

Returns

DbFunctionParameterBuilder

The builder to use for further parameter configuration.

Remarks

See Database functions for more information and examples.

HasParameter(string, Action<DbFunctionParameterBuilder>)

Returns an object that can be used to configure a parameter with the given name. If no parameter with the given name exists, then a new parameter will be added.

public virtual DbFunctionBuilderBase HasParameter(string name, Action<DbFunctionParameterBuilder> buildAction)

Parameters

name string

The parameter name.

buildAction Action<DbFunctionParameterBuilder>

An action that performs configuration of the parameter.

Returns

DbFunctionBuilderBase

The builder to use for further parameter configuration.

Remarks

See Database functions for more information and examples.

HasSchema(string?)

Sets the schema of the database function.

public virtual DbFunctionBuilderBase HasSchema(string? schema)

Parameters

schema string

The schema of the function in the database.

Returns

DbFunctionBuilderBase

The same builder instance so that multiple configuration calls can be chained.

Remarks

See Database functions for more information and examples.

IsBuiltIn(bool)

Marks whether the database function is built-in.

public virtual DbFunctionBuilderBase IsBuiltIn(bool builtIn = true)

Parameters

builtIn bool

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

Returns

DbFunctionBuilderBase

The same builder instance so that multiple configuration calls can be chained.

Remarks

See Database functions for more information and examples.