Class: ActiveRecord::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/active_record/base.rb,
lib/active_record/connection_adapters/mysql_adapter.rb,
lib/active_record/connection_adapters/sqlite_adapter.rb,
lib/active_record/connection_adapters/sqlite3_adapter.rb,
lib/active_record/connection_adapters/postgresql_adapter.rb,
lib/active_record/connection_adapters/abstract/connection_specification.rb

Overview

Active Record objects don’t specify their attributes directly, but rather infer them from the table definition with which they’re linked. Adding, removing, and changing attributes and their type is done directly in the database. Any change is instantly reflected in the Active Record objects. The mapping that binds a given Active Record class to a certain database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.

See the mapping rules in table_name and the full example in files/README.html for more insight.

Creation

Active Records accept constructor parameters either in a hash or as a block. The hash method is especially useful when you’re receiving the data from somewhere else, like an HTTP request. It works like this:

user = User.new(:name => "David", :occupation => "Code Artist")
user.name # => "David"

You can also use block initialization:

user = User.new do |u|
  u.name = "David"
  u.occupation = "Code Artist"
end

And of course you can just create a bare object and specify the attributes after the fact:

user = User.new
user.name = "David"
user.occupation = "Code Artist"

Conditions

Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement. The array form is to be used when the condition input is tainted and requires sanitization. The string form can be used for statements that don’t involve tainted data. The hash form works much like the array form, except only equality and range is possible. Examples:

class User < ActiveRecord::Base
  def self.authenticate_unsafely(user_name, password)
    find(:first, :conditions => "user_name = '#{user_name}' AND password = '#{password}'")
  end

  def self.authenticate_safely(user_name, password)
    find(:first, :conditions => [ "user_name = ? AND password = ?", user_name, password ])
  end

  def self.authenticate_safely_simply(user_name, password)
    find(:first, :conditions => { :user_name => user_name, :password => password })
  end
end

The authenticate_unsafely method inserts the parameters directly into the query and is thus susceptible to SQL-injection attacks if the user_name and password parameters come directly from an HTTP request. The authenticate_safely and authenticate_safely_simply both will sanitize the user_name and password before inserting them in the query, which will ensure that an attacker can’t escape the query and fake the login (or worse).

When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That’s done by replacing the question marks with symbols and supplying a hash with values for the matching symbol keys:

Company.find(:first, :conditions => [
  "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
  { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
])

Similarly, a simple hash without a statement will generate conditions based on equality with the SQL AND operator. For instance:

Student.find(:all, :conditions => { :first_name => "Harvey", :status => 1 })
Student.find(:all, :conditions => params[:student])

A range may be used in the hash to use the SQL BETWEEN operator:

Student.find(:all, :conditions => { :grade => 9..12 })

An array may be used in the hash to use the SQL IN operator:

Student.find(:all, :conditions => { :grade => [9,11,12] })

Overwriting default accessors

All column values are automatically available through basic accessors on the Active Record object, but sometimes you want to specialize this behavior. This can be done by overwriting the default accessors (using the same name as the attribute) and calling read_attribute(attr_name) and write_attribute(attr_name, value) to actually change things. Example:

class Song < ActiveRecord::Base
  # Uses an integer of seconds to hold the length of the song

  def length=(minutes)
    write_attribute(:length, minutes.to_i * 60)
  end

  def length
    read_attribute(:length) / 60
  end
end

You can alternatively use self[:attribute]=(value) and self[:attribute] instead of write_attribute(:attribute, value) and read_attribute(:attribute) as a shorter form.

Attribute query methods

In addition to the basic accessors, query methods are also automatically available on the Active Record object. Query methods allow you to test whether an attribute value is present.

For example, an Active Record User with the name attribute has a name? method that you can call to determine whether the user has a name:

user = User.new(:name => "David")
user.name? # => true

anonymous = User.new(:name => "")
anonymous.name? # => false

Accessing attributes before they have been typecasted

Sometimes you want to be able to read the raw attribute data without having the column-determined typecast run its course first. That can be done by using the <attribute>_before_type_cast accessors that all attributes have. For example, if your Account model has a balance attribute, you can call account.balance_before_type_cast or account.id_before_type_cast.

This is especially useful in validation situations where the user might supply a string for an integer field and you want to display the original string back in an error message. Accessing the attribute normally would typecast the string to 0, which isn’t what you want.

Dynamic attribute-based finders

Dynamic attribute-based finders are a cleaner way of getting (and/or creating) objects by simple queries without turning to SQL. They work by appending the name of an attribute to find_by_, find_last_by_, or find_all_by_, so you get finders like Person.find_by_user_name, Person.find_all_by_last_name, and Payment.find_by_transaction_id. So instead of writing Person.find(:first, :conditions => ["user_name = ?", user_name]), you just do Person.find_by_user_name(user_name). And instead of writing Person.find(:all, :conditions => ["last_name = ?", last_name]), you just do Person.find_all_by_last_name(last_name).

It’s also possible to use multiple attributes in the same find by separating them with “and”, so you get finders like Person.find_by_user_name_and_password or even Payment.find_by_purchaser_and_state_and_country. So instead of writing Person.find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password]), you just do Person.find_by_user_name_and_password(user_name, password).

It’s even possible to use all the additional parameters to find. For example, the full interface for Payment.find_all_by_amount is actually Payment.find_all_by_amount(amount, options). And the full interface to Person.find_by_user_name is actually Person.find_by_user_name(user_name, options). So you could call Payment.find_all_by_amount(50, :order => "created_on"). Also you may call Payment.find_last_by_amount(amount, options) returning the last record matching that amount and options.

The same dynamic finder style can be used to create the object if it doesn’t already exist. This dynamic finder is called with find_or_create_by_ and will return the object if it already exists and otherwise creates it, then returns it. Protected attributes won’t be set unless they are given in a block. For example:

# No 'Summer' tag exists
Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")

# Now the 'Summer' tag does exist
Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")

# Now 'Bob' exist and is an 'admin'
User.find_or_create_by_name('Bob', :age => 40) { |u| u.admin = true }

Use the find_or_initialize_by_ finder if you want to return a new record without saving it first. Protected attributes won’t be set unless they are given in a block. For example:

# No 'Winter' tag exists
winter = Tag.find_or_initialize_by_name("Winter")
winter.new_record? # true

To find by a subset of the attributes to be used for instantiating a new object, pass a hash instead of a list of parameters. For example:

Tag.find_or_create_by_name(:name => "rails", :creator => current_user)

That will either find an existing tag named “rails”, or create a new one while setting the user that created it.

Saving arrays, hashes, and other non-mappable objects in text columns

Active Record can serialize any object in text columns using YAML. To do so, you must specify this with a call to the class method serialize. This makes it possible to store arrays, hashes, and other non-mappable objects without doing any additional work. Example:

class User < ActiveRecord::Base
  serialize :preferences
end

user = User.create(:preferences => { "background" => "black", "display" => large })
User.find(user.id).preferences # => { "background" => "black", "display" => large }

You can also specify a class option as the second parameter that’ll raise an exception if a serialized object is retrieved as a descendant of a class not in the hierarchy. Example:

class User < ActiveRecord::Base
  serialize :preferences, Hash
end

user = User.create(:preferences => %w( one two three ))
User.find(user.id).preferences    # raises SerializationTypeMismatch

Single table inheritance

Active Record allows inheritance by storing the name of the class in a column that by default is named “type” (can be changed by overwriting Base.inheritance_column). This means that an inheritance looking like this:

class Company < ActiveRecord::Base; end
class Firm < Company; end
class Client < Company; end
class PriorityClient < Client; end

When you do Firm.create(:name => "37signals"), this record will be saved in the companies table with type = “Firm”. You can then fetch this row again using Company.find(:first, "name = '37signals'") and it will return a Firm object.

If you don’t have a type column defined in your table, single-table inheritance won’t be triggered. In that case, it’ll work just like normal subclasses with no special magic for differentiating between them or reloading the right type with find.

Note, all the attributes for all the cases are kept in the same table. Read more: www.martinfowler.com/eaaCatalog/singleTableInheritance.html

Connection to multiple databases in different models

Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection. All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection. For example, if Course is an ActiveRecord::Base, but resides in a different database, you can just say Course.establish_connection and Course and all of its subclasses will use this connection instead.

This feature is implemented by keeping a connection pool in ActiveRecord::Base that is a Hash indexed by the class. If a connection is requested, the retrieve_connection method will go up the class-hierarchy until a connection is found in the connection pool.

Exceptions

  • ActiveRecordError - Generic error class and superclass of all other errors raised by Active Record.

  • AdapterNotSpecified - The configuration hash used in establish_connection didn’t include an :adapter key.

  • AdapterNotFound - The :adapter key used in establish_connection specified a non-existent adapter (or a bad spelling of an existing one).

  • AssociationTypeMismatch - The object assigned to the association wasn’t of the type specified in the association definition.

  • SerializationTypeMismatch - The serialized object wasn’t of the class specified as the second parameter.

  • ConnectionNotEstablished+ - No connection has been established. Use establish_connection before querying.

  • RecordNotFound - No record responded to the find method. Either the row with the given ID doesn’t exist or the row didn’t meet the additional restrictions. Some find calls do not raise this exception to signal nothing was found, please check its documentation for further details.

  • StatementInvalid - The database server rejected the SQL statement. The precise error is added in the message.

  • MultiparameterAssignmentErrors - Collection of errors that occurred during a mass assignment using the attributes= method. The errors property of this exception contains an array of AttributeAssignmentError objects that should be inspected to determine which attributes triggered the errors.

  • AttributeAssignmentError - An error occurred while doing a mass assignment through the attributes= method. You can inspect the attribute property of the exception object to determine which attribute triggered the error.

Note: The attributes listed are class-level attributes (accessible from both the class and instance level). So it’s possible to assign a logger to the class through Base.logger= which will then be used by all instances in the current object space.

Direct Known Subclasses

SessionStore::Session

Defined Under Namespace

Classes: ConnectionSpecification

Constant Summary collapse

