Delen via


IDbFunction Interface

Definition

Represents a relational database function in a model.

public interface IDbFunction
public interface IDbFunction : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable
public interface IDbFunction : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyDbFunction
type IDbFunction = interface
type IDbFunction = interface
    interface IAnnotatable
type IDbFunction = interface
    interface IReadOnlyDbFunction
    interface IReadOnlyAnnotatable
    interface IAnnotatable
Public Interface IDbFunction
Public Interface IDbFunction
Implements IAnnotatable
Public Interface IDbFunction
Implements IAnnotatable, IReadOnlyDbFunction
Derived
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.

IsBuiltIn

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

IsNullable

Gets the value indicating whether the database function can return null.

IsScalar

Gets the value indicating whether this function returns scalar value.

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.

Model

Gets the model in which this function is defined.

ModelName

Gets the name of the function in the model.

Name

Gets the name of the function in the database.

Parameters

Gets the parameters for this function

ReturnType

Gets the returned CLR type.

Schema

Gets the schema of the function in the database.

StoreFunction

Gets the associated IStoreFunction.

StoreType

Gets the configured store type string.

Translation

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

TypeMapping

Gets the type mapping for the function's return type.

Methods

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)
RemoveRuntimeAnnotation(String)

Removes the given runtime annotation from this object.

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

Applies to