More at Overview | Download | Deploy | Code | Screencasts | Documentation | Ecosystem | Community | Blog

Active Record Query Interface

This guide covers different ways to retrieve data from the database using Active Record. By referring to this guide, you will be able to:

This Guide is based on Rails 3.0. Some of the code shown here will not work in other versions of Rails.

If you’re used to using raw SQL to find database records then, generally, you will find that there are better ways to carry out the same operations in Rails. Active Record insulates you from the need to use SQL in most cases.

Code examples throughout this guide will refer to one or more of the following models:

All of the following models use id as the primary key, unless specified otherwise.

class Client < ActiveRecord::Base
  has_one :address
  has_many :orders
  has_and_belongs_to_many :roles
class Address < ActiveRecord::Base
  belongs_to :client
class Order < ActiveRecord::Base
  belongs_to :client, :counter_cache => true
class Role < ActiveRecord::Base
  has_and_belongs_to_many :clients

Active Record will perform queries on the database for you and is compatible with most database systems (MySQL, PostgreSQL and SQLite to name a few). Regardless of which database system you’re using, the Active Record method format will always be the same.

1 Retrieving Objects from the Database

To retrieve objects from the database, Active Record provides several finder methods. Each finder method allows you to pass arguments into it to perform certain queries on your database without writing raw SQL.

The methods are:

  • where
  • select
  • group
  • order
  • reorder
  • reverse_order
  • limit
  • offset
  • joins
  • includes
  • lock
  • readonly
  • from
  • having

All of the above methods return an instance of ActiveRecord::Relation.

Primary operation of Model.find(options) can be summarized as:

  • Convert the supplied options to an equivalent SQL query.
  • Fire the SQL query and retrieve the corresponding results from the database.
  • Instantiate the equivalent Ruby object of the appropriate model for every resulting row.
  • Run after_find callbacks if any.

1.1 Retrieving a Single Object

Active Record lets you retrieve a single object using five different ways.

1.1.1 Using a Primary Key

Using Model.find(primary_key), you can retrieve the object corresponding to the supplied primary key and matching the supplied options (if any). For example:

# Find the client with primary key (id) 10.
client = Client.find(10)
=> #<Client id: 10, first_name: => "Ryan">

SQL equivalent of the above is:

SELECT * FROM clients WHERE ( = 10)

Model.find(primary_key) will raise an ActiveRecord::RecordNotFound exception if no matching record is found.

1.1.2 first

Model.first finds the first record matched by the supplied options. For example:

client = Client.first
=> #<Client id: 1, first_name: "Lifo">

SQL equivalent of the above is:


Model.first returns nil if no matching record is found. No exception will be raised.

1.1.3 last

Model.last finds the last record matched by the supplied options. For example:

client = Client.last
=> #<Client id: 221, first_name: "Russel">

SQL equivalent of the above is:


Model.last returns nil if no matching record is found. No exception will be raised.

1.1.4 first!

Model.first! finds the first record. For example:

client = Client.first!
=> #<Client id: 1, first_name: "Lifo">

SQL equivalent of the above is:


Model.first! raises RecordNotFound if no matching record is found.

1.1.5 last!

Model.last! finds the last record. For example:

client = Client.last!
=> #<Client id: 221, first_name: "Russel">

SQL equivalent of the above is:


Model.last! raises RecordNotFound if no matching record is found.

1.2 Retrieving Multiple Objects

1.2.1 Using Multiple Primary Keys

Model.find(array_of_primary_key) also accepts an array of primary keys. An array of all the matching records for the supplied primary keys is returned. For example:

