Interface IReadOnlyStoredProcedure

Namespace

Microsoft.EntityFrameworkCore.Metadata

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

Represents a stored procedure in a model.

public interface IReadOnlyStoredProcedure : IReadOnlyAnnotatable

Properties

EntityType

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

IReadOnlyEntityType EntityType { get; }

Property Value

IReadOnlyEntityType

IsRowsAffectedReturned

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

bool IsRowsAffectedReturned { get; }

Property Value

bool

Name

Gets the name of the stored procedure in the database.

string? Name { get; }

Property Value

string

Parameters

Gets the parameters for this stored procedure.

IReadOnlyList<IReadOnlyStoredProcedureParameter> Parameters { get; }

Property Value

IReadOnlyList<IReadOnlyStoredProcedureParameter>

ResultColumns

Gets the columns of the result for this stored procedure.

IReadOnlyList<IReadOnlyStoredProcedureResultColumn> ResultColumns { get; }

Property Value

IReadOnlyList<IReadOnlyStoredProcedureResultColumn>

Schema

Gets the schema of the stored procedure in the database.

string? Schema { get; }

Property Value

string

Methods

FindOriginalValueParameter(string)

Returns the original value parameter corresponding to the given property.

IReadOnlyStoredProcedureParameter? FindOriginalValueParameter(string propertyName)

Parameters

propertyName string

The name of a property.

Returns

IReadOnlyStoredProcedureParameter

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

FindParameter(string)

Returns the parameter corresponding to the given property.

IReadOnlyStoredProcedureParameter? FindParameter(string propertyName)

Parameters

propertyName string

The name of a property.

Returns

IReadOnlyStoredProcedureParameter

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

FindResultColumn(string)

Returns the result column corresponding to the given property.

IReadOnlyStoredProcedureResultColumn? FindResultColumn(string propertyName)

Parameters

propertyName string

The name of a property.

Returns

IReadOnlyStoredProcedureResultColumn

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

FindRowsAffectedParameter()

Returns the rows affected parameter.

IReadOnlyStoredProcedureParameter? FindRowsAffectedParameter()

Returns

IReadOnlyStoredProcedureParameter

The rows affected parameter if found; true otherwise.

FindRowsAffectedResultColumn()

Returns the rows affected result column.

IReadOnlyStoredProcedureResultColumn? FindRowsAffectedResultColumn()

Returns

IReadOnlyStoredProcedureResultColumn

The rows affected result column if found; true otherwise.

GetSchemaQualifiedName()

Returns the name of the stored procedure prepended by the schema or null if not mapped.

string? GetSchemaQualifiedName()

Returns

string

The name of the stored procedure prepended by the schema.

GetStoreIdentifier()

Returns the store identifier of this stored procedure.

StoreObjectIdentifier? GetStoreIdentifier()

Returns

StoreObjectIdentifier?

The store identifier. null if there is no corresponding store object.

ToDebugString(MetadataDebugStringOptions, int)

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.

string ToDebugString(MetadataDebugStringOptions options = 0, int indent = 0)

Parameters

options MetadataDebugStringOptions

Options for generating the string.

indent int

The number of indent spaces to use before each new line.

Returns

string

A human-readable representation.