@@subclasses = 
{}
@@configurations = 
{}
@@primary_key_prefix_type = 
nil
@@table_name_prefix = 
""
@@table_name_suffix = 
""
@@pluralize_table_names = 
true
@@colorize_logging = 
true
@@default_timezone = 
:local
@@schema_format = 
:ruby
@@timestamped_migrations = 
true
@@connection_handler = 
ConnectionAdapters::ConnectionHandler.new

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = nil) ⇒ Base

New objects can be instantiated as either empty (pass no construction parameter) or pre-set with attributes but not yet saved (pass a hash with key names matching the associated table column names). In both instances, valid attribute keys are determined by the column names of the associated table – hence you can’t have attributes that aren’t part of the table columns.



2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
 
# File 'lib/active_record/base.rb', line 2433

def initialize(attributes = nil)
  @attributes = attributes_from_column_definition
  @attributes_cache = {}
  @new_record = true
  ensure_proper_type
  self.attributes = attributes unless attributes.nil?
  self.class.send(:scope, :create).each { |att,value| self.send("#{att}=", value) } if self.class.send(:scoped?, :create)
  result = yield self if block_given?
  callback(:after_initialize) if respond_to_without_attributes?(:after_initialize)
  result
end

Class Attribute Details

.abstract_class ⇒ Object

Set this to true if this is an abstract class (see abstract_class?).



1466
1467
1468
 
# File 'lib/active_record/base.rb', line 1466

def abstract_class
  @abstract_class
end

Class Method Details

.===(object) ⇒ Object

Overwrite the default class equality method to provide support for association proxies.



1454
1455
1456
 
# File 'lib/active_record/base.rb', line 1454

def ===(object)
  object.is_a?(self)
end

.abstract_class? ⇒ Boolean

Returns whether this class is a base AR class. If A is a base class and B descends from A, then B.base_class will return B.

Returns:

  • (Boolean) 


1470
1471
1472
 
# File 'lib/active_record/base.rb', line 1470

def abstract_class?
  defined?(@abstract_class) && @abstract_class == true
end

.accessible_attributes ⇒ Object

Returns an array of all the attributes that have been made accessible to mass-assignment.



1062
1063
1064
 
# File 'lib/active_record/base.rb', line 1062

def accessible_attributes # :nodoc:
  read_inheritable_attribute(:attr_accessible)
end

.all(*args) ⇒ Object

This is an alias for find(:all). You can pass in all the same arguments to this method as you can to find(:all)



634
635
636
 
# File 'lib/active_record/base.rb', line 634

def all(*args)
  find(:all, *args)
end

.allow_concurrency ⇒ Object

Deprecated and no longer has any effect.



92
93
94
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 92

def allow_concurrency
  ActiveSupport::Deprecation.warn("ActiveRecord::Base.allow_concurrency has been deprecated and no longer has any effect. Please remove all references to allow_concurrency.")
end

.allow_concurrency=(flag) ⇒ Object

Deprecated and no longer has any effect.



97
98
99
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 97

def allow_concurrency=(flag)
  ActiveSupport::Deprecation.warn("ActiveRecord::Base.allow_concurrency= has been deprecated and no longer has any effect. Please remove all references to allow_concurrency=.")
end

.attr_accessible(*attributes) ⇒ Object

Specifies a white list of model attributes that can be set via mass-assignment, such as new(attributes), update_attributes(attributes), or attributes=(attributes)

This is the opposite of the attr_protected macro: Mass-assignment will only set attributes in this list, to assign to the rest of attributes you can use direct writer methods. This is meant to protect sensitive attributes from being overwritten by malicious users tampering with URLs or forms. If you’d rather start from an all-open default and restrict attributes as needed, have a look at attr_protected.

class Customer < ActiveRecord::Base
  attr_accessible :name, :nickname
end

customer = Customer.new(:name => "David", :nickname => "Dave", :credit_rating => "Excellent")
customer.credit_rating # => nil
customer.attributes = { :name => "Jolly fellow", :credit_rating => "Superb" }
customer.credit_rating # => nil

customer.credit_rating = "Average"
customer.credit_rating # => "Average"



1057
1058
1059
 
# File 'lib/active_record/base.rb', line 1057

def attr_accessible(*attributes)
  write_inheritable_attribute(:attr_accessible, Set.new(attributes.map(&:to_s)) + (accessible_attributes || []))
end

.attr_protected(*attributes) ⇒ Object

Attributes named in this macro are protected from mass-assignment, such as new(attributes), update_attributes(attributes), or attributes=(attributes).

Mass-assignment to these attributes will simply be ignored, to assign to them you can use direct writer methods. This is meant to protect sensitive attributes from being overwritten by malicious users tampering with URLs or forms.

class Customer < ActiveRecord::Base
  attr_protected :credit_rating
end

customer = Customer.new("name" => David, "credit_rating" => "Excellent")
customer.credit_rating # => nil
customer.attributes = { "description" => "Jolly fellow", "credit_rating" => "Superb" }
customer.credit_rating # => nil

customer.credit_rating = "Average"
customer.credit_rating # => "Average"

To start from an all-closed default and enable attributes as needed, have a look at attr_accessible.



1024
1025
1026
 
# File 'lib/active_record/base.rb', line 1024

def attr_protected(*attributes)
  write_inheritable_attribute(:attr_protected, Set.new(attributes.map(&:to_s)) + (protected_attributes || []))
end

.attr_readonly(*attributes) ⇒ Object

Attributes listed as readonly can be set for a new record, but will be ignored in database updates afterwards.



1067
1068
1069
 
# File 'lib/active_record/base.rb', line 1067

def attr_readonly(*attributes)
  write_inheritable_attribute(:attr_readonly, Set.new(attributes.map(&:to_s)) + (readonly_attributes || []))
end

.base_class ⇒ Object

Returns the base AR subclass that this class descends from. If A extends AR::Base, A.base_class will return A. If B descends from A through some arbitrarily deep hierarchy, B.base_class will return A.



1461
1462
1463
 
# File 'lib/active_record/base.rb', line 1461

def base_class
  class_of_active_record_descendant(self)
end

.benchmark(title, log_level = Logger::DEBUG, use_silence = true) ⇒ Object

Log and benchmark multiple statements in a single block. Example:

Project.benchmark("Creating project") do
  project = Project.create("name" => "stuff")
  project.create_manager("name" => "David")
  project.milestones << Milestone.find(:all)
end

The benchmark is only recorded if the current level of the logger is less than or equal to the log_level, which makes it easy to include benchmarking statements in production software that will remain inexpensive because the benchmark will only be conducted if the log level is low enough.

The logging of the multiple statements is turned off unless use_silence is set to false.



1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'lib/active_record/base.rb', line 1434

def benchmark(title, log_level = Logger::DEBUG, use_silence = true)
  if logger && logger.level <= log_level
    result = nil
    ms = Benchmark.ms { result = use_silence ? silence { yield } : yield }
    logger.add(log_level, '%s (%.1fms)' % [title, ms])
    result
  else
    yield
  end
end

.class_name(table_name = table_name) ⇒ Object

Turns the table_name back into a class name following the reverse rules of table_name.



1256
1257
1258
1259
1260
1261
 
# File 'lib/active_record/base.rb', line 1256

def class_name(table_name = table_name) # :nodoc:
  # remove any prefix and/or suffix from the table name
  class_name = table_name[table_name_prefix.length..-(table_name_suffix.length + 1)].camelize
  class_name = class_name.singularize if pluralize_table_names
  class_name
end

.column_methods_hash ⇒ Object

Returns a hash of all the methods added to query each of the columns in the table with the name of the method as the key and true as the value. This makes it possible to do O(1) lookups in respond_to? to check if a given method for attribute is available.



1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
 
# File 'lib/active_record/base.rb', line 1296

def column_methods_hash #:nodoc:
  @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
    attr_name = attr.to_s
    methods[attr.to_sym]       = attr_name
    methods["#{attr}=".to_sym] = attr_name
    methods["#{attr}?".to_sym] = attr_name
    methods["#{attr}_before_type_cast".to_sym] = attr_name
    methods
  end
end

.column_names ⇒ Object

Returns an array of column names as strings.



1283
1284
1285
 
# File 'lib/active_record/base.rb', line 1283

def column_names
  @column_names ||= columns.map { |column| column.name }
end

.columns ⇒ Object

Returns an array of column objects for the table associated with this class.



1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/active_record/base.rb', line 1269

def columns
  unless defined?(@columns) && @columns
    @columns = connection.columns(table_name, "#{name} Columns")
    @columns.each { |column| column.primary = column.name == primary_key }
  end
  @columns
end

.columns_hash ⇒ Object

Returns a hash of column objects for the table associated with this class.



1278
1279
1280
 
# File 'lib/active_record/base.rb', line 1278

def columns_hash
  @columns_hash ||= columns.inject({}) { |hash, column| hash[column.name] = column; hash }
end

.connected? ⇒ Boolean

Returns true if ActiveRecord is connected.

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 127

def connected?
  connection_handler.connected?(self)
end

.connection ⇒ Object

Returns the connection currently associated with the class. This can also be used to “borrow” the connection to do database work unrelated to any of the specific Active Records.



114
115
116
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 114

def connection
  retrieve_connection
end

.connection_pool ⇒ Object 



118
119
120
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 118

def connection_pool
  connection_handler.retrieve_connection_pool(self)
end

.content_columns ⇒ Object

Returns an array of column objects where the primary id, all columns ending in “_id” or “_count”, and columns used for single table inheritance have been removed.



1289
1290
1291
 
# File 'lib/active_record/base.rb', line 1289

def content_columns
  @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
end

.count_by_sql(sql) ⇒ Object

Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part. The use of this method should be restricted to complicated SQL queries that can’t be executed using the ActiveRecord::Calculations class methods. Look into those before using this.

Parameters

  • sql - An SQL statement which should return a count query from the database, see the example below.

Examples

Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"



914
915
916
917
 
# File 'lib/active_record/base.rb', line 914

def count_by_sql(sql)
  sql = sanitize_conditions(sql)
  connection.select_value(sql, "#{name} Count").to_i
end

.create(attributes = nil, &block) ⇒ Object

Creates an object (or multiple objects) and saves it to the database, if validations pass. The resulting object is returned whether the object was saved successfully to the database or not.

The attributes parameter can be either be a Hash or an Array of Hashes. These Hashes describe the attributes on the objects that are to be created.

