Wednesday, September 09, 2009

Rails: Handling Duplicate Entries with Unique Indexes

If you add a unique index to a column in a database table, the database will prevent you from having two records with the same value for the given column. Rails has similar functionality at the application level. However, just like with foreign keys, the application isn't in a good position to enforce such a constraint. As soon as you have multiple application servers hitting the same database, it becomes obvious that only the database is in a position to enforce the constraint without suffering from ugly race conditions.

Ok, so how do you let the database enforce the constraint, but still handle duplicate records gracefully? Start with adding the unique index to the database in a migration:
add_index :wishlist_books, [:user_id, :book_id], :unique => true
Now, instead of creating the record directly in the controller, call a method in the model:
In the user model, you might have something like this:
# Add a book to the wish list.
# This is idempotent. It will just do the right thing if the user tries to
# insert a duplicate record.
# Important: if you call this method, then the next time you load the wish
# list, you must reload to clear the cache. For instance:
# current_user.wishlist_books(true)
def add_book_to_wishlist(book)
wishlist_books.create! do |list_item| = book
rescue ActiveRecord::StatementInvalid => e
raise e unless /Mysql::Error: Duplicate entry/.match(e)
Don't worry too much about the associations. I'm just trying to show the code somewhat in context. The important part is the exception that is caught.

Naturally, this is MySQL specific. I don't know the exact thing to look for with PostgreSQL. However, that's okay. I don't mind using MySQL specific features in my models where it makes sense.


Shannon -jj Behrens said...

By the way, here's the full exception:

ActiveRecord::StatementInvalid in ... Mysql::Error: Duplicate entry '1409-6622' for key 2: INSERT INTO `wishlist_books` (...) VALUES(...)

Anonymous said...

I realize this is very old, but I stumbled upon it via google and noticed a potential snag with the code, so I will point it out: if the attributes are not the same as the existing record, they do not get updated in the database, but the method in the model swallows the exception...

Shannon Behrens said...

Thanks for your comment, but are you sure? I think the exception will get re-raised if it doesn't match "Duplicate entry".

mwittig said...

A superior approach is to use MySQL's on-duplicate-key-update functionality. This gem provides an interface to it:

That way you don't get an error if there is a duplicate key, and you can overwrite values of other columns. If the record you're trying to save is at all different from the version in the database, the version in the database will not be modified since the save fails.

Shannon Behrens said...

mwittig, nice!