DeleteBehavior Enum

  • Reference

Definition

Namespace:
Microsoft.EntityFrameworkCore
Assembly:
Microsoft.EntityFrameworkCore.dll
Assembly:
Microsoft.EntityFrameworkCore.Abstractions.dll
Package:
Microsoft.EntityFrameworkCore v2.0.3
Package:
Microsoft.EntityFrameworkCore v2.1.11
Package:
Microsoft.EntityFrameworkCore v2.2.6
Package:
Microsoft.EntityFrameworkCore v3.0.0
Package:
Microsoft.EntityFrameworkCore v3.1.0
Package:
Microsoft.EntityFrameworkCore v5.0.0
Package:
Microsoft.EntityFrameworkCore v6.0.0
Package:
Microsoft.EntityFrameworkCore.Abstractions v7.0.0
Package:
Microsoft.EntityFrameworkCore.Abstractions v8.0.0

Indicates how a delete operation is applied to dependent entities in a relationship when the principal is deleted or the relationship is severed.

public enum DeleteBehavior
type DeleteBehavior = 
Public Enum DeleteBehavior
Inheritance
Enum
DeleteBehavior

Fields

Name Value Description
ClientSetNull 0

Sets foreign key values to null as appropriate when changes are made to tracked entities, and creates a non-cascading foreign key constraint in the database. This is the default for optional relationships.
Restrict 1

Sets foreign key values to null as appropriate when changes are made to tracked entities, and creates a non-cascading foreign key constraint in the database.
SetNull 2

Sets foreign key values to null as appropriate when changes are made to tracked entities, and creates a foreign key constraint in the database that propagates null values from principals to dependents.
Cascade 3

Automatically deletes dependent entities when the principal is deleted or the relationship to the principal is severed, and creates creates a foreign key constraint in the database with cascading deletes enabled. This is the default for required relationships.
ClientCascade 4

Automatically deletes dependent entities when the principal is deleted or the relationship to the principal is severed, but creates a non-cascading foreign key constraint in the database.
NoAction 5

Sets foreign key values to null as appropriate when changes are made to tracked entities, and creates a non-cascading foreign key constraint in the database.
ClientNoAction 6

Tracked dependents are not deleted and their foreign key values are not set to null when deleting principal entities. A non-cascading foreign key constraint is created in the database.

Remarks

Behaviors in the database are dependent on the database schema being created appropriately. The database is created appropriately when using Entity Framework Migrations or using one of https://video2.skills-academy.com/dotnet/api/microsoft.entityframeworkcore.infrastructure.databasefacade.ensurecreated or https://video2.skills-academy.com/dotnet/api/microsoft.entityframeworkcore.infrastructure.databasefacade.ensurecreatedasync .

See Cascade delete and deleting orphans in EF Core for more information and examples.

Applies to