IConventionDbFunctionParameter Interface

Definition

Namespace:: Microsoft.EntityFrameworkCore.Metadata

Assembly:: Microsoft.EntityFrameworkCore.Relational.dll

Package:: Microsoft.EntityFrameworkCore.Relational v10.0.0

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

Package:: Microsoft.EntityFrameworkCore.Relational v9.0.0

Source:: IConventionDbFunctionParameter.cs

Source:: IConventionDbFunctionParameter.cs

Source:: IConventionDbFunctionParameter.cs

Source:: IConventionDbFunctionParameter.cs

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 function parameter.

public interface IConventionDbFunctionParameter : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyDbFunctionParameter

public interface IConventionDbFunctionParameter : Microsoft.EntityFrameworkCore.Metadata.IDbFunctionParameter

public interface IConventionDbFunctionParameter : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IDbFunctionParameter

type IConventionDbFunctionParameter = interface
    interface IReadOnlyDbFunctionParameter
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

type IConventionDbFunctionParameter = interface
    interface IDbFunctionParameter

type IConventionDbFunctionParameter = interface
    interface IConventionAnnotatable
    interface IAnnotatable
    interface IDbFunctionParameter

type IConventionDbFunctionParameter = interface
    interface IConventionAnnotatable
    interface IReadOnlyAnnotatable
    interface IReadOnlyDbFunctionParameter

Public Interface IConventionDbFunctionParameter
Implements IConventionAnnotatable, IReadOnlyDbFunctionParameter

Public Interface IConventionDbFunctionParameter
Implements IDbFunctionParameter

Public Interface IConventionDbFunctionParameter
Implements IConventionAnnotatable, IDbFunctionParameter

Implements: IReadOnlyAnnotatable IConventionAnnotatable IReadOnlyDbFunctionParameter IDbFunctionParameter IAnnotatable

Remarks

See Database functions for more information and examples.

Properties

Name	Description
Builder	The IConventionDbFunctionParameterBuilder for configuring this function parameter.
ClrType	Gets the parameter type. (Inherited from IDbFunctionParameter)
Function	The function to which this parameter belongs.
IsInModel	Indicates whether this object is in a model, i.e. hasn't been removed from one. (Inherited from IConventionAnnotatable)
Item[String]	Gets the value annotation with the given name, returning `null` if it does not exist. (Inherited from IAnnotatable)
Name	Gets the parameter name. (Inherited from IDbFunctionParameter)
PropagatesNullability	Gets the value which indicates whether parameter propagates nullability, meaning if it's value is null the database function itself returns null. (Inherited from IDbFunctionParameter)
StoreFunctionParameter	Gets the associated IStoreFunctionParameter. (Inherited from IDbFunctionParameter)
StoreType	Gets the store type of this parameter. (Inherited from IDbFunctionParameter)
TypeMapping	Gets the RelationalTypeMapping for this parameter. (Inherited from IDbFunctionParameter)

Methods

Name	Description
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)
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 IAnnotatable)
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 IConventionAnnotatable)
GetAnnotations()	Gets all annotations on the current object. (Inherited from IAnnotatable)
GetConfigurationSource()	Returns the configuration source for the parameter.
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)
GetStoreTypeConfigurationSource()	Returns the configuration source for StoreType.
GetTypeMappingConfigurationSource()	Returns the configuration source for TypeMapping.
RemoveAnnotation(String)	Removes the annotation with the given name from this object. (Inherited from IConventionAnnotatable)
RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from IAnnotatable)
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)
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)
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)
SetStoreType(String, Boolean)	Sets the store type of the parameter.
SetTypeMapping(RelationalTypeMapping, Boolean)	Sets the type mapping of the parameter.
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 IReadOnlyDbFunctionParameter)

Extension Methods

Name	Description
AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)	Adds annotations to an object.
GetAnnotation(IConventionAnnotatable, String)	Gets the annotation with the given name, throwing if it does not exist.
SetOrRemoveAnnotation(IConventionAnnotatable, 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.
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(IDbFunctionParameter, 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

Feedback

Was this page helpful?