DatabaseColumn Class

Definition

Namespace:

Microsoft.EntityFrameworkCore.Scaffolding.Metadata

Assembly:

Microsoft.EntityFrameworkCore.Relational.dll

Package:

Microsoft.EntityFrameworkCore.Relational v8.0.0

A simple model for a database column used when reverse engineering an existing database.

public class DatabaseColumn : Microsoft.EntityFrameworkCore.Infrastructure.Annotatable

type DatabaseColumn = class
    inherit Annotatable

Public Class DatabaseColumn
Inherits Annotatable

Inheritance

Object

AnnotatableBase

Annotatable

DatabaseColumn

Remarks

See Reverse engineering (scaffolding) an existing database, and EF Core design-time services for more information and examples.

Constructors

DatabaseColumn()

Properties

Collation	The column collation, or null if none is set.
Comment	The column comment, or null if none is set.
ComputedColumnSql	Whether the value of the computed column this property is mapped to is stored in the database, or calculated when it is read.
DefaultValue	The default value for the column, or null if there is no default value or it could not be parsed.
DefaultValueSql	The default constraint for the column, or null if none.
IsNullable	Indicates whether or not this column can contain null values.
IsReadOnly	Indicates whether the current object is read-only. (Inherited from AnnotatableBase)
IsStored	Whether the value of the computed column this property is mapped to is stored in the database, or calculated when it is read.
Item[String]	Gets the value annotation with the given name, returning null if it does not exist. (Inherited from Annotatable)
Name	The column name.
StoreType	The database/store type of the column.
Table	The table that contains this column.
ValueGenerated	Indicates when values will be generated by the database for this column, or null if the database will not generate values.

Methods

AddAnnotation(String, Annotation)	Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from Annotatable)
AddAnnotation(String, Object)	Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from Annotatable)
AddAnnotations(IEnumerable<IAnnotation>)	Adds annotations to this object. (Inherited from AnnotatableBase)
AddAnnotations(IReadOnlyDictionary<String,Object>)	Adds annotations to this object. (Inherited from AnnotatableBase)
AddRuntimeAnnotation(String, Annotation)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase)
AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase)
AddRuntimeAnnotations(IEnumerable<Annotation>)	Adds runtime annotations to this object. (Inherited from AnnotatableBase)
AddRuntimeAnnotations(IReadOnlyDictionary<String,Object>)	Adds runtime annotations to this object. (Inherited from AnnotatableBase)
CreateAnnotation(String, Object)	Creates a new annotation. (Inherited from Annotatable)
CreateRuntimeAnnotation(String, Object)	Creates a new runtime annotation. (Inherited from AnnotatableBase)
EnsureMutable()	Throws if the model is read-only. (Inherited from Annotatable)
EnsureReadOnly()	Throws if the model is not read-only. (Inherited from Annotatable)
FindAnnotation(String)	Gets the annotation with the given name, returning null if it does not exist. (Inherited from Annotatable)
FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning null if it does not exist. (Inherited from AnnotatableBase)
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist. (Inherited from AnnotatableBase)
GetAnnotations()	Gets all annotations on the current object. (Inherited from Annotatable)
GetOrAddAnnotation(String, Object)	Adds an annotation to this object or returns the existing annotation if one with the specified name already exists. (Inherited from Annotatable)
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 AnnotatableBase)
GetRuntimeAnnotations()	Gets all runtime annotations on the current object. (Inherited from AnnotatableBase)
OnAnnotationSet(String, Annotation, Annotation)	Called when an annotation was set or removed. (Inherited from Annotatable)
RemoveAnnotation(String)	Removes the given annotation from this object. (Inherited from Annotatable)
RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from AnnotatableBase)
SetAnnotation(String, Annotation)	Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from Annotatable)
SetAnnotation(String, Annotation, Annotation)	Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from Annotatable)
SetAnnotation(String, Object)	Sets the annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from Annotatable)
SetRuntimeAnnotation(String, Annotation, Annotation)	Sets the runtime annotation stored under the given key. Overwrites the existing annotation if an annotation with the specified name already exists. (Inherited from AnnotatableBase)
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 AnnotatableBase)
ToString()	Returns a string that represents the current object.

Explicit Interface Implementations

IAnnotatable.AddRuntimeAnnotation(String, Object)	Adds a runtime annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from AnnotatableBase)
IAnnotatable.FindRuntimeAnnotation(String)	Gets the runtime annotation with the given name, returning null if it does not exist. (Inherited from AnnotatableBase)
IAnnotatable.GetRuntimeAnnotations()	Gets all the runtime annotations on the current object. (Inherited from AnnotatableBase)
IAnnotatable.RemoveRuntimeAnnotation(String)	Removes the given runtime annotation from this object. (Inherited from AnnotatableBase)
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 AnnotatableBase)
IMutableAnnotatable.AddAnnotation(String, Object)	Adds an annotation to this object. Throws if an annotation with the specified name already exists. (Inherited from Annotatable)
IMutableAnnotatable.RemoveAnnotation(String)	Removes the given annotation from this object. (Inherited from Annotatable)
IMutableAnnotatable.SetOrRemoveAnnotation(String, Object)	Sets the annotation stored under the given name. Overwrites the existing annotation if an annotation with the specified name already exists. Removes the existing annotation if null is supplied. (Inherited from Annotatable)
IReadOnlyAnnotatable.FindAnnotation(String)	Gets the annotation with the given name, returning null if it does not exist. (Inherited from AnnotatableBase)
IReadOnlyAnnotatable.GetAnnotations()	Gets all annotations on the current object. (Inherited from AnnotatableBase)
IReadOnlyAnnotatable.Item[String]	Gets the value of the annotation with the given name, returning null if it does not exist. (Inherited from AnnotatableBase)

Extension Methods