Interface IConventionStoredProcedureParameterBuilder

Namespace

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

Provides a simple API for configuring a IConventionStoredProcedureParameter.

public interface IConventionStoredProcedureParameterBuilder : IConventionAnnotatableBuilder

Remarks

See Model building conventions for more information and examples.

Properties

Metadata

The stored procedure parameter metadata that is being built.

IConventionStoredProcedureParameter Metadata { get; }

Property Value

IConventionStoredProcedureParameter

Methods

CanSetDirection(ParameterDirection, bool)

Returns a value indicating whether the given direction can be configured on the corresponding stored procedure parameter.

bool CanSetDirection(ParameterDirection direction, bool fromDataAnnotation = false)

Parameters

direction ParameterDirection

The direction.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool

true if the given direction can be configured.

CanSetName(string?, bool)

Returns a value indicating whether the given parameter name can be set.

bool CanSetName(string? name, bool fromDataAnnotation = false)

Parameters

name string

The name of the parameter.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

bool

true if the given parameter name can be set.

Remarks

See Modeling entity types and relationships for more information and examples.

HasDirection(ParameterDirection, bool)

Sets the direction of the stored procedure parameter.

IConventionStoredProcedureParameterBuilder? HasDirection(ParameterDirection direction, bool fromDataAnnotation = false)

Parameters

direction ParameterDirection

The direction.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionStoredProcedureParameterBuilder

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

HasName(string, bool)

Configures the parameter name.

IConventionStoredProcedureParameterBuilder? HasName(string name, bool fromDataAnnotation = false)

Parameters

name string

The name of the parameter.

fromDataAnnotation bool

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionStoredProcedureParameterBuilder

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

Remarks

See Modeling entity types and relationships for more information and examples.