Interface IMutableStoredProcedure

Namespace

Microsoft.EntityFrameworkCore.Metadata

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

Represents a stored procedure in a model in the form that can be mutated while the model is being built.

public interface IMutableStoredProcedure : IReadOnlyStoredProcedure, IReadOnlyAnnotatable, IMutableAnnotatable

Inherited Members

IReadOnlyStoredProcedure.GetStoreIdentifier()

IReadOnlyStoredProcedure.GetSchemaQualifiedName()

IReadOnlyStoredProcedure.ToDebugString(MetadataDebugStringOptions, int)

Properties

EntityType

Gets the entity type in which this stored procedure is defined.

IMutableEntityType EntityType { get; }

Property Value

IMutableEntityType

IsRowsAffectedReturned

Gets or sets a value indicating whether this stored procedure returns the number of rows affected.

bool IsRowsAffectedReturned { get; set; }

Property Value

bool

Name

Gets or sets the name of the stored procedure in the database.

string? Name { get; set; }

Property Value

string

Parameters

Gets the parameters for this stored procedure.

IReadOnlyList<IMutableStoredProcedureParameter> Parameters { get; }

Property Value

IReadOnlyList<IMutableStoredProcedureParameter>

ResultColumns

Gets the columns of the result for this stored procedure.

IReadOnlyList<IMutableStoredProcedureResultColumn> ResultColumns { get; }

Property Value

IReadOnlyList<IMutableStoredProcedureResultColumn>

Schema

Gets or sets the schema of the stored procedure in the database.

string? Schema { get; set; }

Property Value

string

Methods

AddOriginalValueParameter(string)

Adds a new parameter that holds the original value of the property with the given name.

IMutableStoredProcedureParameter AddOriginalValueParameter(string propertyName)

Parameters

propertyName string

The name of the corresponding property.

Returns

IMutableStoredProcedureParameter

The added parameter.

AddParameter(string)

Adds a new parameter mapped to the property with the given name.

IMutableStoredProcedureParameter AddParameter(string propertyName)

Parameters

propertyName string

The name of the corresponding property.

Returns

IMutableStoredProcedureParameter

The added parameter.

AddResultColumn(string)

Adds a new column of the result for this stored procedure mapped to the property with the given name

IMutableStoredProcedureResultColumn AddResultColumn(string propertyName)

Parameters

propertyName string

The name of the corresponding property.

Returns

IMutableStoredProcedureResultColumn

The added column.

AddRowsAffectedParameter()

Adds an output parameter that returns the rows affected by this stored procedure.

IMutableStoredProcedureParameter AddRowsAffectedParameter()

Returns

IMutableStoredProcedureParameter

The added parameter.

AddRowsAffectedResultColumn()

Adds a new column of the result that contains the rows affected by this stored procedure.

IMutableStoredProcedureResultColumn AddRowsAffectedResultColumn()

Returns

IMutableStoredProcedureResultColumn

The added column.

FindOriginalValueParameter(string)

Returns the original value parameter corresponding to the given property.

IMutableStoredProcedureParameter? FindOriginalValueParameter(string propertyName)

Parameters

propertyName string

The name of a property.

Returns

IMutableStoredProcedureParameter

The original value parameter corresponding to the given property if found; null otherwise.

FindParameter(string)

Returns the parameter corresponding to the given property.

IMutableStoredProcedureParameter? FindParameter(string propertyName)

Parameters

propertyName string

The name of a property.

Returns

IMutableStoredProcedureParameter

The parameter corresponding to the given property if found; null otherwise.

FindResultColumn(string)

Returns the result column corresponding to the given property.

IMutableStoredProcedureResultColumn? FindResultColumn(string propertyName)

Parameters

propertyName string

The name of a property.

Returns

IMutableStoredProcedureResultColumn

The result column corresponding to the given property if found; null otherwise.

FindRowsAffectedParameter()

Returns the rows affected parameter.

IMutableStoredProcedureParameter? FindRowsAffectedParameter()

Returns

IMutableStoredProcedureParameter

The rows affected parameter if found; null otherwise.

FindRowsAffectedResultColumn()

Returns the rows affected result column.

IMutableStoredProcedureResultColumn? FindRowsAffectedResultColumn()

Returns

IMutableStoredProcedureResultColumn

The rows affected result column if found; null otherwise.