Share via


IDbFunctionParameter Interface

Definition

Represents a function parameter.

public interface IDbFunctionParameter
public interface IDbFunctionParameter : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable
public interface IDbFunctionParameter : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyDbFunctionParameter
type IDbFunctionParameter = interface
type IDbFunctionParameter = interface
    interface IAnnotatable
type IDbFunctionParameter = interface
    interface IReadOnlyDbFunctionParameter
    interface IReadOnlyAnnotatable
    interface IAnnotatable
Public Interface IDbFunctionParameter
Public Interface IDbFunctionParameter
Implements IAnnotatable
Public Interface IDbFunctionParameter
Implements IAnnotatable, IReadOnlyDbFunctionParameter
Derived
Implements

Remarks

See Database functions for more information and examples.

Properties

ClrType

Gets the parameter type.

Function

Gets the function to which this parameter belongs.

Item[String]

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

(Inherited from IReadOnlyAnnotatable)
Name

Gets the parameter name.

PropagatesNullability

Gets the value which indicates whether parameter propagates nullability, meaning if it's value is null the database function itself returns null.

StoreFunctionParameter

Gets the associated IStoreFunctionParameter.

StoreType

Gets the store type of this parameter.

TypeMapping

Gets the RelationalTypeMapping for this parameter.

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 IReadOnlyDbFunctionParameter)

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(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