Examples

# Create a single new object
User.create(:first_name => 'Jamie')

# Create an Array of new objects
User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])

# Create a single object and pass it into a block to set other attributes.
User.create(:first_name => 'Jamie') do |u|
  u.is_admin = false
end

# Creating an Array of new objects using a block, where the block is executed for each object:
User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
  u.is_admin = false
end



717
718
719
720
721
722
723
724
725
726
 
# File 'lib/active_record/base.rb', line 717

def create(attributes = nil, &block)
  if attributes.is_a?(Array)
    attributes.collect { |attr| create(attr, &block) }
  else
    object = new(attributes)
    yield(object) if block_given?
    object.save
    object
  end
end

.decrement_counter(counter_name, id) ⇒ Object

Decrement a number field by one, usually representing a count.

This works the same as increment_counter but reduces the column value by 1 instead of increasing it.

Parameters

  • counter_name - The name of the field that should be decremented.

  • id - The id of the object that should be decremented.

Examples

# Decrement the post_count column for the record with an id of 5
DiscussionBoard.decrement_counter(:post_count, 5)



996
997
998
 
# File 'lib/active_record/base.rb', line 996

def decrement_counter(counter_name, id)
  update_counters(id, counter_name => -1)
end

.delete(id) ⇒ Object

Deletes the row with a primary key matching the id argument, using a SQL DELETE statement, and returns the number of rows deleted. Active Record objects are not instantiated, so the object’s callbacks are not executed, including any :dependent association options or Observer methods.

You can delete multiple rows at once by passing an Array of ids.

Note: Although it is often much faster than the alternative, #destroy, skipping callbacks might bypass business logic in your application that ensures referential integrity or performs other essential jobs.

Examples

# Delete a single row
Todo.delete(1)

# Delete multiple rows
Todo.delete([2,3,4])



775
776
777
 
# File 'lib/active_record/base.rb', line 775

def delete(id)
  delete_all([ "#{connection.quote_column_name(primary_key)} IN (?)", id ])
end

.delete_all(conditions = nil) ⇒ Object

Deletes the records matching conditions without instantiating the records first, and hence not calling the destroy method nor invoking callbacks. This is a single SQL DELETE statement that goes straight to the database, much more efficient than destroy_all. Be careful with relations though, in particular :dependent rules defined on associations are not honored. Returns the number of rows affected.

Parameters

  • conditions - Conditions are specified the same way as with find method.

Example

Post.delete_all("person_id = 5 AND (category = 'Something' OR category = 'Else')")
Post.delete_all(["person_id = ? AND (category = ? OR category = ?)", 5, 'Something', 'Else'])

Both calls delete the affected posts all at once with a single DELETE statement. If you need to destroy dependent associations or call your before_* or after_destroy callbacks, use the destroy_all method instead.



897
898
899
900
901
 
# File 'lib/active_record/base.rb', line 897

def delete_all(conditions = nil)
  sql = "DELETE FROM #{quoted_table_name} "
  add_conditions!(sql, conditions, scope(:find))
  connection.delete(sql, "#{name} Delete all")
end

.descends_from_active_record? ⇒ Boolean

True if this isn’t a concrete subclass needing a STI type condition.

Returns:

  • (Boolean) 


1385
1386
1387
1388
1389
1390
1391
 
# File 'lib/active_record/base.rb', line 1385

def descends_from_active_record?
  if superclass.abstract_class?
    superclass.descends_from_active_record?
  else
    superclass == Base || !columns_hash.include?(inheritance_column)
  end
end

.destroy(id) ⇒ Object

Destroy an object (or multiple objects) that has the given id, the object is instantiated first, therefore all callbacks and filters are fired off before the object is deleted. This method is less efficient than ActiveRecord#delete but allows cleanup methods and other actions to be run.

This essentially finds the object (or multiple objects) with the given id, creates a new object from the attributes, and then calls destroy on it.

Parameters

  • id - Can be either an Integer or an Array of Integers.

Examples

# Destroy a single object
Todo.destroy(1)

# Destroy multiple objects
todos = [1,2,3]
Todo.destroy(todos)



798
799
800
801
802
803
804
 
# File 'lib/active_record/base.rb', line 798

def destroy(id)
  if id.is_a?(Array)
    id.map { |one_id| destroy(one_id) }
  else
    find(id).destroy
  end
end

.destroy_all(conditions = nil) ⇒ Object

Destroys the records matching conditions by instantiating each record and calling its destroy method. Each object’s callbacks are executed (including :dependent association options and before_destroy/after_destroy Observer methods). Returns the collection of objects that were destroyed; each will be frozen, to reflect that no changes should be made (since they can’t be persisted).

Note: Instantiation, callback execution, and deletion of each record can be time consuming when you’re removing many records at once. It generates at least one SQL DELETE query per record (or possibly more, to enforce your callbacks). If you want to delete many rows quickly, without concern for their associations or callbacks, use delete_all instead.

Parameters

  • conditions - A string, array, or hash that specifies which records to destroy. If omitted, all records are destroyed. See the Conditions section in the introduction to ActiveRecord::Base for more information.

Examples

Person.destroy_all("last_login < '2004-04-04'")
Person.destroy_all(:status => "inactive")



876
877
878
 
# File 'lib/active_record/base.rb', line 876

def destroy_all(conditions = nil)
  find(:all, :conditions => conditions).each { |object| object.destroy }
end

.establish_connection(spec = nil) ⇒ Object

Establishes the connection to the database. Accepts a hash as input where the :adapter key must be specified with the name of a database adapter (in lower-case) example for regular databases (MySQL, Postgresql, etc):

ActiveRecord::Base.establish_connection(
  :adapter  => "mysql",
  :host     => "localhost",
  :username => "myuser",
  :password => "mypass",
  :database => "somedatabase"
)

Example for SQLite database:

ActiveRecord::Base.establish_connection(
  :adapter => "sqlite",
  :database  => "path/to/dbfile"
)

Also accepts keys as strings (for parsing from YAML for example):

ActiveRecord::Base.establish_connection(
  "adapter" => "sqlite",
  "database"  => "path/to/dbfile"
)

The exceptions AdapterNotSpecified, AdapterNotFound and ArgumentError may be returned on an error.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 51

def self.establish_connection(spec = nil)
  case spec
    when nil
      raise AdapterNotSpecified unless defined? RAILS_ENV
      establish_connection(RAILS_ENV)
    when ConnectionSpecification
      @@connection_handler.establish_connection(name, spec)
    when Symbol, String
      if configuration = configurations[spec.to_s]
        establish_connection(configuration)
      else
        raise AdapterNotSpecified, "#{spec} database is not configured"
      end
    else
      spec = spec.symbolize_keys
      unless spec.key?(:adapter) then raise AdapterNotSpecified, "database configuration does not specify adapter" end

      begin
        require 'rubygems'
        gem "activerecord-#{spec[:adapter]}-adapter"
        require "active_record/connection_adapters/#{spec[:adapter]}_adapter"
      rescue LoadError
        begin
          require "active_record/connection_adapters/#{spec[:adapter]}_adapter"
        rescue LoadError
          raise "Please install the #{spec[:adapter]} adapter: `gem install activerecord-#{spec[:adapter]}-adapter` (#{$!})"
        end
      end

      adapter_method = "#{spec[:adapter]}_connection"
      if !respond_to?(adapter_method)
        raise AdapterNotFound, "database configuration specifies nonexistent #{spec[:adapter]} adapter"
      end

      remove_connection
      establish_connection(ConnectionSpecification.new(spec, adapter_method))
  end
end

.exists?(id_or_conditions = {}) ⇒ Boolean

Returns true if a record exists in the table that matches the id or conditions given, or false otherwise. The argument can take five forms:

  • Integer - Finds the record with this primary key.

  • String - Finds the record with a primary key corresponding to this string (such as '5').

  • Array - Finds the record that matches these find-style conditions (such as ['color = ?', 'red']).

  • Hash - Finds the record that matches these find-style conditions (such as {:color => 'red'}).

  • No args - Returns false if the table is empty, true otherwise.

For more information about specifying conditions as a Hash or Array, see the Conditions section in the introduction to ActiveRecord::Base.

Note: You can’t pass in a condition as a string (like name = 'Jamie'), since it would be sanitized and then queried against the primary key column, like id = 'name = \'Jamie\''.

Examples

Person.exists?(5)
Person.exists?('5')
Person.exists?(:name => "David")
Person.exists?(['name LIKE ?', "%#{query}%"])
Person.exists?

Returns:

  • (Boolean) 


689
690
691
692
693
 
# File 'lib/active_record/base.rb', line 689

def exists?(id_or_conditions = {})
  find_initial(
    :select => "#{quoted_table_name}.#{primary_key}",
    :conditions => expand_id_conditions(id_or_conditions)) ? true : false
end

.find(*args) ⇒ Object

Find operates with four different retrieval approaches:

  • Find by id - This can either be a specific id (1), a list of ids (1, 5, 6), or an array of ids ([5, 6, 10]). If no record can be found for all of the listed ids, then RecordNotFound will be raised.

  • Find first - This will return the first record matched by the options used. These options can either be specific conditions or merely an order. If no record can be matched, nil is returned. Use Model.find(:first, *args) or its shortcut Model.first(*args).

  • Find last - This will return the last record matched by the options used. These options can either be specific conditions or merely an order. If no record can be matched, nil is returned. Use Model.find(:last, *args) or its shortcut Model.last(*args).

  • Find all - This will return all the records matched by the options used. If no records are found, an empty array is returned. Use Model.find(:all, *args) or its shortcut Model.all(*args).

All approaches accept an options hash as their last parameter.

