StoredProcedureBuilder<TEntity> Class

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v8.0.0

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

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

type StoredProcedureBuilder<'Entity (requires 'Entity : null)> = class
    inherit StoredProcedureBuilder
    interface IInfrastructure<EntityTypeBuilder<'Entity>>

Public Class StoredProcedureBuilder(Of TEntity)
Inherits StoredProcedureBuilder
Implements IInfrastructure(Of EntityTypeBuilder(Of TEntity))

Type Parameters

TEntity

The entity type being configured.

Inheritance

Object

StoredProcedureBuilder

StoredProcedureBuilder<TEntity>

Implements

IInfrastructure<EntityTypeBuilder<TEntity>>

Constructors

StoredProcedureBuilder<TEntity>(IMutableStoredProcedure, EntityTypeBuilder<TEntity>)

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. (Inherited from StoredProcedureBuilder)

Metadata

The stored procedure being configured. (Inherited from StoredProcedureBuilder)

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. (Inherited from StoredProcedureBuilder)
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. (Inherited from StoredProcedureBuilder)
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)	Configures a new parameter that holds the original value if no parameter mapped to the given property exists.
HasOriginalValueParameter(String, Action<StoredProcedureParameterBuilder>)	Configures a new parameter that holds the original value if no parameter mapped to the given property exists.
HasOriginalValueParameter<TDerivedEntity,TProperty>(Expression<Func<TDerivedEntity,TProperty>>)	Configures a new parameter that holds the original value if no parameter mapped to the given property exists.
HasOriginalValueParameter<TDerivedEntity,TProperty>(Expression<Func<TDerivedEntity,TProperty>>, Action<StoredProcedureParameterBuilder>)	Configures a new parameter that holds the original value if no parameter mapped to the given property exists.
HasOriginalValueParameter<TProperty>(Expression<Func<TEntity,TProperty>>)	Configures a new parameter that holds the original value if no parameter mapped to the given property exists.
HasOriginalValueParameter<TProperty>(Expression<Func<TEntity,TProperty>>, Action<StoredProcedureParameterBuilder>)	Configures a new parameter that holds the original value if no parameter mapped to the given property exists.
HasParameter(String)	Configures a new parameter 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<TDerivedEntity,TProperty>(Expression<Func<TDerivedEntity,TProperty>>)	Configures a new parameter if no parameter mapped to the given property exists.
HasParameter<TDerivedEntity,TProperty>(Expression<Func<TDerivedEntity,TProperty>>, Action<StoredProcedureParameterBuilder>)	Configures a new parameter if no parameter mapped to the given property exists.
HasParameter<TProperty>(Expression<Func<TEntity,TProperty>>)	Configures a new parameter if no parameter mapped to the given property exists.
HasParameter<TProperty>(Expression<Func<TEntity,TProperty>>, Action<StoredProcedureParameterBuilder>)	Configures a new parameter if no parameter mapped to the given property exists.
HasResultColumn(String)	Configures a new column of the result for this stored procedure. This is used for database generated columns.
HasResultColumn(String, Action<StoredProcedureResultColumnBuilder>)	Configures a new column of the result for this stored procedure. This is used for database generated columns.
HasResultColumn<TDerivedEntity,TProperty>(Expression<Func<TDerivedEntity,TProperty>>)	Configures a new column of the result for this stored procedure. This is used for database generated columns.
HasResultColumn<TDerivedEntity,TProperty>(Expression<Func<TDerivedEntity,TProperty>>, Action<StoredProcedureResultColumnBuilder>)	Configures a new column of the result for this stored procedure. This is used for database generated columns.
HasResultColumn<TProperty>(Expression<Func<TEntity,TProperty>>)	Configures a new column of the result for this stored procedure. This is used for database generated columns.
HasResultColumn<TProperty>(Expression<Func<TEntity,TProperty>>, Action<StoredProcedureResultColumnBuilder>)	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<TEntity>>.Instance
IInfrastructure<EntityTypeBuilder>.Instance	(Inherited from StoredProcedureBuilder)
IInfrastructure<IConventionStoredProcedureBuilder>.Instance	Gets the value of the property being hidden. (Inherited from StoredProcedureBuilder)

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.