Permalink
Browse files

updated Riak documentation describing limitations

  • Loading branch information...
1 parent a02a332 commit 11387919165f1aa3460bfacc4c8995e4888c669d @graemerocher graemerocher committed Dec 14, 2011
@@ -1,3 +1,3 @@
title=Riak GORM
version=1.0.0.M4
-authors=Jon Brisbin
+authors=Jon Brisbin, Graeme Rocher
@@ -5,3 +5,28 @@ This project aims to provide an object-mapping framework on top of Riak to ease
* Converting objects to/from JSON for storage in Riak
* Easy access to custom Map/Reduce queries
* Validating domain instances backed by the Riak datastore
+
+The following key features are supported by GORM for Riak:
+
+* Simple persistence methods
+* Dynamic finders
+* Criteria queries
+* Named queries
+* Inheritance
+* Embedded types
+* Query by example
+
+However, some features are not supported:
+
+* Pagination (yes Riak doesn't allow you to paginate records)
+* Queries that compare properties
+* Queries that operate on the size() of a collection association
+* Join queries
+* HQL queries
+* Dirty checking methods
+* Composite primary keys
+* Many-to-many associations (these can be modelled with a mapping class)
+* Any direct interaction with the Hibernate API
+* Custom Hibernate user types
+
+There may be other limitations not mentioned here so in general it shouldn't be expected that an application based on GORM for Hibernate will "just work" without some tweaking involved. Having said that, the large majority of common GORM functionality is supported.

0 comments on commit 1138791

Please sign in to comment.