Parameters

  • :conditions - An SQL fragment like “administrator = 1”, [ "user_name = ?", username ], or ["user_name = :user_name", { :user_name => user_name }]. See conditions in the intro.

  • :order - An SQL fragment like “created_at DESC, name”.

  • :group - An attribute name by which the result should be grouped. Uses the GROUP BY SQL-clause.

  • :having - Combined with :group this can be used to filter the records that a GROUP BY returns. Uses the HAVING SQL-clause.

  • :limit - An integer determining the limit on the number of rows that should be returned.

  • :offset - An integer determining the offset from where the rows should be fetched. So at 5, it would skip rows 0 through 4.

  • :joins - Either an SQL fragment for additional joins like “LEFT JOIN comments ON comments.post_id = id” (rarely needed), named associations in the same form used for the :include option, which will perform an INNER JOIN on the associated table(s), or an array containing a mixture of both strings and named associations. If the value is a string, then the records will be returned read-only since they will have attributes that do not correspond to the table’s columns. Pass :readonly => false to override.

  • :include - Names associations that should be loaded alongside. The symbols named refer to already defined associations. See eager loading under Associations.

  • :select - By default, this is “*” as in “SELECT * FROM”, but can be changed if you, for example, want to do a join but not include the joined columns. Takes a string with the SELECT SQL fragment (e.g. “id, name”).

  • :from - By default, this is the table name of the class, but can be changed to an alternate table name (or even the name of a database view).

  • :readonly - Mark the returned records read-only so they cannot be saved or updated.

  • :lock - An SQL fragment like “FOR UPDATE” or “LOCK IN SHARE MODE”. :lock => true gives connection’s default exclusive lock, usually “FOR UPDATE”.

Examples

# find by id
Person.find(1)       # returns the object for ID = 1
Person.find(1, 2, 6) # returns an array for objects with IDs in (1, 2, 6)
Person.find([7, 17]) # returns an array for objects with IDs in (7, 17)
Person.find([1])     # returns an array for the object with ID = 1
Person.find(1, :conditions => "administrator = 1", :order => "created_on DESC")

Note that returned records may not be in the same order as the ids you provide since database rows are unordered. Give an explicit :order to ensure the results are sorted.

Examples

# find first
Person.find(:first) # returns the first object fetched by SELECT * FROM people
Person.find(:first, :conditions => [ "user_name = ?", user_name])
Person.find(:first, :conditions => [ "user_name = :u", { :u => user_name }])
Person.find(:first, :order => "created_on DESC", :offset => 5)

# find last
Person.find(:last) # returns the last object fetched by SELECT * FROM people
Person.find(:last, :conditions => [ "user_name = ?", user_name])
Person.find(:last, :order => "created_on DESC", :offset => 5)

