IConventionStoredProcedure Interface

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore.Metadata
Assembly:
Microsoft.EntityFrameworkCore.Relational.dll
Package:
Microsoft.EntityFrameworkCore.Relational v7.0.0
Package:
Microsoft.EntityFrameworkCore.Relational v8.0.0

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

public interface IConventionStoredProcedure : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyStoredProcedure
type IConventionStoredProcedure = interface
    interface IReadOnlyStoredProcedure
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable
Public Interface IConventionStoredProcedure
Implements IConventionAnnotatable, IReadOnlyStoredProcedure
Implements
IReadOnlyAnnotatable IConventionAnnotatable IReadOnlyStoredProcedure

Properties

Builder

Gets the builder that can be used to configure this stored procedure.
EntityType

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

Indicates whether this object is in a model, i.e. hasn't been removed from one.

(Inherited from IConventionAnnotatable)
IsRowsAffectedReturned

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

(Inherited from IReadOnlyStoredProcedure)
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 name of the stored procedure in the database.

(Inherited from IReadOnlyStoredProcedure)
Parameters

Gets the parameters for this stored procedure.
ResultColumns

Gets the columns of the result for this stored procedure.
Schema

Gets the schema of the stored procedure in the database.

(Inherited from IReadOnlyStoredProcedure)

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)
AddOriginalValueParameter(String, Boolean)

Adds a new parameter that will hold the original value of the property with the given name.
AddParameter(String, Boolean)

Adds a new parameter mapped to the property with the given name.
AddResultColumn(String, Boolean)

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

Adds an output parameter that returns the rows affected by this stored procedure.
AddRowsAffectedResultColumn(Boolean)

Adds a new column of the result that contains the rows affected by this stored procedure.
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 IConventionAnnotatable)
FindOriginalValueParameter(String)

Returns the original value parameter corresponding to the given property.
FindParameter(String)

Returns the parameter corresponding to the given property.
FindResultColumn(String)

Returns the result column corresponding to the given property.
FindRowsAffectedParameter()

Returns the rows affected parameter.
FindRowsAffectedResultColumn()

Returns the rows affected result column.
GetAnnotation(String)

Gets the annotation with the given name, throwing if it does not exist.

(Inherited from IConventionAnnotatable)
GetAnnotations()

Gets all annotations on the current object.

(Inherited from IConventionAnnotatable)
GetConfigurationSource()

Gets the configuration source for this stored procedure.
GetNameConfigurationSource()

Gets the configuration source for Name.
GetSchemaConfigurationSource()

Gets the configuration source for Schema.
GetSchemaQualifiedName()

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

(Inherited from IReadOnlyStoredProcedure)
GetStoreIdentifier()

Returns the store identifier of this stored procedure.

(Inherited from IReadOnlyStoredProcedure)
RemoveAnnotation(String)

Removes the annotation with the given name from this object.

(Inherited from IConventionAnnotatable)
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)
SetIsRowsAffectedReturned(Boolean, Boolean)

Configures whether this stored procedure returns the number of rows affected.
SetName(String, Boolean)

Sets the name of the stored procedure in the database.
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)
SetSchema(String, Boolean)

Sets the schema of the stored procedure in the database.
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 IReadOnlyStoredProcedure)

Applies to