# Find the clients with primary keys 1 and 10.
client = Client.find(1, 10) # Or even Client.find([1, 10])
=> [#<Client id: 1, first_name: => "Lifo">, #<Client id: 10, first_name: => "Ryan">]

SQL equivalent of the above is:

SELECT * FROM clients WHERE ( IN (1,10))

Model.find(array_of_primary_key) will raise an ActiveRecord::RecordNotFound exception unless a matching record is found for all of the supplied primary keys.

1.3 Retrieving Multiple Objects in Batches

Sometimes you need to iterate over a large set of records. For example to send a newsletter to all users, to export some data, etc.

The following may seem very straight forward at first:

# Very inefficient when users table has thousands of rows.
User.all.each do |user|

But if the total number of rows in the table is very large, the above approach may vary from being under performant to just plain impossible.

This is because User.all.each makes Active Record fetch the entire table, build a model object per row, and keep the entire array in the memory. Sometimes that is just too many objects and demands too much memory.

1.3.1 find_each

To efficiently iterate over a large table, Active Record provides a batch finder method called find_each:

User.find_each do |user|

Configuring the batch size

Behind the scenes find_each fetches rows in batches of 1000 and yields them one by one. The size of the underlying batches is configurable via the :batch_size option.

To fetch User records in batch size of 5000:

User.find_each(:batch_size => 5000) do |user|

Starting batch find from a specific primary key

Records are fetched in ascending order on the primary key, which must be an integer. The :start option allows you to configure the first ID of the sequence if the lowest is not the one you need. This may be useful for example to be able to resume an interrupted batch process if it saves the last processed ID as a checkpoint.

To send newsletters only to users with the primary key starting from 2000:

User.find_each(:batch_size => 5000, :start => 2000) do |user|

Additional options

find_each accepts the same options as the regular find method. However, :order and :limit are needed internally and hence not allowed to be passed explicitly.

1.3.2 find_in_batches

You can also work by chunks instead of row by row using find_in_batches. This method is analogous to find_each, but it yields arrays of models instead:

# Works in chunks of 1000 invoices at a time.
Invoice.find_in_batches(:include => :invoice_lines) do |invoices|

The above will yield the supplied block with 1000 invoices every time.

2 Conditions

The where method allows you to specify conditions to limit the records returned, representing the WHERE-part of the SQL statement. Conditions can either be specified as a string, array, or hash.

2.1 Pure String Conditions

If you’d like to add conditions to your find, you could just specify them in there, just like Client.where("orders_count = '2'"). This will find all clients where the orders_count field’s value is 2.

Building your own conditions as pure strings can leave you vulnerable to SQL injection exploits. For example, Client.where("first_name LIKE '%#{params[:first_name]}%'") is not safe. See the next section for the preferred way to handle conditions using an array.

2.2 Array Conditions

Now what if that number could vary, say as an argument from somewhere? The find then becomes something like:

Client.where("orders_count = ?", params[:orders])

Active Record will go through the first element in the conditions value and any additional elements will replace the question marks (?) in the first element.

Or if you want to specify two conditions, you can do it like:

Client.where("orders_count = ? AND locked = ?", params[:orders], false)

In this example, the first question mark will be replaced with the value in params[:orders] and the second will be replaced with the SQL representation of false, which depends on the adapter.

The reason for doing code like:

Client.where("orders_count = ?", params[:orders])

instead of:

Client.where("orders_count = #{params[:orders]}")

is because of argument safety. Putting the variable directly into the conditions string will pass the variable to the database as-is. This means that it will be an unescaped variable directly from a user who may have malicious intent. If you do this, you put your entire database at risk because once a user finds out he or she can exploit your database they can do just about anything to it. Never ever put your arguments directly inside the conditions string.

For more information on the dangers of SQL injection, see the Ruby on Rails Security Guide.

2.2.1 Placeholder Conditions

Similar to the (?) replacement style of params, you can also specify keys/values hash in your array conditions:

Client.where("created_at >= :start_date AND created_at <= :end_date",
  {:start_date => params[:start_date], :end_date => params[:end_date]})

This makes for clearer readability if you have a large number of variable conditions.

2.2.2 Range Conditions

If you’re looking for a range inside of a table (for example, users created in a certain timeframe) you can use the conditions option coupled with the IN SQL statement for this. If you had two dates coming in from a controller you could do something like this to look for a range:

Client.where(:created_at => (params[:start_date].to_date)..(params[:end_date].to_date))

This query will generate something similar to the following SQL:

SELECT "clients".* FROM "clients" WHERE ("clients"."created_at" BETWEEN '2010-09-29' AND '2010-11-30')

2.3 Hash Conditions

Active Record also allows you to pass in hash conditions which can increase the readability of your conditions syntax. With hash conditions, you pass in a hash with keys of the fields you want conditionalised and the values of how you want to conditionalise them:

Only equality, range and subset checking are possible with Hash conditions.

2.3.1 Equality Conditions
Client.where(:locked => true)

The field name can also be a string:

Client.where('locked' => true)
2.3.2 Range Conditions

The good thing about this is that we can pass in a range for our fields without it generating a large query as shown in the preamble of this section.

Client.where(:created_at => ( -

This will find all clients created yesterday by using a BETWEEN SQL statement:

SELECT * FROM clients WHERE (clients.created_at BETWEEN '2008-12-21 00:00:00' AND '2008-12-22 00:00:00')

This demonstrates a shorter syntax for the examples in Array Conditions

2.3.3 Subset Conditions

If you want to find records using the IN expression you can pass an array to the conditions hash:

Client.where(:orders_count => [1,3,5])

This code will generate SQL like this:

SELECT * FROM clients WHERE (clients.orders_count IN (1,3,5))

3 Ordering

To retrieve records from the database in a specific order, you can use the order method.

For example, if you’re getting a set of records and want to order them in ascending order by the created_at field in your table:


You could specify ASC or DESC as well:

Client.order("created_at DESC")
# OR
Client.order("created_at ASC")

Or ordering by multiple fields:

Client.order("orders_count ASC, created_at DESC")

4 Selecting Specific Fields

By default, Model.find selects all the fields from the result set using select *.

To select only a subset of fields from the result set, you can specify the subset via the select method.

If the select method is used, all the returning objects will be read only.

For example, to select only viewable_by and locked columns:"viewable_by, locked")

The SQL query used by this find call will be somewhat like:

SELECT viewable_by, locked FROM clients

Be careful because this also means you’re initializing a model object with only the fields that you’ve selected. If you attempt to access a field that is not in the initialized record you’ll receive:

ActiveModel::MissingAttributeError: missing attribute: <attribute>

Where <attribute> is the attribute you asked for. The id method will not raise the ActiveRecord::MissingAttributeError, so just be careful when working with associations because they need the id method to function properly.

You can also call SQL functions within the select option. For example, if you would like to only grab a single record per unique value in a certain field by using the DISTINCT function you can do it like this:"DISTINCT(name)")

5 Limit and Offset

To apply LIMIT to the SQL fired by the Model.find, you can specify the LIMIT using limit and offset methods on the relation.

You can use limit to specify the number of records to be retrieved, and use offset to specify the number of records to skip before starting to return the records. For example


will return a maximum of 5 clients and because it specifies no offset it will return the first 5 in the table. The SQL it executes looks like this:


Adding offset to that


will return instead a maximum of 5 clients beginning with the 31st. The SQL looks like:


6 Group

To apply a GROUP BY clause to the SQL fired by the finder, you can specify the group method on the find.

For example, if you want to find a collection of the dates orders were created on:"date(created_at) as ordered_date, sum(price) as total_price").group("date(created_at)")

