IConventionDbFunctionBuilder Interface

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly:: Microsoft.EntityFrameworkCore.Relational.dll

Package:: Microsoft.EntityFrameworkCore.Relational v3.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v3.1.0

Package:: Microsoft.EntityFrameworkCore.Relational v5.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v6.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v7.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a simple API for configuring a IConventionDbFunction.

public interface IConventionDbFunctionBuilder

public interface IConventionDbFunctionBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionAnnotatableBuilder

type IConventionDbFunctionBuilder = interface

type IConventionDbFunctionBuilder = interface
    interface IConventionAnnotatableBuilder

Public Interface IConventionDbFunctionBuilder

Public Interface IConventionDbFunctionBuilder
Implements IConventionAnnotatableBuilder

Derived: Microsoft.EntityFrameworkCore.Metadata.Builders.DbFunctionBuilder

Implements: IConventionAnnotatableBuilder

Remarks

See Model building conventions for more information and examples.

Properties

Metadata	The function being configured.
ModelBuilder	Gets the model builder. (Inherited from IConventionAnnotatableBuilder)

Methods

CanRemoveAnnotation(String, Boolean)	Returns a value indicating whether an annotation with the given name can be removed using this configuration source. (Inherited from IConventionAnnotatableBuilder)
CanSetAnnotation(String, Object, Boolean)	Returns a value indicating whether an annotation with the given name and value can be set from this configuration source. (Inherited from IConventionAnnotatableBuilder)
CanSetIsBuiltIn(Boolean, Boolean)	Returns a value indicating whether the given built-in can be set for the database function.
CanSetIsNullable(Boolean, Boolean)	Returns a value indicating whether the given nullable can be set for the database function.
CanSetName(String, Boolean)	Returns a value indicating whether the given name can be set for the database function.
CanSetSchema(String, Boolean)	Returns a value indicating whether the given schema can be set for the database function.
CanSetStoreType(String, Boolean)	Returns a value indicating whether the given store type can be set for the database function.
CanSetTranslation(Func<IReadOnlyCollection<SqlExpression>,SqlExpression>, Boolean)	Returns a value indicating whether the given translation can be set for the database function.
CanSetTranslation(Func<IReadOnlyList<SqlExpression>,SqlExpression>, Boolean)	Returns a value indicating whether the given translation can be set for the database function.
CanSetTypeMapping(RelationalTypeMapping, Boolean)	Returns a value indicating whether the given return type mapping can be set for the database function.
HasAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists with same or lower ConfigurationSource.
HasName(String, Boolean)	Sets the name of the database function.
HasNoAnnotation(String, Boolean)	Removes the annotation with the given name from this object.
HasNonNullAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists with same or lower ConfigurationSource. Removes the annotation if `null` value is specified.
HasParameter(String, Boolean)	Returns an object that can be used to configure a parameter with the given name.
HasSchema(String, Boolean)	Sets the schema of the database function.
HasStoreType(String, Boolean)	Sets the store type of the function in the database.
HasTranslation(Func<IReadOnlyCollection<SqlExpression>,SqlExpression>, Boolean)	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. See https://go.microsoft.com/fwlink/?linkid=852477 for more information.
HasTranslation(Func<IReadOnlyList<SqlExpression>,SqlExpression>, Boolean)	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.
HasTypeMapping(RelationalTypeMapping, Boolean)	Sets the return type mapping of the database function.
IsBuiltIn(Boolean, Boolean)	Sets the value indicating whether the database function is built-in or not.
IsNullable(Boolean, Boolean)	Sets the value indicating whether the database function can return null value or not.
RemoveAnnotation(String, Boolean)	Obsolete. Removes the annotation with the given name from this object. (Inherited from IConventionAnnotatableBuilder)
SetOrRemoveAnnotation(String, Object, Boolean)	Obsolete. Sets or removes the annotation stored under the given name. (Inherited from IConventionAnnotatableBuilder)

Applies to

Share via