StoredProcedureBuilder Class

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly:: Microsoft.EntityFrameworkCore.Relational.dll

Package:: Microsoft.EntityFrameworkCore.Relational v7.0.0

Package:: Microsoft.EntityFrameworkCore.Relational v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a simple API for configuring a IMutableStoredProcedure that an entity type is mapped to.

public class StoredProcedureBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder>, Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionStoredProcedureBuilder>

type StoredProcedureBuilder = class
    interface IInfrastructure<EntityTypeBuilder>
    interface IInfrastructure<IConventionStoredProcedureBuilder>

Public Class StoredProcedureBuilder
Implements IInfrastructure(Of EntityTypeBuilder), IInfrastructure(Of IConventionStoredProcedureBuilder)

Inheritance: Object
StoredProcedureBuilder

Derived: Microsoft.EntityFrameworkCore.Metadata.Builders.StoredProcedureBuilder<TEntity>

Implements: IInfrastructure<EntityTypeBuilder> IInfrastructure<IConventionStoredProcedureBuilder>

Constructors

StoredProcedureBuilder(IMutableStoredProcedure, EntityTypeBuilder)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

Properties

Builder	This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.
Metadata	The stored procedure being configured.

Methods

CreatePropertyBuilder(String)	This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.
CreatePropertyBuilder<TDerivedEntity,TProperty>(Expression<Func<TDerivedEntity,TProperty>>)	This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.
HasAnnotation(String, Object)	Adds or updates an annotation on the stored procedure. If an annotation with the key specified in `annotation` already exists, its value will be updated.
HasOriginalValueParameter(String, Action<StoredProcedureParameterBuilder>)	Configures a new parameter that holds the original value if no parameter mapped to the given property exists.
HasOriginalValueParameter(String)	Configures a new parameter that holds the original value if no parameter mapped to the given property exists.
HasParameter(String, Action<StoredProcedureParameterBuilder>)	Configures a new parameter if no parameter mapped to the given property exists.
HasParameter(String)	Configures a new parameter if no parameter mapped to the given property exists.
HasResultColumn(String, Action<StoredProcedureResultColumnBuilder>)	Configures a new column of the result for this stored procedure. This is used for database generated columns.
HasResultColumn(String)	Configures a new column of the result for this stored procedure. This is used for database generated columns.
HasRowsAffectedParameter()	Configures a new parameter that returns the rows affected if no such parameter exists.
HasRowsAffectedParameter(Action<StoredProcedureParameterBuilder>)	Configures a new parameter that returns the rows affected if no such parameter exists.
HasRowsAffectedResultColumn()	Configures a new column of the result that returns the rows affected for this stored procedure if no such column exists.
HasRowsAffectedResultColumn(Action<StoredProcedureResultColumnBuilder>)	Configures a new column of the result that returns the rows affected for this stored procedure if no such column exists.
HasRowsAffectedReturnValue(Boolean)	Configures the result of this stored procedure to be the number of rows affected.

Explicit Interface Implementations

IInfrastructure<EntityTypeBuilder>.Instance
IInfrastructure<IConventionStoredProcedureBuilder>.Instance	Gets the value of the property being hidden.

Extension Methods

GetInfrastructure<T>(IInfrastructure<T>)

Gets the value from a property that is being hidden using IInfrastructure<T>.

This method is typically used by database providers (and other extensions). It is generally not used in application code.

Applies to

Share via