And this will give you a single Order object for each date where there are orders in the database.

The SQL that would be executed would be something like this:

SELECT date(created_at) as ordered_date, sum(price) as total_price FROM orders GROUP BY date(created_at)

7 Having

SQL uses the HAVING clause to specify conditions on the GROUP BY fields. You can add the HAVING clause to the SQL fired by the Model.find by adding the :having option to the find.

For example:"date(created_at) as ordered_date, sum(price) as total_price").group("date(created_at)").having("sum(price) > ?", 100)

The SQL that would be executed would be something like this:

SELECT date(created_at) as ordered_date, sum(price) as total_price FROM orders GROUP BY date(created_at) HAVING sum(price) > 100

This will return single order objects for each day, but only those that are ordered more than $100 in a day.

8 Overriding Conditions

8.1 except

You can specify certain conditions to be excepted by using the except method. For example:

Post.where('id > 10').limit(20).order('id asc').except(:order)

The SQL that would be executed:

SELECT * FROM posts WHERE id > 10 LIMIT 20

8.2 only

You can also override conditions using the only method. For example:

Post.where('id > 10').limit(20).order('id desc').only(:order, :where)

The SQL that would be executed:


8.3 reorder

The reorder method overrides the default scope order. For example:

class Post < ActiveRecord::Base
  has_many :comments, :order => 'posted_at DESC'


The SQL that would be executed:

SELECT * FROM posts WHERE id = 10 ORDER BY name

In case the reorder clause is not used, the SQL executed would be:

SELECT * FROM posts WHERE id = 10 ORDER BY posted_at DESC

8.4 reverse_order

The reverse_order method reverses the ordering clause if specified.

Client.where("orders_count > 10").order(:name).reverse_order

The SQL that would be executed:

SELECT * FROM clients WHERE orders_count > 10 ORDER BY name DESC

