Dapper.Rainbow VS Dapper.Contrib

by

I’ve been using Dapper for a while now and have wondered what the Contrib and Rainbow projects were all about myself. After a bit of code review, here are my thoughts on their uses:

Dapper.Contrib

Contrib provides a set of extension methods on the IDbConnection interface for basic CRUD operations:

  • Get
  • Insert
  • Update
  • Delete

The key component of Contrib is that it provides tracking for your entities to identify if changes have been made.

For example, using the Get method with an interface as the type constraint will return a dynamically generated proxy class with an internal dictionary to track what properties have changed.

You can then use the Update method which will generate the SQL needed to only update those properties that have changed.

Major Caveat: to get the tracking goodness of Contrib, you must use an Interface as your type constraint to allow the proxy class to be generated.

Dapper.Rainbow

Rainbow is an Abstract class that you can use as a base class for your Dapper classes to provide basic CRUD operations:

  • Get
  • Insert
  • Update
  • Delete

As well as some commonly used methods such as First (gets the first record in a table) and All (gets all results records in a table).

For all intents and purposes, Rainbow is basically a wrapper for your most commonly used database interactions and will build up the boring SQL based on property names and type constraints.

For example, with a Get operation, Rainbow will build up a vanilla SQL query and return all columns and then map those values back to the type used as the constraint.

Similarly, the insert/update methods will dynamically build up the SQL needed for an insert/update based on the type constraint’s property names.

Major Caveat: Rainbow expects all your tables to have an identity column named “Id”.

Differences?

The major difference between Contrib and Rainbow is (IMO), one tracks changes to your entities, the other doesn’t:

  • Use Contrib when you want to be able to track changes in your entities.
  • Use Rainbow when you want to use something more along the lines of a standard ADO.NET approach.

On a side note: I wish I had looked into Rainbow earlier as I have built up a very similar base class that I use with Dapper.

From the article and quote @anthonyv quoted: That annoying INSERT problem, getting data into the DB

There are now 2 other APIs you can choose from as well (besides Rainbow) (for CRUD)
Dapper.Contrib and Dapper Extensions.
I do not think that one-size-fits-all. Depending on your problem and
preferences there may be an API that works best for you. I tried to
present some of the options. There is no blessed “best way” to solve
every problem in the world.

I suspect what Sam was trying to convey in the above quote and the related blog post was: Your scenario may require a lot of custom mapping (use vanilla Dapper), or it may need to track entity changes (use Contrib), or you may have common usage scenarios (use Rainbow) or you may want to use a combination of them all. Or not even use Dapper. YMMV.

More Related Contents:

  1. How do I map lists of nested objects with Dapper
  2. What is the “N+1 selects problem” in ORM (Object-Relational Mapping)?
  3. What is the difference between fetch=”EAGER” and fetch=”LAZY” in doctrine
  4. Is there a way to call a stored procedure with Dapper?
  5. Performing Inserts and Updates with Dapper
  6. What are the advantages of using an ORM? [closed]
  7. Dapper and SQL Injections
  8. What is an Object-Relational Mapping Framework? [duplicate]
  9. Doctrine 2 ArrayCollection filter method
  10. Memory leaks Symfony2 Doctrine2 / exceed memory limit
  11. Dapper and anonymous Types
  12. Hibernate Annotations – Which is better, field or property access?
  13. Using an ORM or plain SQL? [closed]
  14. Bypass GeneratedValue in Hibernate (merge data not in db?)
  15. LINQ To Entities does not recognize the method Last. Really?
  16. Hibernate – @ElementCollection – Strange delete/insert behavior
  17. Default value in Doctrine
  18. session.connection() deprecated on Hibernate?
  19. Unique fields that allow nulls in Django
  20. JPQL IN clause: Java-Arrays (or Lists, Sets…)?
  21. Location of hibernate.cfg.xml in project?
  22. Hibernate throws org.hibernate.AnnotationException: No identifier specified for entity: com..domain.idea.MAE_MFEView
  23. How to set a default entity property value with Hibernate
  24. Should I transform Entity (Persistent) objects to DTO objects?
  25. mappedBy reference an unknown target entity property
  26. How to implement batch fetching with Fluent NHibernate when working with Oracle?
  27. Eager , Lazy and explicit loading in EF6
  28. JPA CriteriaBuilder – How to use “IN” comparison operator
  29. HibernateException: Couldn’t obtain transaction-synchronized Session for current thread
  30. Hibernate hbm2ddl.auto, possible values, and what they do

Leave a Comment