Entity Framework Extensions Delete By Key

The DeleteByKey is a DbSet<TEntity> extension method that deletes an entity by using the value from an existing entity or directly key values.

  • It is a direct operation and doesn't require to call SaveChanges.
  • The entity must exist in the database before this method is called.
var key = customers.FirstOrDefault().CustomerID;
context.Customers.DeleteByKey(key);
            
var customer = context.Customers.FirstOrDefault();
context.Customers.DeleteByKey(customer);

Try it

In this example, the first customer is deleted by specifying its key and then another customer is deleted based on an entity itself from the database.

Anonymous Type

You can pass an anonymous type as a parameter to delete an entity.

var anonymousType = new { CustomerID = 1 };
context.Customers.DeleteByKey(anonymousType);

Try it

Data Transfer Objects (DTOs)

You can also specify the DTO object to delete an entity.

var customerDTO = context.Customers
    .Select(c => new CustomerDTO
    {
        CustomerID = c.CustomerID,
        Name = c.Name
    })
    .FirstOrDefault();
			
context.Customers.DeleteByKey(customerDTO);

Try it

Documentation

Methods

Name Description Example
DeleteByKey<TEntity, T>(T entityOrKeyValue) Deletes an entity by key in your database. Try it
DeleteByKey<TEntity>(params object[] keyValues) Deletes an entity by key in your database.
DeleteByKeyAsync<TEntity, T>(T entityOrKeyValue) Deletes an entity by key in your database.
DeleteByKeyAsync<TEntity>(params object[] keyValues) Deletes an entity by key in your database.
DeleteByKeyAsync<TEntity, T>(CancellationToken cancellationToken, T entityOrKeyValue) Deletes an entity by key in your database.
DeleteByKeyAsync<TEntity>(CancellationToken cancellationToken, params object[] keyValues) Deletes an entity by key in your database.

Limitations

  • Support SQL Server and SQLite
Last updated: 2023-03-01
Author:


Contents