Skip to content

Commit

Permalink
Added basic README to explain usage
Browse files Browse the repository at this point in the history
  • Loading branch information
nesquena committed Nov 2, 2010
1 parent f075db2 commit 90ff725
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
@@ -0,0 +1,23 @@
INTRODUCTION
============

This gem is exceptionally simple but also very handy. Let's say you are working in ActiveRecord and you have loaded a collection of objects in a query. You now want to preload associations for these already retrieved objects. This allows you to do that.

USAGE
=====

The usage of this is very straightforward:

@users = User.all
@users.preload(:posts)

This will eager load all posts for each user even after the initial find query has taken place. You can also use this to preload associations for a member as well:

@user = User.first
@user.preload(:posts)

Why not just do?

@user.includes(:posts).all

Good question. In most cases this is the better option. This code is for when that approach is not available.

0 comments on commit 90ff725

Please sign in to comment.