IConventionDbFunctionParameter Interface

Definition

Represents a IConventionDbFunction parameter.

public interface IConventionDbFunctionParameter : Microsoft.EntityFrameworkCore.Metadata.IDbFunctionParameter
public interface IConventionDbFunctionParameter : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IDbFunctionParameter
public interface IConventionDbFunctionParameter : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyDbFunctionParameter
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 IDbFunctionParameter
Public Interface IConventionDbFunctionParameter
Implements IConventionAnnotatable, IDbFunctionParameter
Public Interface IConventionDbFunctionParameter
Implements IConventionAnnotatable, IReadOnlyDbFunctionParameter
Implements

Remarks

See Database functions for more information.

Properties

Builder

The IConventionDbFunctionParameterBuilder for configuring this function parameter.

ClrType

Gets the parameter type.

(Inherited from IReadOnlyDbFunctionParameter)
Function

The IConventionDbFunction 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 of the annotation with the given name, returning null if it does not exist.

(Inherited from IReadOnlyAnnotatable)
Name

Gets the parameter name.

(Inherited from IReadOnlyDbFunctionParameter)
PropagatesNullability

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

(Inherited from IReadOnlyDbFunctionParameter)
StoreFunctionParameter

Gets the associated IStoreFunctionParameter.

(Inherited from IDbFunctionParameter)
StoreType

Gets the store type of this parameter.

(Inherited from IReadOnlyDbFunctionParameter)
TypeMapping

Gets the type mapping for this parameter.

(Inherited from IReadOnlyDbFunctionParameter)

Methods

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

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