Interface IConventionDbFunctionParameterBuilder

Namespace

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

Provides a simple API for configuring a IConventionDbFunctionParameter.

public interface IConventionDbFunctionParameterBuilder : IConventionAnnotatableBuilder

Remarks

See Model building conventions for more information and examples.

Properties

Metadata

The function parameter metadata that is being built.

IConventionDbFunctionParameter Metadata { get; }

Property Value

IConventionDbFunctionParameter

Methods

CanSetStoreType(string?, bool)

Returns a value indicating whether the store type can be set for this property from the current configuration source.

bool CanSetStoreType(string? storeType, bool fromDataAnnotation = false)

Parameters

storeType string

The store type of the function parameter in the database.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool

true if the store type can be set for this property.

CanSetTypeMapping(RelationalTypeMapping?, bool)

Returns a value indicating whether RelationalTypeMapping can be set for this property from the current configuration source.

bool CanSetTypeMapping(RelationalTypeMapping? typeMapping, bool fromDataAnnotation = false)

Parameters

typeMapping RelationalTypeMapping

The type mapping to use for the function parameter.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool

true if the type mapping can be set for this property.

HasStoreType(string?, bool)

Sets the store type of the function parameter in the database.

IConventionDbFunctionParameterBuilder? HasStoreType(string? storeType, bool fromDataAnnotation = false)

Parameters

storeType string

The store type of the function parameter in the database.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionDbFunctionParameterBuilder

The same builder instance if the configuration was applied; null otherwise.

HasTypeMapping(RelationalTypeMapping?, bool)

Sets the RelationalTypeMapping of the function parameter.

IConventionDbFunctionParameterBuilder? HasTypeMapping(RelationalTypeMapping? typeMapping, bool fromDataAnnotation = false)

Parameters

typeMapping RelationalTypeMapping

The type mapping to use for the function parameter.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionDbFunctionParameterBuilder

The same builder instance if the configuration was applied; null otherwise.