Share via


AlterTableOperation Class

Definition

A MigrationOperation to alter an existing table.

public class AlterTableOperation : Microsoft.EntityFrameworkCore.Migrations.Operations.MigrationOperation, Microsoft.EntityFrameworkCore.Migrations.Operations.IAlterMigrationOperation
public class AlterTableOperation : Microsoft.EntityFrameworkCore.Migrations.Operations.TableOperation, Microsoft.EntityFrameworkCore.Migrations.Operations.IAlterMigrationOperation
[System.Diagnostics.DebuggerDisplay("ALTER TABLE {Table}")]
public class AlterTableOperation : Microsoft.EntityFrameworkCore.Migrations.Operations.TableOperation, Microsoft.EntityFrameworkCore.Migrations.Operations.IAlterMigrationOperation
[System.Diagnostics.DebuggerDisplay("ALTER TABLE {Name}")]
public class AlterTableOperation : Microsoft.EntityFrameworkCore.Migrations.Operations.TableOperation, Microsoft.EntityFrameworkCore.Migrations.Operations.IAlterMigrationOperation
type AlterTableOperation = class
    inherit MigrationOperation
    interface IAlterMigrationOperation
type AlterTableOperation = class
    inherit TableOperation
    interface IAlterMigrationOperation
[<System.Diagnostics.DebuggerDisplay("ALTER TABLE {Table}")>]
type AlterTableOperation = class
    inherit TableOperation
    interface IAlterMigrationOperation
[<System.Diagnostics.DebuggerDisplay("ALTER TABLE {Name}")>]
type AlterTableOperation = class
    inherit TableOperation
    interface IAlterMigrationOperation
Public Class AlterTableOperation
Inherits MigrationOperation
Implements IAlterMigrationOperation
Public Class AlterTableOperation
Inherits TableOperation
Implements IAlterMigrationOperation
Inheritance
AlterTableOperation
Inheritance
Inheritance
Attributes
Implements

Remarks

See Database migrations for more information and examples.

Constructors

AlterTableOperation()

Properties

Comment

Comment for this table

(Inherited from TableOperation)
IsDestructiveChange

Indicates whether or not the operation might result in loss of data in the database.

(Inherited from MigrationOperation)
IsReadOnly

Indicates whether the current object is read-only.

(Inherited from AnnotatableBase)
Item[String]

Gets the value annotation with the given name, returning null if it does not exist.

(Inherited from Annotatable)
Name

The name of the table.

Name

The name of the table.

(Inherited from TableOperation)
OldTable

An operation representing the table as it was before being altered.

Schema

The schema that contains the table, or null if the default schema should be used.

Schema

The schema that contains the table, or null if the default schema should be used.

(Inherited from TableOperation)

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, 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)

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)

Explicit Interface Implementations

IAlterMigrationOperation.OldAnnotations

The OldTable exposed to examine annotations.

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.FindAnnotation(String)

Gets the annotation with the given name, returning null if it does not exist.

(Inherited from Annotatable)
IAnnotatable.FindRuntimeAnnotation(String)

Gets the runtime annotation with the given name, returning null if it does not exist.

(Inherited from AnnotatableBase)
IAnnotatable.GetAnnotations()

Gets all annotations on the current object.

(Inherited from Annotatable)
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)
ITableMigrationOperation.Table

The table that contains the target of this operation.

(Inherited from TableOperation)

Extension Methods

AnnotationsToDebugString(IAnnotatable, Int32)

Gets the debug string for all annotations declared on the object.

GetAnnotation(IAnnotatable, String)

Gets the annotation with the given name, throwing if it does not exist.

AddAnnotations(IMutableAnnotatable, IEnumerable<IAnnotation>)

Adds annotations to an object.

GetAnnotation(IMutableAnnotatable, String)

Gets the annotation with the given name, throwing if it does not exist.

GetOrAddAnnotation(IMutableAnnotatable, String, String)

Gets the existing annotation with a given key, or adds a new annotation if one does not exist.

SetOrRemoveAnnotation(IMutableAnnotatable, 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.

Applies to