If no ordering clause is specified in the query, the reverse_order orders by the primary key in reverse order.

Client.where("orders_count > 10").reverse_order

The SQL that would be executed:

SELECT * FROM clients WHERE orders_count > 10 ORDER BY DESC

This method accepts no arguments.

9 Readonly Objects

Active Record provides readonly method on a relation to explicitly disallow modification or deletion of any of the returned object. Any attempt to alter or destroy a readonly record will not succeed, raising an ActiveRecord::ReadOnlyRecord exception.

client = Client.readonly.first
client.visits += 1

As client is explicitly set to be a readonly object, the above code will raise an ActiveRecord::ReadOnlyRecord exception when calling with an updated value of visits.

10 Locking Records for Update

Locking is helpful for preventing race conditions when updating records in the database and ensuring atomic updates.

Active Record provides two locking mechanisms:

  • Optimistic Locking
  • Pessimistic Locking

10.1 Optimistic Locking

Optimistic locking allows multiple users to access the same record for edits, and assumes a minimum of conflicts with the data. It does this by checking whether another process has made changes to a record since it was opened. An ActiveRecord::StaleObjectError exception is thrown if that has occurred and the update is ignored.

Optimistic locking column

In order to use optimistic locking, the table needs to have a column called lock_version. Each time the record is updated, Active Record increments the lock_version column. If an update request is made with a lower value in the lock_version field than is currently in the lock_version column in the database, the update request will fail with an ActiveRecord::StaleObjectError. Example:

c1 = Client.find(1)
c2 = Client.find(1)

c1.first_name = "Michael" = "should fail" # Raises a ActiveRecord::StaleObjectError

You’re then responsible for dealing with the conflict by rescuing the exception and either rolling back, merging, or otherwise apply the business logic needed to resolve the conflict.

You must ensure that your database schema defaults the lock_version column to 0.

This behavior can be turned off by setting ActiveRecord::Base.lock_optimistically = false.

To override the name of the lock_version column, ActiveRecord::Base provides a class method called set_locking_column:

class Client < ActiveRecord::Base
  set_locking_column :lock_client_column

10.2 Pessimistic Locking

Pessimistic locking uses a locking mechanism provided by the underlying database. Using lock when building a relation obtains an exclusive lock on the selected rows. Relations using lock are usually wrapped inside a transaction for preventing deadlock conditions.

For example:

Item.transaction do
  i = Item.lock.first = 'Jones'

The above session produces the following SQL for a MySQL backend:

SQL (0.2ms)   BEGIN
Item Load (0.3ms)   SELECT * FROM `items` LIMIT 1 FOR UPDATE
Item Update (0.4ms)   UPDATE `items` SET `updated_at` = '2009-02-07 18:05:56', `name` = 'Jones' WHERE `id` = 1
SQL (0.8ms)   COMMIT

You can also pass raw SQL to the lock method for allowing different types of locks. For example, MySQL has an expression called LOCK IN SHARE MODE where you can lock a record but still allow other queries to read it. To specify this expression just pass it in as the lock option:

Item.transaction do
  i = Item.lock("LOCK IN SHARE MODE").find(1)

11 Joining Tables

Active Record provides a finder method called joins for specifying JOIN clauses on the resulting SQL. There are multiple ways to use the joins method.

11.1 Using a String SQL Fragment

You can just supply the raw SQL specifying the JOIN clause to joins:

Client.joins('LEFT OUTER JOIN addresses ON addresses.client_id =')

This will result in the following SQL:

SELECT clients.* FROM clients LEFT OUTER JOIN addresses ON addresses.client_id =

11.2 Using Array/Hash of Named Associations

This method only works with INNER JOIN.

Active Record lets you use the names of the associations defined on the model as a shortcut for specifying JOIN clause for those associations when using the joins method.

For example, consider the following Category, Post, Comments and Guest models:

class Category < ActiveRecord::Base
  has_many :posts

class Post < ActiveRecord::Base
  belongs_to :category
  has_many :comments
  has_many :tags

class Comment < ActiveRecord::Base
  belongs_to :post
  has_one :guest

class Guest < ActiveRecord::Base
  belongs_to :comment

class Tag < ActiveRecord::Base
  belongs_to :post

Now all of the following will produce the expected join queries using INNER JOIN:

11.2.1 Joining a Single Association

This produces:

SELECT categories.* FROM categories
  INNER JOIN posts ON posts.category_id =

