ModificationCommand Class

Definition

Represents a conceptual command to the database to insert/update/delete a row.

This type is typically used by database providers; it is generally not used in application code.

public class ModificationCommand
public class ModificationCommand : Microsoft.EntityFrameworkCore.Update.IModificationCommand
public class ModificationCommand : Microsoft.EntityFrameworkCore.Update.IModificationCommand, Microsoft.EntityFrameworkCore.Update.INonTrackedModificationCommand
type ModificationCommand = class
type ModificationCommand = class
    interface IModificationCommand
    interface IReadOnlyModificationCommand
type ModificationCommand = class
    interface IModificationCommand
    interface IReadOnlyModificationCommand
    interface INonTrackedModificationCommand
Public Class ModificationCommand
Public Class ModificationCommand
Implements IModificationCommand
Public Class ModificationCommand
Implements IModificationCommand, INonTrackedModificationCommand
Inheritance
ModificationCommand
Implements

Remarks

See Implementation of database providers and extensions for more information and examples.

Constructors

ModificationCommand(ModificationCommandParameters)

Initializes a new ModificationCommand instance.

ModificationCommand(NonTrackedModificationCommandParameters)

Initializes a new ModificationCommand instance.

ModificationCommand(String, String, Func<String>, Boolean, IComparer<IUpdateEntry>)

Initializes a new ModificationCommand instance.

ModificationCommand(String, String, Func<String>, Func<IProperty,IRelationalPropertyAnnotations>)
ModificationCommand(String, String, IReadOnlyList<ColumnModification>, Boolean)

Initializes a new ModificationCommand instance.

ModificationCommand(String, String, IReadOnlyList<ColumnModification>)

Initializes a new ModificationCommand instance.

Properties

ColumnModifications

The list of IColumnModification needed to perform the insert, update, or delete.

EntityState

The EntityState that indicates whether the row will be inserted (Added), updated (Modified), or deleted ((Deleted).

Entries

The IUpdateEntrys that represent the entities that are mapped to the row to update.

RequiresResultPropagation

Indicates whether the database will return values for some mapped properties that will then need to be propagated back to the tracked entities.

RowsAffectedColumn

When using a stored procedure, this optionally points to the output parameter or result column containing the rows affected.

Schema

The schema containing the table, or null to use the default schema.

StoreStoredProcedure

The stored procedure to use for updating the data.

Table

The table containing the data to be modified.

TableName

The name of the table containing the data to be modified.

Methods

AddColumnModification(ColumnModificationParameters)

Creates a new IColumnModification and add it to this command.

AddEntry(IUpdateEntry, Boolean)

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.

AddEntry(IUpdateEntry)
Obsolete.

Adds an IUpdateEntry to this command representing an entity to be inserted, updated, or deleted.

AssertColumnsNotInitialized()

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.

CreateColumnModification(ColumnModificationParameters)

Creates a new instance that implements IColumnModification interface.

ProcessSinglePropertyJsonUpdate(ColumnModificationParameters)

Performs processing specifically needed for column modifications that correspond to single-property JSON updates.

PropagateOutputParameters(DbParameterCollection, Int32)

Reads output parameters returned from the database in the given parameterCollection and propagates them back to into the appropriate IColumnModification from which the values can be propagated on to tracked entities.

PropagateResults(RelationalDataReader)

Reads result set columns returned from the database in the given relationalReader and propagates them back to into the appropriate IColumnModification from which the values can be propagated on to tracked entities.

PropagateResults(ValueBuffer)

Reads values returned from the database in the given ValueBuffer and propagates them back to into the appropriate IColumnModification from which the values can be propagated on to tracked entities.

ToString()

Returns a string that represents the current object.

Applies to