Share via


IMutableDbFunction Interface

Definition

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

public interface IMutableDbFunction : Microsoft.EntityFrameworkCore.Metadata.IDbFunction
public interface IMutableDbFunction : Microsoft.EntityFrameworkCore.Metadata.IDbFunction, Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable
public interface IMutableDbFunction : Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyDbFunction
type IMutableDbFunction = interface
    interface IDbFunction
type IMutableDbFunction = interface
    interface IMutableAnnotatable
    interface IAnnotatable
    interface IDbFunction
type IMutableDbFunction = interface
    interface IReadOnlyDbFunction
    interface IReadOnlyAnnotatable
    interface IMutableAnnotatable
Public Interface IMutableDbFunction
Implements IDbFunction
Public Interface IMutableDbFunction
Implements IDbFunction, IMutableAnnotatable
Public Interface IMutableDbFunction
Implements IMutableAnnotatable, IReadOnlyDbFunction
Implements

Remarks

See Database functions for more information and examples.

Properties

FunctionName

The name of the function in the database.

IsAggregate

Gets the value indicating whether this function is an aggregate function.

(Inherited from IReadOnlyDbFunction)
IsBuiltIn

Gets or sets the value indicating whether the database function is built-in or not.

IsNullable

Gets or sets the value indicating whether the database function can return null value or not.

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 or sets the name of the function in the database.

Parameters

Gets the parameters for this function

ReturnType

Gets the returned CLR type.

(Inherited from IReadOnlyDbFunction)
Schema

Gets or sets the schema of the function in the database.

StoreFunction

Gets the associated IStoreFunction.

(Inherited from IDbFunction)
StoreType

Gets or sets the store type of the function in the database.

Translation

Gets or sets the translation callback for performing custom translation of the method call into a SQL expression fragment.

TypeMapping

Gets or sets the type mapping of the function in the database.

Methods

AddAnnotation(String, Object)

Adds an annotation to this object. Throws if an annotation with the specified name already exists.

(Inherited from IMutableAnnotatable)
AddAnnotations(IEnumerable<IAnnotation>)

Adds annotations to an object.

(Inherited from IMutableAnnotatable)
AddRuntimeAnnotation(String, Object)

Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists.

(Inherited from IAnnotatable)
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)
FindRuntimeAnnotation(String)

Gets the runtime annotation with the given name, returning null if it does not exist.

(Inherited from IAnnotatable)
FindRuntimeAnnotationValue(String)

Gets the value of the runtime annotation with the given name, returning null if it does not exist.

(Inherited from IAnnotatable)
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)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)

Gets the value of the runtime annotation with the given name, adding it if one does not exist.

(Inherited from IAnnotatable)
GetRuntimeAnnotations()

Gets all the runtime annotations on the current object.

(Inherited from IAnnotatable)
RemoveAnnotation(String)

Removes the given annotation from this object.

(Inherited from IMutableAnnotatable)
RemoveRuntimeAnnotation(String)

Removes the given runtime annotation from this object.

(Inherited from IAnnotatable)
SetAnnotation(String, Object)

Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists.

(Inherited from IMutableAnnotatable)
SetOrRemoveAnnotation(String, Object)

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 IMutableAnnotatable)
SetRuntimeAnnotation(String, Object)

Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists.

(Inherited from IAnnotatable)
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

AnnotationsToDebugString(IAnnotatable, Int32)

Gets the debug string for all annotations declared on the object.

GetAnnotation(IAnnotatable, String)

Gets the annotation with the given name, throwing if it does not exist.

ToDebugString(IDbFunction, 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.

AddAnnotations(IMutableAnnotatable, IEnumerable<IAnnotation>)

Adds annotations to an object.

GetAnnotation(IMutableAnnotatable, String)

Gets the annotation with the given name, throwing if it does not exist.

SetOrRemoveAnnotation(IMutableAnnotatable, String, Object)

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.

Applies to