IColumn Interface

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v8.0.0

Represents a column in a table.

public interface IColumn : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IColumnBase

type IColumn = interface
    interface IColumnBase
    interface IAnnotatable
    interface IReadOnlyAnnotatable

Public Interface IColumn
Implements IAnnotatable, IColumnBase

Implements

IAnnotatable IColumnBase IReadOnlyAnnotatable

Remarks

See Modeling entity types and relationships for more information and examples.

Properties

Collation	Collation for this column
Comment	Comment for this column
ComputedColumnSql	Returns the SQL expression that is used as the computed value for this column.
DefaultValue	Returns the object that is used as the default value for this column.
DefaultValueSql	Returns the SQL expression that is used as the default value for this column.
IsFixedLength	Returns a flag indicating whether the property is capable of storing only fixed-length data, such as strings.
IsNullable	Gets the value indicating whether the column can contain NULL. (Inherited from IColumnBase)
IsRowVersion	Indicates whether or not this column acts as an automatic concurrency token by generating a different value on every update in the same vein as 'rowversion'/'timestamp' columns on SQL Server.
IsStored	Returns whether the value of the computed column this property is mapped to is stored in the database, or calculated when it is read.
IsUnicode	Gets a value indicating whether or not the property can persist Unicode characters.
Item[String]	Gets the value of the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
MaxLength	Gets the maximum length of data that is allowed in this column. For example, if the property is a String ' then this is the maximum number of characters.
Name	Gets the column name. (Inherited from IColumnBase)
Order	Gets the column order.
Precision	Gets the precision of data that is allowed in this column. For example, if the property is a Decimal ' then this is the maximum number of digits.
PropertyMappings	Gets the property mappings.
ProviderClrType	Gets the provider type. (Inherited from IColumnBase)
ProviderValueComparer	Gets the ValueComparer for this column. (Inherited from IColumnBase)
Scale	Gets the scale of data that is allowed in this column. For example, if the property is a Decimal ' then this is the maximum number of decimal places.
StoreType	Gets the column type. (Inherited from IColumnBase)
StoreTypeMapping	Gets the type mapping for the column-like object. (Inherited from IColumnBase)
Table	Gets the containing table.

Methods

AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from IAnnotatable)
AnnotationsToDebugString(Int32)	Gets the debug string for all annotations declared on the object. (Inherited from IReadOnlyAnnotatable)
FindAnnotation(String)	Gets the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
FindColumnMapping(IReadOnlyEntityType)	Returns the property mapping for the given entity type.
FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning null if it does not exist. (Inherited from IAnnotatable)
FindRuntimeAnnotationValue(String)	Gets the value of the runtime annotation with the given name, returning null if it does not exist. (Inherited from IAnnotatable)
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist. (Inherited from IReadOnlyAnnotatable)
GetAnnotations()	Gets all annotations on the current object. (Inherited from IReadOnlyAnnotatable)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	Gets the value of the runtime annotation with the given name, adding it if one does not exist. (Inherited from IAnnotatable)
GetRuntimeAnnotations()	Gets all the runtime annotations on the current object. (Inherited from IAnnotatable)
RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from IAnnotatable)
SetRuntimeAnnotation(String, Object)	Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from IAnnotatable)
TryGetDefaultValue(Object)	Gets the object that is used as the default value for this column.

Explicit Interface Implementations

IColumnBase.ToDebugString(MetadataDebugStringOptions, Int32)

Creates a human-readable representation of the given metadata. Warning: Do not rely on the format of the returned string. It is designed for debugging only and may change arbitrarily between releases.

Extension Methods