Table of Contents

Class StoredProcedure

Namespace
Microsoft.EntityFrameworkCore.Metadata.Internal
Assembly
Microsoft.EntityFrameworkCore.Relational.dll

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 class StoredProcedure : ConventionAnnotatable, IRuntimeStoredProcedure, IStoredProcedure, IAnnotatable, IMutableStoredProcedure, IMutableAnnotatable, IConventionStoredProcedure, IReadOnlyStoredProcedure, IReadOnlyAnnotatable, IConventionAnnotatable
Inheritance
StoredProcedure
Implements
IAnnotatable
IMutableAnnotatable
IReadOnlyAnnotatable
IConventionAnnotatable

Constructors

StoredProcedure(IMutableEntityType, ConfigurationSource)

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 StoredProcedure(IMutableEntityType entityType, ConfigurationSource configurationSource)

Parameters

entityType IMutableEntityType
configurationSource ConfigurationSource

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.

public virtual InternalStoredProcedureBuilder Builder { get; }

Property Value

InternalStoredProcedureBuilder

DebugView

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 virtual DebugView DebugView { get; }

Property Value

DebugView

EntityType 

public virtual IMutableEntityType EntityType { get; set; }

Property Value

IMutableEntityType

IsInModel

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 virtual bool IsInModel { get; }

Property Value

bool

IsReadOnly

Indicates whether the function is read-only.

public override bool IsReadOnly { get; }

Property Value

bool

IsRowsAffectedReturned

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 virtual bool IsRowsAffectedReturned { get; set; }

Property Value

bool

Name 

public virtual string? Name { get; set; }

Property Value

string

Parameters

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 virtual IReadOnlyList<StoredProcedureParameter> Parameters { get; }

Property Value

IReadOnlyList<StoredProcedureParameter>

ResultColumns

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 virtual IReadOnlyList<StoredProcedureResultColumn> ResultColumns { get; }

Property Value

IReadOnlyList<StoredProcedureResultColumn>

Schema 

public virtual string? Schema { get; set; }

Property Value

string

Methods

