How to temporarily disable the Hibernate entity version checking?

Question

I have a page where I display all contacts. This is just the read only page and all I do is iterate through all contacts for some group and display them:

//Not lazy load of contacts, I cannot use lazy loading
List<Contact> contacts = someService.getContacts(groupId);

for (Contact contact : contacts) {
    //add contact properties to the model to be displayed later
}

At the same time I might have a separate, background thread which updates one of the contacts. The thread updates a field that I'm not going to display, so I'm perfectly OK with data desynchronising in this case.

The problem is the Hibernate will update the contact's version number and commit it to my db (when the background thread finishes). So when my for loop hits such an object the following exception will be thrown.

org.hibernate.StaleObjectStateException: Row was updated or deleted by another transaction (or unsaved-value mapping was incorrect)

Which is perfectly ok. Is there a way to disable object's version checking during iteration through a hibernate's collection? When I say disable, I mean in this particular scenario, in this particular for loop? But not other situations.

I think it happens because the underlying collection is the AbstractPersistentCollection and its iterator will check each member's version with corresponding db value.

I also have this problem. In my case I am aware that there could be another thread writing to the entity but I want my current method to trump all of those other methods. Alternatively my plan is to retry the current method if I get a org.hibernate.StaleObjectStateException — Camilla
– Camilla, Commented Oct 9, 2018 at 20:56

Vlad Mihalcea · Accepted Answer · 2020-09-11 10:02:31Z

2

You cannot disable optimistic locking on a session-basis, but there are some alternatives to handle this situation:

You can switch to versionless optimistic locking
You can map multiple Entity fragments to the same table, and you can have a fragment that only contains the columns you need for a particular business case and with no version. This way you can bypass the regular Entity optimistic locking check.

edited Sep 11, 2020 at 10:02

answered Jun 15, 2015 at 9:26

Vlad Mihalcea

156k85 gold badges599 silver badges984 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Peter Butkovic Over a year ago

can you please elaborate on the 2.nd option? In my case, I need to use @Version attribute for the specific field. However in one of the use-cases, I need to set it's value manually (and prevent beeing overwritten)

codedabbler · Accepted Answer · 2015-06-15 20:21:56Z

1

If you are doing a read-only operation, then you should not get a StaleObjectStateException. This exception is thrown when you are doing an update with data that is stale and Hibernate detects it using the version information.

So check your code and make sure that you are not doing any unneeded updates from your read-only operation of displaying the contacts.

answered Jun 15, 2015 at 20:21

codedabbler

1,2617 silver badges13 bronze badges

1 Comment

Peter Wippermann Over a year ago

it's not a read-only operation! look at the comment in the code: //add contact properties to the model to be displayed later . He's manipulating the entity, so Hibernate tries to write that back to the database. It's a design flaw in OP's code, IMO.

sanemain · Accepted Answer · 2021-02-25 14:17:09Z

Here are 2 solutions I could come up in addition to the ones described in other answers:

Use native sql update in the thread to update the Contact entity and do not increment the version number.
Extract the updated fields into a separate entity and do not include @Version in that entity. In a normal transaction (triggered from end user request) updating Contacts, use OPTIMISTIC_FORCE_INCREMENT hint. This hint forces the Contact version number increment even if you only update the extracted entity. The other thread mentioned can update the extracted entity without any hint or so.

Both solutions have cons and they seem equally ugly to me. I feel the same for solutions mentioned in other answers. I believe JPA should provide more flexibility in how it handles optimistic version control.

Peter Wippermann · Accepted Answer · 2024-07-19 09:43:59Z

If I understand your code correctly you're manipulating the entity in your "read-only display page":

//add contact properties to the model to be displayed later

I guess, these are properties only used for display purpose, calculated before displaying them - but not meant to be saved in the database? If so, you shouldn't define these properties in your entity! Hibernate will try to write them back in the database (Did you even define those database columns?).

Here are your alternatives:

Map your entity to a DTO/POJO class before returning it in your Controller. That new class can contain properties you only need for display purposes.
Detach the entity from the EntityManager. So calling any Setters on it will not cause update calls to the database.

Collectives™ on Stack Overflow

How to temporarily disable the Hibernate entity version checking?

4 Answers 4

1 Comment

1 Comment

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related