How To Update Or Insert A Record In Spring Data JPA

Do you want to know how to update an existing record or insert a new one using Spring Boot?

This article is for you.

Let's imagine the following scenarios:

1. We have an existing customer who wants to amend his phone number because it was wrong.

2. We have an entirely new customer who wants to register his details.

In one of my previous articles on How To Create A Spring Boot REST API, we have the following method:

    public Customer saveCustomer(Customer savedCustomer) {
        Customer customer = new Customer();
        customer.setFirstName(savedCustomer.getFirstName());
        customer.setLastName(savedCustomer.getLastName());
        customer.setEmail(savedCustomer.getEmail());
        customer.setPhoneNumber(savedCustomer.getPhoneNumber());
        return customerRepository.save(savedCustomer);
    }

The method above only covers scenario number 2.

We can refactor this method to perform an upsert operation.

#2 WHAT IS AN UPSERT OPERATION?

An upsert operation is a database operation where we update an existing row if the value is already present in the database. Otherwise, we save the new value into a new row.

#3. HOW DO YOU DO AN UPSERT?

To do this, we have to:

1. Delete any duplicate entry from the Customer table to avoid the 1062 - Duplicate Entry error.

2. We'll use the email to uniquely identify a customer. Therefore, make the email column unique.
   

ALTER TABLE customer ADD UNIQUE (email);

1. Refactor save() method logic so that it checks if an entry exists in the database. If it does, update the existing entry. Otherwise, create a new one and insert it into the database.

    public Customer saveCustomer(Customer savedCustomer) {
        Customer customer =    customerRepository
                .findCustomerByEmail(savedCustomer.getEmail());

        if(customer != null) {
            customer.setFirstName(savedCustomer.getFirstName());
            customer.setLastName(savedCustomer.getLastName());
            customer.setPhoneNumber(savedCustomer.getPhoneNumber());
        } else {
customer = new Customer();
            customer.setFirstName(savedCustomer.getFirstName());
            customer.setLastName(savedCustomer.getLastName());
            customer.setEmail(savedCustomer.getEmail());
            customer.setPhoneNumber(savedCustomer.getPhoneNumber());
        }
        return customerRepository.save(customer);
    }

    public Optional<Customer> getCustomerByEmail(String email){
        Customer customer = customerRepository.findCustomerByEmail(email);

        return Optional.ofNullable(customer);
    }

#3. TESTING ON POSTMAN

Let's test this logic via Postman:

The record gets updated in the database too.

Now let's try to update Helena's phone number with a different one.

In the database, Helena's phone number should be updated (no new row should be created).

CONCLUSION

I hope you've found this article helpful.

Leave any questions/doubts in the comments below.

Until next time!

FURTHER READING:

• Replace A JPA Entity With A DTO.

• What's the difference between a PUT and PATCH request in Spring Boot?

Comments

[JunHo Kim (김준호)]

if(customer != null) {
            customer.setFirstName(savedCustomer.getFirstName());
            customer.setLastName(savedCustomer.getLastName());
            customer.setPhoneNumber(savedCustomer.getPhoneNumber());
        } else {
            customer.setFirstName(savedCustomer.getFirstName());
            customer.setLastName(savedCustomer.getLastName());
            customer.setEmail(savedCustomer.getEmail());
            customer.setPhoneNumber(savedCustomer.getPhoneNumber());
        }

I guess it makes NPE when customer is null, doesn't it?

[Petrus-Nauyoma]

Hey Maddy. Do you also do UI development?

[Maddy]

I don't, darling.

[Petrus-Nauyoma]

Cool cool, so are you basically a java backend developer? Or what other roles are you into, your article was very informative.

[Maddy]

I work with Java, so I share what I learn on my blog. I'm developing other skills, such as SEO.

[ssemugenyi isaac]

I do frontend

[Nour-eddine Lachgar]

i don't really like this approach
postgres has ON CONFLICT clause

INSERT INTO table_name (column1, column2, ...)
VALUES (value1, value2, ...)
ON CONFLICT (conflict_column)
DO NOTHING | DO UPDATE SET column1 = value1, column2 = value2, ...;

and other dababases like mysql and oracle provide also this feature

am just wondering if there is a jpa implementation of upsert.