AddOriginalValueParameter(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.

public virtual StoredProcedureParameter AddOriginalValueParameter(string propertyName)

Parameters

propertyName string

Returns

StoredProcedureParameter

AddParameter(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.

public virtual StoredProcedureParameter AddParameter(string propertyName)

Parameters

propertyName string

Returns

StoredProcedureParameter

AddResultColumn(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.

public virtual StoredProcedureResultColumn AddResultColumn(string propertyName)

Parameters

propertyName string

Returns

StoredProcedureResultColumn

AddRowsAffectedParameter()

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 virtual StoredProcedureParameter AddRowsAffectedParameter()

Returns

StoredProcedureParameter

AddRowsAffectedResultColumn()

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 virtual StoredProcedureResultColumn AddRowsAffectedResultColumn()

Returns

StoredProcedureResultColumn

FindDeclaredStoredProcedure(IReadOnlyEntityType, StoreObjectType)

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 static IStoredProcedure? FindDeclaredStoredProcedure(IReadOnlyEntityType entityType, StoreObjectType sprocType)

Parameters

entityType IReadOnlyEntityType
sprocType StoreObjectType

Returns

IStoredProcedure

FindOriginalValueParameter(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.

public virtual StoredProcedureParameter? FindOriginalValueParameter(string propertyName)

Parameters

propertyName string

Returns

StoredProcedureParameter

FindParameter(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.

public virtual StoredProcedureParameter? FindParameter(string propertyName)

Parameters

propertyName string

Returns

StoredProcedureParameter

FindResultColumn(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.

public virtual StoredProcedureResultColumn? FindResultColumn(string propertyName)

Parameters

propertyName string

Returns

StoredProcedureResultColumn

FindRowsAffectedParameter()

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 virtual StoredProcedureParameter? FindRowsAffectedParameter()

Returns

StoredProcedureParameter

FindRowsAffectedResultColumn()

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 virtual StoredProcedureResultColumn? FindRowsAffectedResultColumn()

Returns

StoredProcedureResultColumn

FindStoredProcedure(IReadOnlyEntityType, StoreObjectType)

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 static IStoredProcedure? FindStoredProcedure(IReadOnlyEntityType entityType, StoreObjectType sprocType)

Parameters

entityType IReadOnlyEntityType
sprocType StoreObjectType

Returns

IStoredProcedure

GetConfigurationSource() 

public virtual ConfigurationSource GetConfigurationSource()

Returns

ConfigurationSource

GetNameConfigurationSource() 

public virtual ConfigurationSource? GetNameConfigurationSource()

Returns

ConfigurationSource?

GetSchemaConfigurationSource()

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 virtual ConfigurationSource? GetSchemaConfigurationSource()

Returns

ConfigurationSource?

GetStoredProcedureConfigurationSource(IConventionEntityType, StoreObjectType)

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 static ConfigurationSource? GetStoredProcedureConfigurationSource(IConventionEntityType entityType, StoreObjectType sprocType)

Parameters

entityType IConventionEntityType
sprocType StoreObjectType

Returns

ConfigurationSource?

RemoveStoredProcedure(IConventionEntityType, StoreObjectType)

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 static IConventionStoredProcedure? RemoveStoredProcedure(IConventionEntityType entityType, StoreObjectType sprocType)

Parameters

entityType IConventionEntityType
sprocType StoreObjectType

Returns

IConventionStoredProcedure

RemoveStoredProcedure(IMutableEntityType, StoreObjectType)

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 static IMutableStoredProcedure? RemoveStoredProcedure(IMutableEntityType entityType, StoreObjectType sprocType)

Parameters

entityType IMutableEntityType
sprocType StoreObjectType

Returns

IMutableStoredProcedure

SetIsRowsAffectedReturned(bool)

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 virtual bool SetIsRowsAffectedReturned(bool rowsAffectedReturned)

Parameters

rowsAffectedReturned bool

Returns

bool

SetName(string?, ConfigurationSource?)

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 virtual string? SetName(string? name, ConfigurationSource? configurationSource)

Parameters

name string
configurationSource ConfigurationSource

Returns

string

SetName(string?, string?, ConfigurationSource?, bool)

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 virtual void SetName(string? name, string? schema, ConfigurationSource? configurationSource, bool skipOverrides = false)

Parameters

name string
schema string
configurationSource ConfigurationSource
skipOverrides bool

SetRemovedFromModel()

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 virtual void SetRemovedFromModel()

SetSchema(string?, ConfigurationSource?)

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 virtual string? SetSchema(string? schema, ConfigurationSource? configurationSource)

Parameters

schema string
configurationSource ConfigurationSource

Returns

string

SetStoredProcedure(IConventionEntityType, StoreObjectType, bool)

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 static StoredProcedure? SetStoredProcedure(IConventionEntityType entityType, StoreObjectType sprocType, bool fromDataAnnotation)

Parameters

entityType IConventionEntityType
sprocType StoreObjectType
fromDataAnnotation bool

Returns

StoredProcedure

SetStoredProcedure(IConventionEntityType, StoreObjectType, string?, string?, bool)

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 static StoredProcedure? SetStoredProcedure(IConventionEntityType entityType, StoreObjectType sprocType, string? name, string? schema, bool fromDataAnnotation)

Parameters

entityType IConventionEntityType
sprocType StoreObjectType
name string
schema string
fromDataAnnotation bool

Returns

StoredProcedure

SetStoredProcedure(IMutableEntityType, StoreObjectType)

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 static StoredProcedure SetStoredProcedure(IMutableEntityType entityType, StoreObjectType sprocType)

Parameters

entityType IMutableEntityType
sprocType StoreObjectType

Returns

StoredProcedure

SetStoredProcedure(IMutableEntityType, StoreObjectType, string?, 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.

public static StoredProcedure SetStoredProcedure(IMutableEntityType entityType, StoreObjectType sprocType, string? name, string? schema)

Parameters

entityType IMutableEntityType
sprocType StoreObjectType
name string
schema string

Returns

StoredProcedure

ToString()

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 override string ToString()

Returns

string

UpdateConfigurationSource(ConfigurationSource)

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 virtual void UpdateConfigurationSource(ConfigurationSource configurationSource)

Parameters

configurationSource ConfigurationSource