ColumnModification Class

Definition

Namespace:

Microsoft.EntityFrameworkCore.Update

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v8.0.0

Implementation of IColumnModification interface.

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

public class ColumnModification : Microsoft.EntityFrameworkCore.Update.IColumnModification

type ColumnModification = class
    interface IColumnModification

Public Class ColumnModification
Implements IColumnModification

Inheritance

Object

ColumnModification

Implements

IColumnModification

Remarks

Represents an update, insert, or delete operation for a single column. IReadOnlyModificationCommand contain lists of IColumnModification.

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

Constructors

ColumnModification(ColumnModificationParameters)

Creates a new ColumnModification instance.

Properties

Column	The column.
ColumnName	The name of the column.
ColumnType	The database type of the column.
Entry	The IUpdateEntry that represents the entity that is being modified.
IsCondition	Indicates whether the column is used in the WHERE clause when updating.
IsKey	Indicates whether the column is part of a primary or alternate key.
IsNullable	A value indicating whether the column could contain a null value.
IsRead	Indicates whether a value must be read from the database for the column.
IsWrite	Indicates whether a value must be written to the database for the column.
JsonPath	In case of JSON column modification, the JSON path leading to the JSON element that needs to be updated.
OriginalParameterName	The parameter name to use for the original value parameter (UseOriginalValueParameter), if needed.
OriginalValue	The original value of the property mapped to this column.
ParameterName	The parameter name to use for the current value parameter (UseCurrentValueParameter), if needed.
Property	The property that maps to the column.
TypeMapping	The relational type mapping for the column.
UseCurrentValue	Indicates whether the current value of the property should be used.
UseCurrentValueParameter	Indicates whether the current value of the property must be passed as a parameter to the SQL.
UseOriginalValue	Indicates whether the original value of the property should be used.
UseOriginalValueParameter	Indicates whether the original value of the property must be passed as a parameter to the SQL.
UseParameter	Indicates whether the value of the property must be passed as a parameter to the SQL as opposed to being inlined.
Value	Gets or sets the current value of the property mapped to this column.

Methods

AddSharedColumnModification(IColumnModification)	Adds a modification affecting the same database value.
GetCurrentProviderValue(IUpdateEntry, IProperty)	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.
GetCurrentValue(IUpdateEntry, IProperty)	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.
GetOriginalProviderValue(IUpdateEntry, IProperty)	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.
GetOriginalValue(IUpdateEntry, IProperty)	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.
IsModified(IUpdateEntry, IProperty)	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.
IsStoreGenerated(IUpdateEntry, IProperty)	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.
ResetParameterNames()	Resets parameter names, so they can be regenerated if the command needs to be re-added to a new batch.
SetStoreGeneratedValue(IUpdateEntry, IProperty, Object)	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.