Or, in English: “return a Category object for all categories with posts”. Note that you will see duplicate categories if more than one post has the same category. If you want unique categories, you can use Category.joins(:post).select(“distinct(”).

11.2.2 Joining Multiple Associations
Post.joins(:category, :comments)

This produces:

SELECT posts.* FROM posts
  INNER JOIN categories ON posts.category_id =
  INNER JOIN comments ON comments.post_id =

Or, in English: “return all posts that have a category and at least one comment”. Note again that posts with multiple comments will show up multiple times.

11.2.3 Joining Nested Associations (Single Level)
Post.joins(:comments => :guest)

This produces:

SELECT posts.* FROM posts
  INNER JOIN comments ON comments.post_id =
  INNER JOIN guests ON guests.comment_id =

Or, in English: “return all posts that have a comment made by a guest.”

11.2.4 Joining Nested Associations (Multiple Level)
Category.joins(:posts => [{:comments => :guest}, :tags])

This produces:

SELECT categories.* FROM categories
  INNER JOIN posts ON posts.category_id =
  INNER JOIN comments ON comments.post_id =
  INNER JOIN guests ON guests.comment_id =
  INNER JOIN tags ON tags.post_id =

11.3 Specifying Conditions on the Joined Tables

You can specify conditions on the joined tables using the regular Array and String conditions. Hash conditions provides a special syntax for specifying conditions for the joined tables:

time_range = ( -
Client.joins(:orders).where('orders.created_at' => time_range)

An alternative and cleaner syntax is to nest the hash conditions:

time_range = ( -
Client.joins(:orders).where(:orders => {:created_at => time_range})

This will find all clients who have orders that were created yesterday, again using a BETWEEN SQL expression.

12 Eager Loading Associations

Eager loading is the mechanism for loading the associated records of the objects returned by Model.find using as few queries as possible.

N + 1 queries problem

Consider the following code, which finds 10 clients and prints their postcodes:

clients = Client.limit(10)

clients.each do |client|
  puts client.address.postcode

This code looks fine at the first sight. But the problem lies within the total number of queries executed. The above code executes 1 ( to find 10 clients ) + 10 ( one per each client to load the address ) = 11 queries in total.

Solution to N + 1 queries problem

Active Record lets you specify in advance all the associations that are going to be loaded. This is possible by specifying the includes method of the Model.find call. With includes, Active Record ensures that all of the specified associations are loaded using the minimum possible number of queries.

Revisiting the above case, we could rewrite Client.all to use eager load addresses:

clients = Client.includes(:address).limit(10)

clients.each do |client|
  puts client.address.postcode

The above code will execute just 2 queries, as opposed to 11 queries in the previous case:

SELECT * FROM clients LIMIT 10
SELECT addresses.* FROM addresses
  WHERE (addresses.client_id IN (1,2,3,4,5,6,7,8,9,10))

12.1 Eager Loading Multiple Associations

Active Record lets you eager load any number of associations with a single Model.find call by using an array, hash, or a nested hash of array/hash with the includes method.

12.1.1 Array of Multiple Associations
Post.includes(:category, :comments)

This loads all the posts and the associated category and comments for each post.

12.1.2 Nested Associations Hash
Category.includes(:posts => [{:comments => :guest}, :tags]).find(1)

This will find the category with id 1 and eager load all of the associated posts, the associated posts’ tags and comments, and every comment’s guest association.

12.2 Specifying Conditions on Eager Loaded Associations

Even though Active Record lets you specify conditions on the eager loaded associations just like joins, the recommended way is to use joins instead.

However if you must do this, you may use where as you would normally.

Post.includes(:comments).where("comments.visible", true)

This would generate a query which contains a LEFT OUTER JOIN whereas the joins method would generate one using the INNER JOIN function instead.

SELECT "posts"."id" AS t0_r0, ... "comments"."updated_at" AS t1_r5 FROM "posts" LEFT OUTER JOIN "comments" ON "comments"."post_id" = "posts"."id" WHERE (comments.visible = 1)

If there was no where condition, this would generate the normal set of two queries.

If, in the case of this includes query, there were no comments for any posts, all the posts would still be loaded. By using joins (an INNER JOIN), the join conditions must match, otherwise no records will be returned.

13 Scopes

Scoping allows you to specify commonly-used ARel queries which can be referenced as method calls on the association objects or models. With these scopes, you can use every method previously covered such as where, joins and includes. All scope methods will return an ActiveRecord::Relation object which will allow for further methods (such as other scopes) to be called on it.

To define a simple scope, we use the scope method inside the class, passing the ARel query that we’d like run when this scope is called:

class Post < ActiveRecord::Base
  scope :published, where(:published => true)

Just like before, these methods are also chainable:

class Post < ActiveRecord::Base
  scope :published, where(:published => true).joins(:category)

Scopes are also chainable within scopes:

class Post < ActiveRecord::Base
  scope :published, where(:published => true)
  scope :published_and_commented, published.and(self.arel_table[:comments_count].gt(0))

To call this published scope we can call it on either the class:

Post.published => [published posts]

Or on an association consisting of Post objects:

category = Category.first
category.posts.published => [published posts belonging to this category]

13.1 Working with times

If you’re working with dates or times within scopes, due to how they are evaluated, you will need to use a lambda so that the scope is evaluated every time.

class Post < ActiveRecord::Base
  scope :last_week, lambda { where("created_at < ?", ) }

Without the lambda, this will only be called once.

13.2 Passing in arguments

When a lambda is used for a scope, it can take arguments:

class Post < ActiveRecord::Base
  scope :1_week_before, lambda { |time| where("created_at < ?", time)

This may then be called using this:


However, this is just duplicating the functionality that would be provided to you by a class method.

class Post < ActiveRecord::Base
  def self.1_week_before(time)
    where("created_at < ?", time)

Using a class method is the preferred way to accept arguments for scopes. These methods will still be accessible on the association objects:


13.3 Working with scopes

Where a relational object is required, the scoped method may come in handy. This will return an ActiveRecord::Relation object which can have further scoping applied to it afterwards. A place where this may come in handy is on associations

client = Client.find_by_first_name("Ryan")
orders = client.orders.scoped

With this new orders object, we are able to ascertain that this object can have more scopes applied to it. For instance, if we wanted to return orders only in the last 30 days at a later point.

orders.where("created_at > ?", 30.days.ago)

13.4 Applying a default scope

If we wish for a scope to be applied across all queries to the model we can use the default_scope method within the model itself.

class Client < ActiveRecord::Base
  default_scope where("removed_at IS NULL")

When queries are executed on this model, the SQL query will now look something like this:

SELECT * FROM clients WHERE removed_at IS NULL

13.5 Removing all scoping

If we wish to remove scoping for any reason we can use the unscoped method. This is especially useful if a default_scope is specified in the model and should not be applied for this particular query.


This method removes all scoping and will do a normal query on the table.

14 Dynamic Finders

For every field (also known as an attribute) you define in your table, Active Record provides a finder method. If you have a field called first_name on your Client model for example, you get find_by_first_name and find_all_by_first_name for free from Active Record. If you have a locked field on the Client model, you also get find_by_locked and find_all_by_locked methods.

You can also use find_last_by_* methods which will find the last record matching your argument.

You can specify an exclamation point (!) on the end of the dynamic finders to get them to raise an ActiveRecord::RecordNotFound error if they do not return any records, like Client.find_by_name!("Ryan")

If you want to find both by name and locked, you can chain these finders together by simply typing and between the fields. For example, Client.find_by_first_name_and_locked("Ryan", true).

Up to and including Rails 3.1, when the number of arguments passed to a dynamic finder method is lesser than the number of fields, say Client.find_by_name_and_locked(“Ryan”), the behavior is to pass nil as the missing argument. This is unintentional and this behavior will be changed in Rails 3.2 to throw an ArgumentError.

There’s another set of dynamic finders that let you find or create/initialize objects if they aren’t found. These work in a similar fashion to the other finders and can be used like find_or_create_by_first_name(params[:first_name]). Using this will first perform a find and then create if the find returns nil. The SQL looks like this for Client.find_or_create_by_first_name("Ryan"):

SELECT * FROM clients WHERE (clients.first_name = 'Ryan') LIMIT 1
INSERT INTO clients (first_name, updated_at, created_at, orders_count, locked)
  VALUES('Ryan', '2008-09-28 15:39:12', '2008-09-28 15:39:12', 0, '0')

find_or_create’s sibling, find_or_initialize, will find an object and if it does not exist will act similarly to calling new with the arguments you passed in. For example:

client = Client.find_or_initialize_by_first_name('Ryan')

will either assign an existing client object with the name “Ryan” to the client local variable, or initialize a new object similar to calling => 'Ryan'). From here, you can modify other fields in client by calling the attribute setters on it: client.locked = true and when you want to write it to the database just call save on it.

15 Finding by SQL

If you’d like to use your own SQL to find records in a table you can use find_by_sql. The find_by_sql method will return an array of objects even if the underlying query returns just a single record. For example you could run this query:

Client.find_by_sql("SELECT * FROM clients
  INNER JOIN orders ON = orders.client_id
  ORDER clients.created_at desc")

find_by_sql provides you with a simple way of making custom calls to the database and retrieving instantiated objects.

16 select_all

find_by_sql has a close relative called connection#select_all. select_all will retrieve objects from the database using custom SQL just like find_by_sql but will not instantiate them. Instead, you will get an array of hashes where each hash indicates a record.

Client.connection.select_all("SELECT * FROM clients WHERE id = '1'")

17 Existence of Objects

If you simply want to check for the existence of the object there’s a method called exists?. This method will query the database using the same query as find, but instead of returning an object or collection of objects it will return either true or false.


The exists? method also takes multiple ids, but the catch is that it will return true if any one of those records exists.

# or

It’s even possible to use exists? without any arguments on a model or a relation.

Client.where(:first_name => 'Ryan').exists?

The above returns true if there is at least one client with the first_name ‘Ryan’ and false otherwise.


The above returns false if the clients table is empty and true otherwise.

You can also use any? and many? to check for existence on a model or relation.

# via a model

# via a named scope

# via a relation
Post.where(:published => true).any?
Post.where(:published => true).many?

# via an association

18 Calculations

This section uses count as an example method in this preamble, but the options described apply to all sub-sections.

All calculation methods work directly on a model:

# SELECT count(*) AS count_all FROM clients

Or on a relation:

Client.where(:first_name => 'Ryan').count
# SELECT count(*) AS count_all FROM clients WHERE (first_name = 'Ryan')

You can also use various finder methods on a relation for performing complex calculations:

Client.includes("orders").where(:first_name => 'Ryan', :orders => {:status => 'received'}).count

Which will execute:

SELECT count(DISTINCT AS count_all FROM clients
  LEFT OUTER JOIN orders ON orders.client_id = WHERE
  (clients.first_name = 'Ryan' AND orders.status = 'received')

18.1 Count

If you want to see how many records are in your model’s table you could call Client.count and that will return the number. If you want to be more specific and find all the clients with their age present in the database you can use Client.count(:age).

For options, please see the parent section, Calculations.

18.2 Average

If you want to see the average of a certain number in one of your tables you can call the average method on the class that relates to the table. This method call will look something like this:


This will return a number (possibly a floating point number such as 3.14159265) representing the average value in the field.

For options, please see the parent section, Calculations.

18.3 Minimum

If you want to find the minimum value of a field in your table you can call the minimum method on the class that relates to the table. This method call will look something like this:


For options, please see the parent section, Calculations.

18.4 Maximum

If you want to find the maximum value of a field in your table you can call the maximum method on the class that relates to the table. This method call will look something like this:


For options, please see the parent section, Calculations.

18.5 Sum

If you want to find the sum of a field for all records in your table you can call the sum method on the class that relates to the table. This method call will look something like this:


For options, please see the parent section, Calculations.

19 Changelog

  • June 26 2011: Added documentation for the scoped, unscoped and default methods. Ryan Bigg
  • December 23 2010: Add documentation for the scope method. Ryan Bigg
  • April 7, 2010: Fixed document to validate XHTML 1.0 Strict. Jaime Iniesta
  • February 3, 2010: Update to Rails 3 by James Miller
  • February 7, 2009: Second version by Pratik
  • December 29 2008: Initial version by Ryan Bigg


You're encouraged to help improve the quality of this guide.

If you see any typos or factual errors you are confident to patch, please clone docrails and push the change yourself. That branch of Rails has public write access. Commits are still reviewed, but that happens after you've submitted your contribution. docrails is cross-merged with master periodically.

You may also find incomplete content, or stuff that is not up to date. Please do add any missing documentation for master. Check the Ruby on Rails Guides Guidelines for style and conventions.

If for whatever reason you spot something to fix but cannot patch it yourself, please open an issue.

And last but not least, any kind of discussion regarding Ruby on Rails documentation is very welcome in the rubyonrails-docs mailing list.