RuntimeDbFunction Class
Definition
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.
Represents a relational database function in a model.
public class RuntimeDbFunction : Microsoft.EntityFrameworkCore.Infrastructure.AnnotatableBase, Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeDbFunctiontype RuntimeDbFunction = class
inherit AnnotatableBase
interface IRuntimeDbFunction
interface IDbFunction
interface IReadOnlyDbFunction
interface IReadOnlyAnnotatable
interface IAnnotatablePublic Class RuntimeDbFunction
Inherits AnnotatableBase
Implements IRuntimeDbFunction- Inheritance
- Implements
-
IAnnotatable IReadOnlyAnnotatable IDbFunction Microsoft.EntityFrameworkCore.Metadata.Internal.IRuntimeDbFunction IReadOnlyDbFunction
Remarks
See Database functions for more information and examples.
Constructors
Properties
| DebugView |
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. |
| IsReadOnly |
Indicates whether the current object is read-only. (Inherited from AnnotatableBase) |
| Item[String] |
Gets the value annotation with the given name, returning |
| Model |
Gets the model in which this function is defined. |
| ModelName |
Gets the name of the function in the model. |
| StoreFunction |
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. |
| TypeMapping |
Gets or sets the type mapping for the function's return type. |
Methods
| AddAnnotation(String, Annotation) |
Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| AddAnnotation(String, Object) |
Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| AddAnnotations(IEnumerable<IAnnotation>) |
Adds annotations to this object. (Inherited from AnnotatableBase) |
| AddAnnotations(IReadOnlyDictionary<String,Object>) |
Adds annotations to this object. (Inherited from AnnotatableBase) |
| AddParameter(String, Type, Boolean, String, RelationalTypeMapping) |
Adds a parameter to the function. |
| AddRuntimeAnnotation(String, Annotation) |
Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| AddRuntimeAnnotation(String, Object) |
Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| AddRuntimeAnnotations(IEnumerable<Annotation>) |
Adds runtime annotations to this object. (Inherited from AnnotatableBase) |
| AddRuntimeAnnotations(IReadOnlyDictionary<String,Object>) |
Adds runtime annotations to this object. (Inherited from AnnotatableBase) |
| CreateAnnotation(String, Object) |
Creates a new annotation. (Inherited from AnnotatableBase) |
| CreateRuntimeAnnotation(String, Object) |
Creates a new runtime annotation. (Inherited from AnnotatableBase) |
| EnsureMutable() |
Throws if the model is read-only. (Inherited from AnnotatableBase) |
| EnsureReadOnly() |
Throws if the model is not read-only. (Inherited from AnnotatableBase) |
| FindAnnotation(String) |
Gets the annotation with the given name, returning |
| FindRuntimeAnnotation(String) |
Gets the runtime annotation with the given name, returning |
| GetAnnotation(String) |
Gets the annotation with the given name, throwing if it does not exist. (Inherited from AnnotatableBase) |
| GetAnnotations() |
Gets all annotations on the current object. (Inherited from AnnotatableBase) |
| 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 AnnotatableBase) |
| GetRuntimeAnnotations() |
Gets all runtime annotations on the current object. (Inherited from AnnotatableBase) |
| OnAnnotationSet(String, Annotation, Annotation) |
Called when an annotation was set or removed. (Inherited from AnnotatableBase) |
| RemoveAnnotation(String) |
Removes the given annotation from this object. (Inherited from AnnotatableBase) |
| RemoveRuntimeAnnotation(String) |
Removes the given runtime annotation from this object. (Inherited from AnnotatableBase) |
| SetAnnotation(String, Annotation, Annotation) |
Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| 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 AnnotatableBase) |
| SetRuntimeAnnotation(String, Annotation, Annotation) |
Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| 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 AnnotatableBase) |
| ToString() |
Returns a string that represents the current object. |
Explicit Interface Implementations
| IAnnotatable.AddRuntimeAnnotation(String, Object) |
Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase) |
| IAnnotatable.FindRuntimeAnnotation(String) |
Gets the runtime annotation with the given name, returning |
| IAnnotatable.GetRuntimeAnnotations() |
Gets all the runtime annotations on the current object. (Inherited from AnnotatableBase) |
| IAnnotatable.RemoveRuntimeAnnotation(String) |
Removes the given runtime annotation from this object. (Inherited from AnnotatableBase) |
| 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 AnnotatableBase) |
| IDbFunction.Model |
Gets the model in which this function is defined. |
| IDbFunction.Parameters |
Gets the parameters for this function |
| IDbFunction.StoreFunction |
Gets the associated IStoreFunction. |
| IReadOnlyAnnotatable.FindAnnotation(String) |
Gets the annotation with the given name, returning |
| IReadOnlyAnnotatable.GetAnnotations() |
Gets all annotations on the current object. (Inherited from AnnotatableBase) |
| IReadOnlyAnnotatable.Item[String] |
Gets the value of the annotation with the given name, returning |
| IReadOnlyDbFunction.IsAggregate |
Gets the value indicating whether this function is an aggregate function. |
| IReadOnlyDbFunction.IsBuiltIn |
Gets the value indicating whether the database function is built-in. |
| IReadOnlyDbFunction.IsNullable |
Gets the value indicating whether the database function can return null. |
| IReadOnlyDbFunction.IsScalar |
Gets the value indicating whether this function returns scalar value. |
| IReadOnlyDbFunction.MethodInfo |
Gets the CLR method which maps to the function in the database. |
| IReadOnlyDbFunction.Model |
Gets the model in which this function is defined. |
| IReadOnlyDbFunction.Name |
Gets the name of the function in the database. |
| IReadOnlyDbFunction.Parameters |
Gets the parameters for this function. |
| IReadOnlyDbFunction.ReturnType |
Gets the returned CLR type. |
| IReadOnlyDbFunction.Schema |
Gets the schema of the function in the database. |
| IReadOnlyDbFunction.StoreType |
Gets the configured store type string. |
| IReadOnlyDbFunction.Translation |
Gets the translation callback for performing custom translation of the method call into a SQL expression fragment. |
| IReadOnlyDbFunction.TypeMapping |
Gets the type mapping for the function's return type. |
| IRuntimeDbFunction.StoreFunction | |
Extension Methods
| AnnotationsToDebugString(IAnnotatable, Int32) |
Gets the debug string for all annotations declared on the object. |
Applies to
Entity Framework