Class StoredProcedureResultColumnBuilder

Namespace

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly

Microsoft.EntityFrameworkCore.Relational.dll

Provides a simple API for configuring a IStoredProcedure result column.

public class StoredProcedureResultColumnBuilder : IInfrastructure<PropertyBuilder?>

Inheritance

object

StoredProcedureResultColumnBuilder

Implements

IInfrastructure<PropertyBuilder>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Instances of this class are returned from methods when using the Microsoft.EntityFrameworkCore.ModelBuilder API and it is not designed to be directly constructed in your application code.

Constructors

StoredProcedureResultColumnBuilder(InternalStoredProcedureResultColumnBuilder, PropertyBuilder?)

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.

public StoredProcedureResultColumnBuilder(InternalStoredProcedureResultColumnBuilder builder, PropertyBuilder? propertyBuilder)

Parameters

builder InternalStoredProcedureResultColumnBuilder

propertyBuilder PropertyBuilder

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.

protected virtual InternalStoredProcedureResultColumnBuilder Builder { get; }

Property Value

InternalStoredProcedureResultColumnBuilder

Metadata

The stored procedure result column being configured.

public virtual IMutableStoredProcedureResultColumn Metadata { get; }

Property Value

IMutableStoredProcedureResultColumn

Methods

HasAnnotation(string, object?)

Adds or updates an annotation on the property for a specific stored procedure. If an annotation with the key specified in annotation already exists, its value will be updated.

public virtual StoredProcedureResultColumnBuilder HasAnnotation(string annotation, object? value)

Parameters

annotation string

The key of the annotation to be added or updated.

value object

The value to be stored in the annotation.

Returns

StoredProcedureResultColumnBuilder

The same builder instance so that multiple configuration calls can be chained.

HasName(string)

Sets the name of the stored procedure result column.

public virtual StoredProcedureResultColumnBuilder HasName(string name)

Parameters

name string

The store type of the function parameter in the database.

Returns

StoredProcedureResultColumnBuilder

The same builder instance so that further configuration calls can be chained.

Remarks

See Modeling entity types and relationships and Saving data with EF Core for more information and examples.