Delete from a JPARepository with an EmbeddedId by a field in the primary key

Question

Currently I have a Spring Boot application using JpaRepository<Employee, EmployeePk> where let's say EmployeePk is firstname, lastname. Is there a way to delete by Primary Key field without having to specify a custom @Query? It's ok to delete multiple rows if multiple people were named "John".

Example:

@Repository
public interface EmployeeRepository extends JpaRepository<Employee, EmployeePk> {

    @Transactional
    @Modifying
    @Query(value = "DELETE FROM Employee e WHERE e.EmployeePk.firstname = :firstname ")
    void deleteAllByEeId(String firstname);
}

such as

void deleteByEmployeePkWhereFirstname(String firstname);

Employee class and Embedded PK

public class Employee {

    @EmbeddedId
    private EmployeePK employeePK;
    
    private LocalDate birthDate;

}

public class EmployeePK implements Serializable {

    public static final long serialVersionUID = 1L;

    private String firstName;

    private String lastName;
}

can you post the code of the entiy Employee and the class EmployyPk ? In fact you can use methods defined by `JpaRepository` based in the entity fields to delete employees by firstName — Abenamor, Dec 03 '21 at 23:44
Posted. Yes I was looking for something like you mentioned but couldn't find documentation when it involved an EmbeddedId. — Bizzaroerik, Dec 05 '21 at 17:48

score 3 · Accepted Answer · answered Dec 05 '21 at 21:22

Thanks for adding the Employee and EmployeePK code source.

Since you have the field firstName in your entity so you can use derived delete queries that let you avoid having to declare the JPQL query explicitly

Based in spring data documentation

Derived Delete Queries

Spring Data JPA also supports derived delete queries that let you avoid having to declare the JPQL query explicitly, as shown in the following example:

You can add this method in your repositroy.

@Repository
public interface EmployeeRepository extends JpaRepository<Employee, EmployeePK> {

void deleteByEmployeePK_FirstName(String firstName);
}

You don't need @Modify annotation since you will not use @Query annotation.

And add @Entity to your entity in order to be mapped by the associated table in the database.

@Entity
public class Employee {

@EmbeddedId
private EmployeePK employeePK;

private LocalDate birthDate;

 }

What's the difference between deleteByEmployeePK_FirstName and deleteByEmployeePKFirstName (no underscore)? I see that both are valid syntax. EDIT: I see the answer below states it's just readability — Kosi, Mar 15 '23 at 15:19

score 2 · Answer 2 · answered Dec 05 '21 at 17:57

2

The following should work:

@Repository
public interface EmployeeRepository extends JpaRepository<Employee, EmployeePk> {

    @Transactional
    @Modifying
    void deleteByEmployeePKFirstName(String firstname);
}

Or if you want it to be more readable:

@Repository
public interface EmployeeRepository extends JpaRepository<Employee, EmployeePk> {

    @Transactional
    @Modifying
    void deleteByEmployeePK_FirstName(String firstname);
}

answered Dec 05 '21 at 17:57

João Dias

16,277
6
33
45

Works. Thank you! – Bizzaroerik Dec 06 '21 at 16:17
If my answer helped you consider upvoting it and even accepting it as the answer so that it can be ”closed” and others can benefit from it and easily understand which could be a possible solution for similar questions ;) Thanks! – João Dias Dec 06 '21 at 16:57
Oh, you accepted already another answer. That is ok but consider at least upvoting mine. Thanks! – João Dias Dec 06 '21 at 16:58
Definitely! I just made this account and finally got enough points to upvote other users. Also wish I could accept both as solutions. – Bizzaroerik Dec 07 '21 at 17:28
Thanks @Bizzaroerik! – João Dias Dec 07 '21 at 17:29

Delete from a JPARepository with an EmbeddedId by a field in the primary key

2 Answers2