Share via


ColumnModificationParameters Struct

Definition

Parameters for creating a ColumnModification instance.

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

[System.Runtime.CompilerServices.IsReadOnly]
public readonly struct ColumnModificationParameters : IEquatable<Microsoft.EntityFrameworkCore.Update.ColumnModificationParameters>
[<System.Runtime.CompilerServices.IsReadOnly>]
type ColumnModificationParameters = struct
Public Structure ColumnModificationParameters
Implements IEquatable(Of ColumnModificationParameters)
Inheritance
ColumnModificationParameters
Attributes
Implements

Remarks

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

Constructors

ColumnModificationParameters(IColumn, Object, Object, IProperty, RelationalTypeMapping, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<Boolean>)

Creates a new ColumnModificationParameters instance.

ColumnModificationParameters(IUpdateEntry, IProperty, IColumn, Func<String>, RelationalTypeMapping, Boolean, Boolean, Boolean, Boolean, Boolean)

Creates a new ColumnModificationParameters instance.

ColumnModificationParameters(IUpdateEntry, IProperty, IColumnBase, Func<String>, RelationalTypeMapping, Boolean, Boolean, Boolean, Boolean, Boolean)

Creates a new ColumnModificationParameters instance.

ColumnModificationParameters(String, Object, IProperty, String, RelationalTypeMapping, String, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<Boolean>)

Creates a new ColumnModificationParameters instance specific for updating objects mapped to JSON column.

ColumnModificationParameters(String, Object, Object, IProperty, String, RelationalTypeMapping, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<Boolean>)

Creates a new ColumnModificationParameters 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.

GenerateParameterName

A delegate for generating parameter names for the update SQL.

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.

OriginalValue

The original value of the property mapped to column.

Property

The property that maps to the column.

SensitiveLoggingEnabled

Indicates whether potentially sensitive data (e.g. database values) can be logged.

TypeMapping

The relational type mapping for the column.

Value

The current value of the property mapped to column.

Methods

Equals(ColumnModificationParameters)
Equals(Object)
GetHashCode()
ToString()

Operators

Equality(ColumnModificationParameters, ColumnModificationParameters)
Inequality(ColumnModificationParameters, ColumnModificationParameters)

Applies to