IConventionDbFunction Interface

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v9.0.0

Source:

IConventionDbFunction.cs

Represents a relational database function in a model in the form that can be mutated while the model is being built.

public interface IConventionDbFunction : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyDbFunction

type IConventionDbFunction = interface
    interface IReadOnlyDbFunction
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionDbFunction
Implements IConventionAnnotatable, IReadOnlyDbFunction

Implements

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyDbFunction

Remarks

See Database functions for more information and examples.

Properties

Builder	Gets the builder that can be used to configure this function.
IsAggregate	Gets the value indicating whether this function is an aggregate function. (Inherited from IReadOnlyDbFunction)
IsBuiltIn	Gets the value indicating whether the database function is built-in. (Inherited from IReadOnlyDbFunction)
IsInModel	Indicates whether this object is in a model, i.e. hasn't been removed from one. (Inherited from IConventionAnnotatable)
IsNullable	Gets the value indicating whether the database function can return null. (Inherited from IReadOnlyDbFunction)
IsScalar	Gets the value indicating whether this function returns scalar value. (Inherited from IReadOnlyDbFunction)
Item[String]	Gets the value of the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
MethodInfo	Gets the CLR method which maps to the function in the database. (Inherited from IReadOnlyDbFunction)
Model	Gets the model in which this function is defined.
ModelName	Gets the name of the function in the model. (Inherited from IReadOnlyDbFunction)
Name	Gets the name of the function in the database. (Inherited from IReadOnlyDbFunction)
Parameters	Gets the parameters for this function
ReturnType	Gets the returned CLR type. (Inherited from IReadOnlyDbFunction)
Schema	Gets the schema of the function in the database. (Inherited from IReadOnlyDbFunction)
StoreType	Gets the configured store type string. (Inherited from IReadOnlyDbFunction)
Translation	Gets the translation callback for performing custom translation of the method call into a SQL expression fragment. (Inherited from IReadOnlyDbFunction)
TypeMapping	Gets the type mapping for the function's return type. (Inherited from IReadOnlyDbFunction)

Methods

AddAnnotation(String, Object, Boolean)	Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Adds annotations to an object. (Inherited from IConventionAnnotatable)
AnnotationsToDebugString(Int32)	Gets the debug string for all annotations declared on the object. (Inherited from IReadOnlyAnnotatable)
FindAnnotation(String)	Gets the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist. (Inherited from IReadOnlyAnnotatable)
GetAnnotations()	Gets all annotations on the current object. (Inherited from IReadOnlyAnnotatable)
GetConfigurationSource()	Gets the configuration source for this function.
GetIsBuiltInConfigurationSource()	Gets the configuration source for IsBuiltIn.
GetIsNullableConfigurationSource()	Gets the configuration source for IsNullable.
GetNameConfigurationSource()	Gets the configuration source for Name.
GetSchemaConfigurationSource()	Gets the configuration source for Schema.
GetStoreTypeConfigurationSource()	Gets the configuration source for StoreType.
GetTranslationConfigurationSource()	Gets the configuration source for Translation.
GetTypeMappingConfigurationSource()	Gets the configuration source for TypeMapping.
RemoveAnnotation(String)	Removes the annotation with the given name from this object. (Inherited from IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from IConventionAnnotatable)
SetIsBuiltIn(Boolean, Boolean)	Sets the value indicating whether the database function is built-in or not.
SetIsNullable(Boolean, Boolean)	Sets the value indicating whether the database function can return null value or not.
SetName(String, Boolean)	Sets the name of the function in the database.
SetOrRemoveAnnotation(String, Object, Boolean)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. Removes the existing annotation if null is supplied. (Inherited from IConventionAnnotatable)
SetSchema(String, Boolean)	Sets the schema of the function in the database.
SetStoreType(String, Boolean)	Sets the store type of the function in the database.
SetTranslation(Func<IReadOnlyList<SqlExpression>,SqlExpression>, Boolean)	Sets the translation callback for performing custom translation of the method call into a SQL expression fragment.
SetTypeMapping(RelationalTypeMapping, Boolean)	Sets the type mapping of the function in the database.
ToDebugString(MetadataDebugStringOptions, Int32)	Creates a human-readable representation of the given metadata. Warning: Do not rely on the format of the returned string. It is designed for debugging only and may change arbitrarily between releases. (Inherited from IReadOnlyDbFunction)

Extension Methods