# find all
Person.find(:all) # returns an array of objects for all the rows fetched by SELECT * FROM people
Person.find(:all, :conditions => [ "category IN (?)", categories], :limit => 50)
Person.find(:all, :conditions => { :friends => ["Bob", "Steve", "Fred"] }
Person.find(:all, :offset => 10, :limit => 10)
Person.find(:all, :include => [ :account, :friends ])
Person.find(:all, :group => "category")

Example for find with a lock: Imagine two concurrent transactions: each will read person.visits == 2, add 1 to it, and save, resulting in two saves of person.visits = 3. By locking the row, the second transaction has to wait until the first is finished; we get the expected person.visits == 4.

Person.transaction do
  person = Person.find(1, :lock => true)
  person.visits += 1
  person.save!
end



607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'lib/active_record/base.rb', line 607

def find(*args)
  options = args.extract_options!
  validate_find_options(options)
  set_readonly_option!(options)

  case args.first
    when :first then find_initial(options)
    when :last  then find_last(options)
    when :all   then find_every(options)
    else             find_from_ids(args, options)
  end
end

.find_by_sql(sql) ⇒ Object

Executes a custom SQL query against your database and returns all the results. The results will be returned as an array with columns requested encapsulated as attributes of the model you call this method from. If you call Product.find_by_sql then the results will be returned in a Product object with the attributes you specified in the SQL query.

If you call a complicated SQL query which spans multiple tables the columns specified by the SELECT will be attributes of the model, whether or not they are columns of the corresponding table.

The sql parameter is a full SQL query as a string. It will be called as is, there will be no database agnostic conversions performed. This should be a last resort because using, for example, MySQL specific terms will lock you to using that particular database engine or require you to change your call if you switch engines.

Examples

# A simple SQL query spanning multiple tables
Post.find_by_sql "SELECT p.title, c.author FROM posts p, comments c WHERE p.id = c.post_id"
> [#<Post:0x36bff9c @attributes={"title"=>"Ruby Meetup", "first_name"=>"Quentin"}>, ...]

# You can use the same string replacement techniques as you can with ActiveRecord#find
Post.find_by_sql ["SELECT title FROM posts WHERE author = ? AND created > ?", author_id, start_date]
> [#<Post:0x36bff9c @attributes={"first_name"=>"The Cheap Man Buys Twice"}>, ...]



660
661
662
 
# File 'lib/active_record/base.rb', line 660

def find_by_sql(sql)
  connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
end

.finder_needs_type_condition? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


1393
1394
1395
1396
 
# File 'lib/active_record/base.rb', line 1393

def finder_needs_type_condition? #:nodoc:
  # This is like this because benchmarking justifies the strange :false stuff
  :true == (@finder_needs_type_condition ||= descends_from_active_record? ? :false : :true)
end

.first(*args) ⇒ Object

A convenience wrapper for find(:first, *args). You can pass in all the same arguments to this method as you can to find(:first).



622
623
624
 
# File 'lib/active_record/base.rb', line 622

def first(*args)
  find(:first, *args)
end

.get_primary_key(base_name) ⇒ Object

:nodoc:



1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/active_record/base.rb', line 1170

def get_primary_key(base_name) #:nodoc:
  key = 'id'
  case primary_key_prefix_type
    when :table_name
      key = base_name.to_s.foreign_key(false)
    when :table_name_with_underscore
      key = base_name.to_s.foreign_key
  end
  key
end

.human_attribute_name(attribute_key_name, options = {}) ⇒ Object

Transforms attribute key names into a more humane format, such as “First name” instead of “first_name”. Example:

Person.human_attribute_name("first_name") # => "First name"

This used to be depricated in favor of humanize, but is now preferred, because it automatically uses the I18n module now. Specify options with additional translating options.



1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'lib/active_record/base.rb', line 1361

def human_attribute_name(attribute_key_name, options = {})
  defaults = self_and_descendants_from_active_record.map do |klass|
    :"#{klass.name.underscore}.#{attribute_key_name}"
  end
  defaults << options[:default] if options[:default]
  defaults.flatten!
  defaults << attribute_key_name.to_s.humanize
  options[:count] ||= 1
  I18n.translate(defaults.shift, options.merge(:default => defaults, :scope => [:activerecord, :attributes]))
end

.human_name(options = {}) ⇒ Object

Transform the modelname into a more humane format, using I18n. Defaults to the basic humanize method. Default scope of the translation is activerecord.models Specify options with additional translating options.



1376
1377
1378
1379
1380
1381
1382
 
# File 'lib/active_record/base.rb', line 1376

def human_name(options = {})
  defaults = self_and_descendants_from_active_record.map do |klass|
    :"#{klass.name.underscore}"
  end 
  defaults << self.name.humanize
  I18n.translate(defaults.shift, {:scope => [:activerecord, :models], :count => 1, :default => defaults}.merge(options))
end

.increment_counter(counter_name, id) ⇒ Object

Increment a number field by one, usually representing a count.

This is used for caching aggregate values, so that they don’t need to be computed every time. For example, a DiscussionBoard may cache post_count and comment_count otherwise every time the board is shown it would have to run an SQL query to find how many posts and comments there are.

Parameters

  • counter_name - The name of the field that should be incremented.

  • id - The id of the object that should be incremented.

Examples

# Increment the post_count column for the record with an id of 5
DiscussionBoard.increment_counter(:post_count, 5)



979
980
981
 
# File 'lib/active_record/base.rb', line 979

def increment_counter(counter_name, id)
  update_counters(id, counter_name => 1)
end

.inheritance_column ⇒ Object

Defines the column name for use with single table inheritance – can be set in subclasses like so: self.inheritance_column = “type_id”



1183
1184
1185
 
# File 'lib/active_record/base.rb', line 1183

def inheritance_column
  @inheritance_column ||= "type".freeze
end

.inherited(child) ⇒ Object

:nodoc:



398
399
400
401
402
 
# File 'lib/active_record/base.rb', line 398

def self.inherited(child) #:nodoc:
  @@subclasses[self] ||= []
  @@subclasses[self] << child
  super
end

.inspect ⇒ Object

Returns a string like ‘Post id:integer, title:string, body:text’



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
 
# File 'lib/active_record/base.rb', line 1399

def inspect
  if self == Base
    super
  elsif abstract_class?
    "#{super}(abstract)"
  elsif table_exists?
    attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
    "#{super}(#{attr_list})"
  else
    "#{super}(Table doesn't exist)"
  end
end

.last(*args) ⇒ Object

A convenience wrapper for find(:last, *args). You can pass in all the same arguments to this method as you can to find(:last).



628
629
630
 
# File 'lib/active_record/base.rb', line 628

def last(*args)
  find(:last, *args)
end

.merge_conditions(*conditions) ⇒ Object

Merges conditions so that the result is a valid condition



1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
 
# File 'lib/active_record/base.rb', line 1489

def merge_conditions(*conditions)
  segments = []

  conditions.each do |condition|
    unless condition.blank?
      sql = sanitize_sql(condition)
      segments << sql unless sql.blank?
    end
  end

  "(#{segments.join(') AND (')})" unless segments.empty?
end

.mysql_connection(config) ⇒ Object

Establishes a connection to the database that’s used by all Active Record objects.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/active_record/connection_adapters/mysql_adapter.rb', line 48

def self.mysql_connection(config) # :nodoc:
  config = config.symbolize_keys
  host     = config[:host]
  port     = config[:port]
  socket   = config[:socket]
  username = config[:username] ? config[:username].to_s : 'root'
  password = config[:password].to_s
  database = config[:database]

  # Require the MySQL driver and define Mysql::Result.all_hashes
  unless defined? Mysql
    begin
      require_library_or_gem('mysql')
    rescue LoadError
      $stderr.puts '!!! The bundled mysql.rb driver has been removed from Rails 2.2. Please install the mysql gem and try again: gem install mysql.'
      raise
    end
  end
  MysqlCompat.define_all_hashes_method!

  mysql = Mysql.init
  mysql.ssl_set(config[:sslkey], config[:sslcert], config[:sslca], config[:sslcapath], config[:sslcipher]) if config[:sslca] || config[:sslkey]

  ConnectionAdapters::MysqlAdapter.new(mysql, logger, [host, username, password, database, port, socket], config)
end

.postgresql_connection(config) ⇒ Object

Establishes a connection to the database that’s used by all Active Record objects



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 22

def self.postgresql_connection(config) # :nodoc:
  config = config.symbolize_keys
  host     = config[:host]
  port     = config[:port] || 5432
  username = config[:username].to_s if config[:username]
  password = config[:password].to_s if config[:password]

  if config.has_key?(:database)
    database = config[:database]
  else
    raise ArgumentError, "No database specified. Missing argument: database."
  end

  # The postgres drivers don't allow the creation of an unconnected PGconn object,
  # so just pass a nil connection object for the time being.
  ConnectionAdapters::PostgreSQLAdapter.new(nil, logger, [host, port, nil, nil, database, username, password], config)
end

.primary_key ⇒ Object

Defines the primary key field – can be overridden in subclasses. Overwriting will negate any effect of the primary_key_prefix_type setting, though.



1160
1161
1162
 
# File 'lib/active_record/base.rb', line 1160

def primary_key
  reset_primary_key
end

.protected_attributes ⇒ Object

Returns an array of all the attributes that have been protected from mass-assignment.



1029
1030
1031
 
# File 'lib/active_record/base.rb', line 1029

def protected_attributes # :nodoc:
  read_inheritable_attribute(:attr_protected)
end

.quote_value(value, column = nil) ⇒ Object

:nodoc:



1412
1413
1414
 
# File 'lib/active_record/base.rb', line 1412

def quote_value(value, column = nil) #:nodoc:
  connection.quote(value,column)
end

.readonly_attributes ⇒ Object

Returns an array of all the attributes that have been specified as readonly.



1072
1073
1074
 
# File 'lib/active_record/base.rb', line 1072

def readonly_attributes
  read_inheritable_attribute(:attr_readonly)
end

.remove_connection(klass = self) ⇒ Object 



131
132
133
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 131

def remove_connection(klass = self)
  connection_handler.remove_connection(klass)
end

.reset_column_information ⇒ Object

Resets all the cached information about columns, which will cause them to be reloaded on the next request.

The most common usage pattern for this method is probably in a migration, when just after creating a table you want to populate it with some default values, eg:

class CreateJobLevels < ActiveRecord::Migration
  def self.up
    create_table :job_levels do |t|
      t.integer :id
      t.string :name

      t.timestamps
    end

    JobLevel.reset_column_information
    %w{assistant executive manager director}.each do |type|
      JobLevel.create(:name => type)
    end
  end

  def self.down
    drop_table :job_levels
  end
end



1333
1334
1335
1336
 
# File 'lib/active_record/base.rb', line 1333

def reset_column_information
  generated_methods.each { |name| undef_method(name) }
  @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @generated_methods = @inheritance_column = nil
end

.reset_column_information_and_inheritable_attributes_for_all_subclasses ⇒ Object

:nodoc:



1338
1339
1340
 
# File 'lib/active_record/base.rb', line 1338

def reset_column_information_and_inheritable_attributes_for_all_subclasses#:nodoc:
  subclasses.each { |klass| klass.reset_inheritable_attributes; klass.reset_column_information }
end

.reset_primary_key ⇒ Object

:nodoc:



1164
1165
1166
1167
1168
 
# File 'lib/active_record/base.rb', line 1164

def reset_primary_key #:nodoc:
  key = get_primary_key(base_class.name)
  set_primary_key(key)
  key
end

.reset_sequence_name ⇒ Object

:nodoc:



1193
1194
1195
1196
1197
 
# File 'lib/active_record/base.rb', line 1193

def reset_sequence_name #:nodoc:
  default = connection.default_sequence_name(table_name, primary_key)
  set_sequence_name(default)
  default
end

.reset_subclasses ⇒ Object

:nodoc:



404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/active_record/base.rb', line 404

def self.reset_subclasses #:nodoc:
  nonreloadables = []
  subclasses.each do |klass|
    unless ActiveSupport::Dependencies.autoloaded? klass
      nonreloadables << klass
      next
    end
    klass.instance_variables.each { |var| klass.send(:remove_instance_variable, var) }
    klass.instance_methods(false).each { |m| klass.send :undef_method, m }
  end
  @@subclasses = {}
  nonreloadables.each { |klass| (@@subclasses[klass.superclass] ||= []) << klass }
end

.reset_table_name ⇒ Object

:nodoc:



1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'lib/active_record/base.rb', line 1137

def reset_table_name #:nodoc:
  base = base_class

  name =
    # STI subclasses always use their superclass' table.
    unless self == base
      base.table_name
    else
      # Nested classes are prefixed with singular parent table name.
      if parent < ActiveRecord::Base && !parent.abstract_class?
        contained = parent.table_name
        contained = contained.singularize if parent.pluralize_table_names
        contained << '_'
      end
      name = "#{table_name_prefix}#{contained}#{undecorated_table_name(base.name)}#{table_name_suffix}"
    end

  set_table_name(name)
  name
end

.respond_to?(method_id, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/active_record/base.rb', line 1474

def respond_to?(method_id, include_private = false)
  if match = DynamicFinderMatch.match(method_id)
    return true if all_attributes_exists?(match.attribute_names)
  elsif match = DynamicScopeMatch.match(method_id)
    return true if all_attributes_exists?(match.attribute_names)
  end

  super
end

.retrieve_connection ⇒ Object 



122
123
124
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 122

def retrieve_connection
  connection_handler.retrieve_connection(self)
end

.sanitize(object) ⇒ Object

Used to sanitize objects before they’re used in an SQL SELECT statement. Delegates to connection.quote.



1417
1418
1419
 
# File 'lib/active_record/base.rb', line 1417

def sanitize(object) #:nodoc:
  connection.quote(object)
end

.self_and_descendants_from_active_record ⇒ Object

nodoc:



1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
 
# File 'lib/active_record/base.rb', line 1342

def self_and_descendants_from_active_record#nodoc:
  klass = self
  classes = [klass]
  while klass != klass.base_class  
    classes << klass = klass.superclass
  end
  classes
rescue
  # OPTIMIZE this rescue is to fix this test: ./test/cases/reflection_test.rb:56:in `test_human_name_for_column'
  # Appearantly the method base_class causes some trouble.
  # It now works for sure.
  [self]
end

.sequence_name ⇒ Object

Lazy-set the sequence name to the connection’s default. This method is only ever called once since set_sequence_name overrides it.



1189
1190
1191
 
# File 'lib/active_record/base.rb', line 1189

def sequence_name #:nodoc:
  reset_sequence_name
end

.serialize(attr_name, class_name = Object) ⇒ Object

If you have an attribute that needs to be saved to the database as an object, and retrieved as the same object, then specify the name of that attribute using this method and it will be handled automatically. The serialization is done through YAML. If class_name is specified, the serialized object must be of that class on retrieval or SerializationTypeMismatch will be raised.

Parameters

  • attr_name - The field name that should be serialized.

  • class_name - Optional, class name that the object type should be equal to.

Example

# Serialize a preferences attribute
class User
  serialize :preferences
end



1091
1092
1093
 
# File 'lib/active_record/base.rb', line 1091

def serialize(attr_name, class_name = Object)
  serialized_attributes[attr_name.to_s] = class_name
end

.serialized_attributes ⇒ Object

Returns a hash of all the attributes that have been specified for serialization as keys and their class restriction as values.



1096
1097
1098
 
# File 'lib/active_record/base.rb', line 1096

def serialized_attributes
  read_inheritable_attribute(:attr_serialized) or write_inheritable_attribute(:attr_serialized, {})
end

.set_inheritance_column(value = nil, &block) ⇒ Object Also known as: inheritance_column=

Sets the name of the inheritance column to use to the given value, or (if the value # is nil or false) to the value returned by the given block.

class Project < ActiveRecord::Base
  set_inheritance_column do
    original_inheritance_column + "_id"
  end
end



1231
1232
1233
 
# File 'lib/active_record/base.rb', line 1231

def set_inheritance_column(value = nil, &block)
  define_attr_method :inheritance_column, value, &block
end

.set_primary_key(value = nil, &block) ⇒ Object Also known as: primary_key=

Sets the name of the primary key column to use to the given value, or (if the value is nil or false) to the value returned by the given block.

class Project < ActiveRecord::Base
  set_primary_key "sysid"
end



1217
1218
1219
 
# File 'lib/active_record/base.rb', line 1217

def set_primary_key(value = nil, &block)
  define_attr_method :primary_key, value, &block
end

.set_sequence_name(value = nil, &block) ⇒ Object Also known as: sequence_name=

Sets the name of the sequence to use when generating ids to the given value, or (if the value is nil or false) to the value returned by the given block. This is required for Oracle and is useful for any database which relies on sequences for primary key generation.

If a sequence name is not explicitly set when using Oracle or Firebird, it will default to the commonly used pattern of: #table_name_seq

If a sequence name is not explicitly set when using PostgreSQL, it will discover the sequence corresponding to your primary key for you.

class Project < ActiveRecord::Base
  set_sequence_name "projectseq"   # default would have been "project_seq"
end



1250
1251
1252
 
# File 'lib/active_record/base.rb', line 1250

def set_sequence_name(value = nil, &block)
  define_attr_method :sequence_name, value, &block
end

.set_table_name(value = nil, &block) ⇒ Object Also known as: table_name=

Sets the table name to use to the given value, or (if the value is nil or false) to the value returned by the given block.

class Project < ActiveRecord::Base
  set_table_name "project"
end



1205
1206
1207
 
# File 'lib/active_record/base.rb', line 1205

def set_table_name(value = nil, &block)
  define_attr_method :table_name, value, &block
end

.silence ⇒ Object

Silences the logger for the duration of the block.



1446
1447
1448
1449
1450
1451
 
# File 'lib/active_record/base.rb', line 1446

def silence
  old_logger_level, logger.level = logger.level, Logger::ERROR if logger
  yield
ensure
  logger.level = old_logger_level if logger
end

.sqlite3_connection(config) ⇒ Object

sqlite3 adapter reuses sqlite_connection.



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/active_record/connection_adapters/sqlite3_adapter.rb', line 6

def self.sqlite3_connection(config) # :nodoc:
  parse_sqlite_config!(config)

  unless self.class.const_defined?(:SQLite3)
    require_library_or_gem(config[:adapter])
  end

  db = SQLite3::Database.new(
    config[:database],
    :results_as_hash => true,
    :type_translation => false
  )

  db.busy_timeout(config[:timeout]) unless config[:timeout].nil?

  ConnectionAdapters::SQLite3Adapter.new(db, logger, config)
end

.sqlite_connection(config) ⇒ Object

Establishes a connection to the database that’s used by all Active Record objects



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/active_record/connection_adapters/sqlite_adapter.rb', line 8

def sqlite_connection(config) # :nodoc:
  parse_sqlite_config!(config)

  unless self.class.const_defined?(:SQLite)
    require_library_or_gem(config[:adapter])

    db = SQLite::Database.new(config[:database], 0)
    db.show_datatypes   = "ON" if !defined? SQLite::Version
    db.results_as_hash  = true if defined? SQLite::Version
    db.type_translation = false

    message = "Support for SQLite2Adapter and DeprecatedSQLiteAdapter has been removed from Rails 3. "
    message << "You should migrate to SQLite 3+ or use the plugin from git://github.com/rails/sqlite2_adapter.git with Rails 3."
    ActiveSupport::Deprecation.warn(message)

    # "Downgrade" deprecated sqlite API
    if SQLite.const_defined?(:Version)
      ConnectionAdapters::SQLite2Adapter.new(db, logger, config)
    else
      ConnectionAdapters::DeprecatedSQLiteAdapter.new(db, logger, config)
    end
  end
end

.sti_name ⇒ Object 



1484
1485
1486
 
# File 'lib/active_record/base.rb', line 1484

def sti_name
  store_full_sti_class ? name : name.demodulize
end

.table_exists? ⇒ Boolean

Indicates whether the table associated with this class exists

Returns:

  • (Boolean) 


1264
1265
1266
 
# File 'lib/active_record/base.rb', line 1264

def table_exists?
  connection.table_exists?(table_name)
end

.table_name ⇒ Object

Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending directly from ActiveRecord::Base. So if the hierarchy looks like: Reply < Message < ActiveRecord::Base, then Message is used to guess the table name even when called on Reply. The rules used to do the guess are handled by the Inflector class in Active Support, which knows almost all common English inflections. You can add new inflections in config/initializers/inflections.rb.

Nested classes are given table names prefixed by the singular form of the parent’s table name. Enclosing modules are not considered.

Examples

class Invoice < ActiveRecord::Base; end;
file                  class               table_name
invoice.rb            Invoice             invoices

class Invoice < ActiveRecord::Base; class Lineitem < ActiveRecord::Base; end; end;
file                  class               table_name
invoice.rb            Invoice::Lineitem   invoice_lineitems

module Invoice; class Lineitem < ActiveRecord::Base; end; end;
file                  class               table_name
invoice/lineitem.rb   Invoice::Lineitem   lineitems

Additionally, the class-level table_name_prefix is prepended and the table_name_suffix is appended. So if you have “myapp_” as a prefix, the table name guess for an Invoice class becomes “myapp_invoices”. Invoice::Lineitem becomes “myapp_invoice_lineitems”.

You can also overwrite this class method to allow for unguessable links, such as a Mouse class with a link to a “mice” table. Example:

class Mouse < ActiveRecord::Base
  set_table_name "mice"
end



1133
1134
1135
 
# File 'lib/active_record/base.rb', line 1133

def table_name
  reset_table_name
end

.update(id, attributes) ⇒ Object

Updates an object (or multiple objects) and saves it to the database, if validations pass. The resulting object is returned whether the object was saved successfully to the database or not.

Parameters

  • id - This should be the id or an array of ids to be updated.

  • attributes - This should be a hash of attributes to be set on the object, or an array of hashes.

Examples

# Updating one record:
Person.update(15, :user_name => 'Samuel', :group => 'expert')

# Updating multiple records:
people = { 1 => { "first_name" => "David" }, 2 => { "first_name" => "Jeremy" } }
Person.update(people.keys, people.values)



744
745
746
747
748
749
750
751
752
753
 
# File 'lib/active_record/base.rb', line 744

def update(id, attributes)
  if id.is_a?(Array)
    idx = -1
    id.collect { |one_id| idx += 1; update(one_id, attributes[idx]) }
  else
    object = find(id)
    object.update_attributes(attributes)
    object
  end
end

.update_all(updates, conditions = nil, options = {}) ⇒ Object

Updates all records with details given if they match a set of conditions supplied, limits and order can also be supplied. This method constructs a single SQL UPDATE statement and sends it straight to the database. It does not instantiate the involved models and it does not trigger Active Record callbacks.

Parameters

  • updates - A string of column and value pairs that will be set on any records that match conditions. This creates the SET clause of the generated SQL.

  • conditions - An SQL fragment like “administrator = 1” or [ “user_name = ?”, username ]. See conditions in the intro for more info.

  • options - Additional options are :limit and :order, see the examples for usage.

Examples

# Update all billing objects with the 3 different attributes given
Billing.update_all( "category = 'authorized', approved = 1, author = 'David'" )

# Update records that match our conditions
Billing.update_all( "author = 'David'", "title LIKE '%Rails%'" )

# Update records that match our conditions but limit it to 5 ordered by date
Billing.update_all( "author = 'David'", "title LIKE '%Rails%'",
                      :order => 'created_at', :limit => 5 )



827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/active_record/base.rb', line 827

def update_all(updates, conditions = nil, options = {})
  sql  = "UPDATE #{quoted_table_name} SET #{sanitize_sql_for_assignment(updates)} "

  scope = scope(:find)

  select_sql = ""
  add_conditions!(select_sql, conditions, scope)

  if options.has_key?(:limit) || (scope && scope[:limit])
    # Only take order from scope if limit is also provided by scope, this
    # is useful for updating a has_many association with a limit.
    add_order!(select_sql, options[:order], scope)

    add_limit!(select_sql, options, scope)
    sql.concat(connection.limited_update_conditions(select_sql, quoted_table_name, connection.quote_column_name(primary_key)))
  else
    add_order!(select_sql, options[:order], nil)
    sql.concat(select_sql)
  end

  connection.update(sql, "#{name} Update")
end

.update_counters(id, counters) ⇒ Object

A generic “counter updater” implementation, intended primarily to be used by increment_counter and decrement_counter, but which may also be useful on its own. It simply does a direct SQL update for the record with the given ID, altering the given hash of counters by the amount given by the corresponding value:

Parameters

  • id - The id of the object you wish to update a counter on or an Array of ids.

  • counters - An Array of Hashes containing the names of the fields to update as keys and the amount to update the field by as values.

Examples

# For the Post with id of 5, decrement the comment_count by 1, and
# increment the action_count by 1
Post.update_counters 5, :comment_count => -1, :action_count => 1
# Executes the following SQL:
# UPDATE posts
#    SET comment_count = comment_count - 1,
#        action_count = action_count + 1
#  WHERE id = 5

# For the Posts with id of 10 and 15, increment the comment_count by 1
Post.update_counters [10, 15], :comment_count => 1
# Executes the following SQL:
# UPDATE posts
#    SET comment_count = comment_count + 1,
#  WHERE id IN (10, 15)



948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/active_record/base.rb', line 948

def update_counters(id, counters)
  updates = counters.inject([]) { |list, (counter_name, increment)|
    sign = increment < 0 ? "-" : "+"
    list << "#{connection.quote_column_name(counter_name)} = COALESCE(#{connection.quote_column_name(counter_name)}, 0) #{sign} #{increment.abs}"
  }.join(", ")

  if id.is_a?(Array)
    ids_list = id.map {|i| quote_value(i)}.join(', ')
    condition = "IN  (#{ids_list})"
  else
    condition = "= #{quote_value(id)}"
  end

  update_all(updates, "#{connection.quote_column_name(primary_key)} #{condition}")
end

.verification_timeout ⇒ Object

Deprecated and no longer has any effect.



102
103
104
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 102

def verification_timeout
  ActiveSupport::Deprecation.warn("ActiveRecord::Base.verification_timeout has been deprecated and no longer has any effect. Please remove all references to verification_timeout.")
end

.verification_timeout=(flag) ⇒ Object

Deprecated and no longer has any effect.



107
108
109
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 107

def verification_timeout=(flag)
  ActiveSupport::Deprecation.warn("ActiveRecord::Base.verification_timeout= has been deprecated and no longer has any effect. Please remove all references to verification_timeout=.")
end

Instance Method Details

#==(comparison_object) ⇒ Object

Returns true if the comparison_object is the same object, or is of the same type and has the same id.



2815
2816
2817
2818
2819
2820
 
# File 'lib/active_record/base.rb', line 2815

def ==(comparison_object)
  comparison_object.equal?(self) ||
    (comparison_object.instance_of?(self.class) &&
      comparison_object.id == id &&
      !comparison_object.new_record?)
end

#[](attr_name) ⇒ Object

Returns the value of the attribute identified by attr_name after it has been typecast (for example, “2004-12-12” in a data column is cast to a date object, like Date.new(2004, 12, 12)). (Alias for the protected read_attribute method).



2702
2703
2704
 
# File 'lib/active_record/base.rb', line 2702

def [](attr_name)
  read_attribute(attr_name)
end

#[]=(attr_name, value) ⇒ Object

Updates the attribute identified by attr_name with the specified value. (Alias for the protected write_attribute method).



2708
2709
2710
 
# File 'lib/active_record/base.rb', line 2708

def []=(attr_name, value)
  write_attribute(attr_name, value)
end

#attribute_for_inspect(attr_name) ⇒ Object

Returns an #inspect-like string for the value of the attribute attr_name. String attributes are elided after 50 characters, and Date and Time attributes are returned in the :db format. Other attributes return the value of #inspect without modification.

person = Person.create!(:name => "David Heinemeier Hansson " * 3)

person.attribute_for_inspect(:name)
# => '"David Heinemeier Hansson David Heinemeier Hansson D..."'

person.attribute_for_inspect(:created_at)
# => '"2009-01-12 04:48:57"'



2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
 
# File 'lib/active_record/base.rb', line 2780

def attribute_for_inspect(attr_name)
  value = read_attribute(attr_name)

  if value.is_a?(String) && value.length > 50
    "#{value[0..50]}...".inspect
  elsif value.is_a?(Date) || value.is_a?(Time)
    %("#{value.to_s(:db)}")
  else
    value.inspect
  end
end

#attribute_names ⇒ Object

Returns an array of names for the attributes available on this object sorted alphabetically.



2805
2806
2807
 
# File 'lib/active_record/base.rb', line 2805

def attribute_names
  @attributes.keys.sort
end

#attribute_present?(attribute) ⇒ Boolean

Returns true if the specified attribute has been set by the user or by a database load and is neither nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).

Returns:

  • (Boolean) 


2794
2795
2796
2797
 
# File 'lib/active_record/base.rb', line 2794

def attribute_present?(attribute)
  value = read_attribute(attribute)
  !value.blank?
end

#attributes ⇒ Object

Returns a hash of all the attributes with their names as keys and the values of the attributes as values.



2752
2753
2754
2755
2756
2757
 
# File 'lib/active_record/base.rb', line 2752

def attributes
  self.attribute_names.inject({}) do |attrs, name|
    attrs[name] = read_attribute(name)
    attrs
  end
end

#attributes=(new_attributes, guard_protected_attributes = true) ⇒ Object

Allows you to set all the attributes at once by passing in a hash with keys matching the attribute names (which again matches the column names).

If guard_protected_attributes is true (the default), then sensitive attributes can be protected from this form of mass-assignment by using the attr_protected macro. Or you can alternatively specify which attributes can be accessed with the attr_accessible macro. Then all the attributes not included in that won’t be allowed to be mass-assigned.

class User < ActiveRecord::Base
  attr_protected :is_admin
end

user = User.new
user.attributes = { :username => 'Phusion', :is_admin => true }
user.username   # => "Phusion"
user.is_admin?  # => false

user.send(:attributes=, { :username => 'Phusion', :is_admin => true }, false)
user.is_admin?  # => true



2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
 
# File 'lib/active_record/base.rb', line 2732

def attributes=(new_attributes, guard_protected_attributes = true)
  return if new_attributes.nil?
  attributes = new_attributes.dup
  attributes.stringify_keys!

  multi_parameter_attributes = []
  attributes = remove_attributes_protected_from_mass_assignment(attributes) if guard_protected_attributes

  attributes.each do |k, v|
    if k.include?("(")
      multi_parameter_attributes << [ k, v ]
    else
      respond_to?(:"#{k}=") ? send(:"#{k}=", v) : raise(UnknownAttributeError, "unknown attribute: #{k}")
    end
  end

  assign_multiparameter_attributes(multi_parameter_attributes)
end

#attributes_before_type_cast ⇒ Object

Returns a hash of attributes before typecasting and deserialization.



2760
2761
2762
2763
2764
2765
 
# File 'lib/active_record/base.rb', line 2760

def attributes_before_type_cast
  self.attribute_names.inject({}) do |attrs, name|
    attrs[name] = read_attribute_before_type_cast(name)
    attrs
  end
end

#becomes(klass) ⇒ Object

Returns an instance of the specified klass with the attributes of the current record. This is mostly useful in relation to single-table inheritance structures where you want a subclass to appear as the superclass. This can be used along with record identification in Action Pack to allow, say, Client < Company to do something like render :partial => @client.becomes(Company) to render that instance using the companies/company partial instead of clients/client.

Note: The new instance will share a link to the same attributes as the original class. So any change to the attributes in either instance will affect the other.



2607
2608
2609
2610
2611
2612
2613
 
# File 'lib/active_record/base.rb', line 2607

def becomes(klass)
  returning klass.new do |became|
    became.instance_variable_set("@attributes", @attributes)
    became.instance_variable_set("@attributes_cache", @attributes_cache)
    became.instance_variable_set("@new_record", new_record?)
  end
end

#cache_key ⇒ Object

Returns a cache key that can be used to identify this record.

Examples

Product.new.cache_key     # => "products/new"
Product.find(5).cache_key # => "products/5" (updated_at not available)
Person.find(5).cache_key  # => "people/5-20071224150000" (updated_at available)



2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
 
# File 'lib/active_record/base.rb', line 2491

def cache_key
  case
  when new_record?
    "#{self.class.model_name.cache_key}/new"
  when timestamp = self[:updated_at]
    "#{self.class.model_name.cache_key}/#{id}-#{timestamp.to_s(:number)}"
  else
    "#{self.class.model_name.cache_key}/#{id}"
  end
end

#clone ⇒ Object

Returns a clone of the record that hasn’t been assigned an id yet and is treated as a new record. Note that this is a “shallow” clone: it copies the object’s attributes only, not its associations. The extent of a “deep” clone is application-specific and is therefore left to the application to implement according to its need.



2592
2593
2594
2595
2596
2597
2598
 
# File 'lib/active_record/base.rb', line 2592

def clone
  attrs = clone_attributes(:read_attribute_before_type_cast)
  attrs.delete(self.class.primary_key)
  record = self.class.new
  record.send :instance_variable_set, '@attributes', attrs
  record
end

#colorize_logging ⇒ Object

:singleton-method: Determines whether to use ANSI codes to colorize the logging statements committed by the connection adapter. These colors make it much easier to overview things during debugging (when used through a reader like tail and on a black background), but may complicate matters if you use software like syslog. This is true, by default.



487
 
# File 'lib/active_record/base.rb', line 487

cattr_accessor :colorize_logging, :instance_writer => false

#column_for_attribute(name) ⇒ Object

Returns the column object for the named attribute.



2810
2811
2812
 
# File 'lib/active_record/base.rb', line 2810

def column_for_attribute(name)
  self.class.columns_hash[name.to_s]
end

#configurations ⇒ Object

:singleton-method: Contains the database configuration - as is typically stored in config/database.yml - as a Hash.

For example, the following database.yml…

development:
  adapter: sqlite3
  database: db/development.sqlite3

production:
  adapter: sqlite3
  database: db/production.sqlite3

…would result in ActiveRecord::Base.configurations to look like this:

{
   'development' => {
      'adapter'  => 'sqlite3',
      'database' => 'db/development.sqlite3'
   },
   'production' => {
      'adapter'  => 'sqlite3',
      'database' => 'db/production.sqlite3'
   }
}



447
 
# File 'lib/active_record/base.rb', line 447

cattr_accessor :configurations, :instance_writer => false

#connection ⇒ Object

Returns the connection currently associated with the class. This can also be used to “borrow” the connection to do database work that isn’t easily done without going straight to SQL.



19
20
21
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 19

def connection
  self.class.connection
end

#connection_handler ⇒ Object

:singleton-method: The connection handler



13
 
# File 'lib/active_record/connection_adapters/abstract/connection_specification.rb', line 13

cattr_accessor :connection_handler, :instance_writer => false

#decrement(attribute, by = 1) ⇒ Object

Initializes attribute to zero if nil and subtracts the value passed as by (default is 1). The decrement is performed directly on the underlying attribute, no setter is invoked. Only makes sense for number-based attributes. Returns self.



2656
2657
2658
2659
2660
 
# File 'lib/active_record/base.rb', line 2656

def decrement(attribute, by = 1)
  self[attribute] ||= 0
  self[attribute] -= by
  self
end

#decrement!(attribute, by = 1) ⇒ Object

Wrapper around decrement that saves the record. This method differs from its non-bang version in that it passes through the attribute setter. Saving is not subjected to validation checks. Returns true if the record could be saved.



2666
2667
2668
 
# File 'lib/active_record/base.rb', line 2666

def decrement!(attribute, by = 1)
  decrement(attribute, by).update_attribute(attribute, self[attribute])
end

#default_timezone ⇒ Object

:singleton-method: Determines whether to use Time.local (using :local) or Time.utc (using :utc) when pulling dates and times from the database. This is set to :local by default.



494
 
# File 'lib/active_record/base.rb', line 494

cattr_accessor :default_timezone, :instance_writer => false

#delete ⇒ Object

Deletes the record in the database and freezes this instance to reflect that no changes should be made (since they can’t be persisted). Returns the frozen instance.

The row is simply removed with a SQL DELETE statement on the record’s primary key, and no callbacks are executed.

To enforce the object’s before_destroy and after_destroy callbacks, Observer methods, or any :dependent association options, use #destroy.



2568
2569
2570
2571
 
# File 'lib/active_record/base.rb', line 2568

def delete
  self.class.delete(id) unless new_record?
  freeze
end

#destroy ⇒ Object

Deletes the record in the database and freezes this instance to reflect that no changes should be made (since they can’t be persisted).



2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
 
# File 'lib/active_record/base.rb', line 2575

def destroy
  unless new_record?
    connection.delete(
      "DELETE FROM #{self.class.quoted_table_name} " +
      "WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quoted_id}",
      "#{self.class.name} Destroy"
    )
  end

  freeze
end

#eql?(comparison_object) ⇒ Boolean

Delegates to ==

Returns:

  • (Boolean) 


2823
2824
2825
 
# File 'lib/active_record/base.rb', line 2823

def eql?(comparison_object)
  self == (comparison_object)
end

#freeze ⇒ Object

Freeze the attributes hash such that associations are still accessible, even on destroyed records.



2834
2835
2836
 
# File 'lib/active_record/base.rb', line 2834

def freeze
  @attributes.freeze; self
end

#frozen? ⇒ Boolean

Returns true if the attributes hash has been frozen.

Returns:

  • (Boolean) 


2839
2840
2841
 
# File 'lib/active_record/base.rb', line 2839

def frozen?
  @attributes.frozen?
end

#has_attribute?(attr_name) ⇒ Boolean

Returns true if the given attribute is in the attributes hash

Returns:

  • (Boolean) 


2800
2801
2802
 
# File 'lib/active_record/base.rb', line 2800

def has_attribute?(attr_name)
  @attributes.has_key?(attr_name.to_s)
end

#hash ⇒ Object

Delegates to id in order to allow two records of the same type and id to work with something like:

[ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]



2829
2830
2831
 
# File 'lib/active_record/base.rb', line 2829

def hash
  id.hash
end

#id ⇒ Object

A model instance’s primary key is always available as model.id whether you name it the default ‘id’ or set it to something else.



2447
2448
2449
2450
2451
2452
2453
2454
2455
 
# File 'lib/active_record/base.rb', line 2447

def id
  attr_name = self.class.primary_key
  column = column_for_attribute(attr_name)

  self.class.send(:define_read_method, :id, attr_name, column)
  # now that the method exists, call it
  self.send attr_name.to_sym

end

#id=(value) ⇒ Object

Sets the primary ID.



2511
2512
2513
 
# File 'lib/active_record/base.rb', line 2511

def id=(value)
  write_attribute(self.class.primary_key, value)
end

#id_before_type_cast ⇒ Object

:nodoc:



2502
2503
2504
 
# File 'lib/active_record/base.rb', line 2502

def id_before_type_cast #:nodoc:
  read_attribute_before_type_cast(self.class.primary_key)
end

#increment(attribute, by = 1) ⇒ Object

Initializes attribute to zero if nil and adds the value passed as by (default is 1). The increment is performed directly on the underlying attribute, no setter is invoked. Only makes sense for number-based attributes. Returns self.



2639
2640
2641
2642
2643
 
# File 'lib/active_record/base.rb', line 2639

def increment(attribute, by = 1)
  self[attribute] ||= 0
  self[attribute] += by
  self
end

#increment!(attribute, by = 1) ⇒ Object

Wrapper around increment that saves the record. This method differs from its non-bang version in that it passes through the attribute setter. Saving is not subjected to validation checks. Returns true if the record could be saved.



2649
2650
2651
 
# File 'lib/active_record/base.rb', line 2649

def increment!(attribute, by = 1)
  increment(attribute, by).update_attribute(attribute, self[attribute])
end

#inspect ⇒ Object

Returns the contents of the record as a nicely formatted string.



2855
2856
2857
2858
2859
2860
2861
2862
 
# File 'lib/active_record/base.rb', line 2855

def inspect
  attributes_as_nice_string = self.class.column_names.collect { |name|
    if has_attribute?(name) || new_record?
      "#{name}: #{attribute_for_inspect(name)}"
    end
  }.compact.join(", ")
  "#<#{self.class} #{attributes_as_nice_string}>"
end

#logger ⇒ Object

:singleton-method: Accepts a logger conforming to the interface of Log4r or the default Ruby 1.8+ Logger class, which is then passed on to any new database connections made and which can be retrieved on both a class and instance level by calling logger.



396
 
# File 'lib/active_record/base.rb', line 396

cattr_accessor :logger, :instance_writer => false

#new_record? ⇒ Boolean

Returns true if this object hasn’t been saved yet – that is, a record for the object doesn’t exist yet; otherwise, returns false.

Returns:

  • (Boolean) 


2516
2517
2518
 
# File 'lib/active_record/base.rb', line 2516

def new_record?
  @new_record || false
end

#pluralize_table_names ⇒ Object

:singleton-method: Indicates whether table names should be the pluralized versions of the corresponding class names. If true, the default table name for a Product class will be products. If false, it would just be product. See table_name for the full rules on table/class naming. This is true, by default.



479
 
# File 'lib/active_record/base.rb', line 479

cattr_accessor :pluralize_table_names, :instance_writer => false

#primary_key_prefix_type ⇒ Object

:singleton-method: Accessor for the prefix type that will be prepended to every primary key column name. The options are :table_name and :table_name_with_underscore. If the first is specified, the Product class will look for “productid” instead of “id” as the primary column. If the latter is specified, the Product class will look for “product_id” instead of “id”. Remember that this is a global setting for all Active Records.



456
 
# File 'lib/active_record/base.rb', line 456

cattr_accessor :primary_key_prefix_type, :instance_writer => false

#quoted_id ⇒ Object

:nodoc:



2506
2507
2508
 
# File 'lib/active_record/base.rb', line 2506

def quoted_id #:nodoc:
  quote_value(id, column_for_attribute(self.class.primary_key))
end

#readonly! ⇒ Object

Marks this record as read only.



2850
2851
2852
 
# File 'lib/active_record/base.rb', line 2850

def readonly!
  @readonly = true
end

#readonly? ⇒ Boolean

Returns true if the record is read only. Records loaded through joins with piggy-back attributes will be marked as read only since they cannot be saved.

Returns:

  • (Boolean) 


2845
2846
2847
 
# File 'lib/active_record/base.rb', line 2845

def readonly?
  defined?(@readonly) && @readonly == true
end

#reload(options = nil) ⇒ Object

Reloads the attributes of this object from the database. The optional options argument is passed to find when reloading so you may do e.g. record.reload(:lock => true) to reload the same record with an exclusive row lock.



2691
2692
2693
2694
2695
2696
2697
 
# File 'lib/active_record/base.rb', line 2691

def reload(options = nil)
  clear_aggregation_cache
  clear_association_cache
  @attributes.update(self.class.find(self.id, options).instance_variable_get('@attributes'))
  @attributes_cache = {}
  self
end

#save ⇒ Object

:call-seq:

save(perform_validation = true)

Saves the model.

If the model is new a record gets created in the database, otherwise the existing record gets updated.

If perform_validation is true validations run. If any of them fail the action is cancelled and save returns false. If the flag is false validations are bypassed altogether. See ActiveRecord::Validations for more information.

There’s a series of callbacks associated with save. If any of the before_* callbacks return false the action is cancelled and save returns false. See ActiveRecord::Callbacks for further details.



2537
2538
2539
 
# File 'lib/active_record/base.rb', line 2537

def save
  create_or_update
end

#save! ⇒ Object

Saves the model.

If the model is new a record gets created in the database, otherwise the existing record gets updated.

With save! validations always run. If any of them fail ActiveRecord::RecordInvalid gets raised. See ActiveRecord::Validations for more information.

There’s a series of callbacks associated with save!. If any of the before_* callbacks return false the action is cancelled and save! raises ActiveRecord::RecordNotSaved. See ActiveRecord::Callbacks for further details.



2554
2555
2556
 
# File 'lib/active_record/base.rb', line 2554

def save!
  create_or_update || raise(RecordNotSaved)
end

#schema_format ⇒ Object

:singleton-method: Specifies the format to use when dumping the database schema with Rails’ Rakefile. If :sql, the schema is dumped as (potentially database- specific) SQL statements. If :ruby, the schema is dumped as an ActiveRecord::Schema file which can be loaded into any database that supports migrations. Use :ruby if you want to have different database adapters for, e.g., your development and test environments.



505
 
# File 'lib/active_record/base.rb', line 505

cattr_accessor :schema_format , :instance_writer => false

#table_name_prefix ⇒ Object

:singleton-method: Accessor for the name of the prefix string to prepend to every table name. So if set to “basecamp_”, all table names will be named like “basecamp_projects”, “basecamp_people”, etc. This is a convenient way of creating a namespace for tables in a shared database. By default, the prefix is the empty string.



464
 
# File 'lib/active_record/base.rb', line 464

cattr_accessor :table_name_prefix, :instance_writer => false

#table_name_suffix ⇒ Object

:singleton-method: Works like table_name_prefix, but appends instead of prepends (set to “_basecamp” gives “projects_basecamp”, “people_basecamp”). By default, the suffix is the empty string.



471
 
# File 'lib/active_record/base.rb', line 471

cattr_accessor :table_name_suffix, :instance_writer => false

#timestamped_migrations ⇒ Object

:singleton-method: Specify whether or not to use timestamps for migration numbers



511
 
# File 'lib/active_record/base.rb', line 511

cattr_accessor :timestamped_migrations , :instance_writer => false

#to_param ⇒ Object

Returns a String, which Action Pack uses for constructing an URL to this object. The default implementation returns this record’s id as a String, or nil if this record’s unsaved.

For example, suppose that you have a User model, and that you have a map.resources :users route. Normally, user_path will construct a path with the user object’s ‘id’ in it:

user = User.find_by_name('Phusion')
user_path(user)  # => "/users/1"

You can override to_param in your model to make user_path construct a path using the user’s name instead of the user’s id:

class User < ActiveRecord::Base
  def to_param  # overridden
    name
  end
end

user = User.find_by_name('Phusion')
user_path(user)  # => "/users/Phusion"



2479
2480
2481
2482
 
# File 'lib/active_record/base.rb', line 2479

def to_param
  # We can't use alias_method here, because method 'id' optimizes itself on the fly.
  (id = self.id) ? id.to_s : nil # Be sure to stringify the id for routes
end

#toggle(attribute) ⇒ Object

Assigns to attribute the boolean opposite of attribute?. So if the predicate returns true the attribute will become false. This method toggles directly the underlying value without calling any setter. Returns self.



2674
2675
2676
2677
 
# File 'lib/active_record/base.rb', line 2674

def toggle(attribute)
  self[attribute] = !send("#{attribute}?")
  self
end

#toggle!(attribute) ⇒ Object

Wrapper around toggle that saves the record. This method differs from its non-bang version in that it passes through the attribute setter. Saving is not subjected to validation checks. Returns true if the record could be saved.



2683
2684
2685
 
# File 'lib/active_record/base.rb', line 2683

def toggle!(attribute)
  toggle(attribute).update_attribute(attribute, self[attribute])
end

#update_attribute(name, value) ⇒ Object

Updates a single attribute and saves the record without going through the normal validation procedure. This is especially useful for boolean flags on existing records. The regular update_attribute method in Base is replaced with this when the validations module is mixed in, which it is by default.



2618
2619
2620
2621
 
# File 'lib/active_record/base.rb', line 2618

def update_attribute(name, value)
  send(name.to_s + '=', value)
  save(false)
end

#update_attributes(attributes) ⇒ Object

Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will fail and false will be returned.



2625
2626
2627
2628
 
# File 'lib/active_record/base.rb', line 2625

def update_attributes(attributes)
  self.attributes = attributes
  save
end

#update_attributes!(attributes) ⇒ Object

Updates an object just like Base.update_attributes but calls save! instead of save so an exception is raised if the record is invalid.



2631
2632
2633
2634
 
# File 'lib/active_record/base.rb', line 2631

def update_attributes!(attributes)
  self.attributes = attributes
  save!
end