Class DbFunctionBuilder

Namespace

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

Provides a simple API for configuring a IMutableDbFunction.

public class DbFunctionBuilder : DbFunctionBuilderBase, IInfrastructure<IConventionDbFunctionBuilder>

Inheritance

object

DbFunctionBuilderBase

DbFunctionBuilder

Implements

IInfrastructure<IConventionDbFunctionBuilder>

Inherited Members

DbFunctionBuilderBase.HasParameter(string)

DbFunctionBuilderBase.Builder

DbFunctionBuilderBase.Metadata

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

DbFunctionBuilder(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.

public DbFunctionBuilder(IMutableDbFunction function)

Parameters

function IMutableDbFunction

Methods

HasAnnotation(string, object?)

Adds or updates an annotation on the database function. If an annotation with the key specified in annotation already exists, its value will be updated.

public virtual DbFunctionBuilder HasAnnotation(string annotation, object? value)

Parameters

annotation string

The key of the annotation to be added or updated.

value object

The value to be stored in the annotation.

Returns

DbFunctionBuilder

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

HasName(string)

Sets the name of the database function.

public virtual DbFunctionBuilder HasName(string name)

Parameters

name string

The name of the function in the database.

Returns

DbFunctionBuilder

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

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 DbFunctionBuilder HasParameter(string name, Action<DbFunctionParameterBuilder> buildAction)

Parameters

name string

The parameter name.

buildAction Action<DbFunctionParameterBuilder>

An action that performs configuration of the parameter.

Returns

DbFunctionBuilder

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 DbFunctionBuilder HasSchema(string? schema)

Parameters

schema string

The schema of the function in the database.

Returns

DbFunctionBuilder

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

Remarks

See Database functions for more information and examples.

HasStoreType(string?)

Sets the return store type of the database function.

public virtual DbFunctionBuilder HasStoreType(string? storeType)

Parameters

storeType string

The return store type of the function in the database.

Returns

DbFunctionBuilder

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

Remarks

See Database functions for more information and examples.

HasTranslation(Func<IReadOnlyList<SqlExpression>, SqlExpression>)

Sets a callback that will be invoked to perform custom translation of this function. The callback takes a collection of expressions corresponding to the parameters passed to the function call. The callback should return an expression representing the desired translation.

public virtual DbFunctionBuilder HasTranslation(Func<IReadOnlyList<SqlExpression>, SqlExpression> translation)

Parameters

translation Func<IReadOnlyList<SqlExpression>, SqlExpression>

The translation to use.

Returns

DbFunctionBuilder

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 DbFunctionBuilder IsBuiltIn(bool builtIn = true)

Parameters

builtIn bool

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

Returns

DbFunctionBuilder

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

Remarks

See Database functions for more information and examples.

IsNullable(bool)

Marks whether the database function can return null value.

public virtual DbFunctionBuilderBase IsNullable(bool nullable = true)

Parameters

nullable bool

The value indicating whether the database function can return null.

Returns

DbFunctionBuilderBase

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

Remarks

See Database functions for more information and examples.