- Creation
- Conditions
- Overwriting default accessors
- Attribute query methods
- Accessing attributes before they have been typecasted
- Dynamic attribute-based finders
- Saving arrays, hashes, and other non-mappable objects in text columns
- Single table inheritance
- Connection to multiple databases in different models
- Exceptions
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 link: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 })
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 * 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_ or find_all_by_, so you get finders like Person.find_by_user_name, Person.find_all_by_last_name, 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").
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. 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")
Use the find_or_initialize_by_ finder if you want to return a new record without saving it first. 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 descendent 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/singleTableInherit...
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 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.
- StatementInvalid — the database server rejected the SQL statement. The precise error is added in the message. Either the record with the given ID doesn’t exist or the record didn’t meet the additional restrictions.
- 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.</attribute>
| Classes | |
|---|---|
| ConnectionSpecification | |
| Constants | |
|---|---|
| VALID_ |
|
| Aliases | |
|---|---|
| inheritance_ |
|
| primary_ |
|
| sanitize_ |
|
| sanitize_ |
|
| sanitize_ |
|
| sequence_ |
|
| table_ |
|
| Public Attributes | |
|---|---|
| abstract_ |
Set this to true if this is an abstract class (see #abstract_class?). |
| Public Methods | |
|---|---|
| == | Returns true if the comparison_object is the same object, or is of the same type and has the same id. |
| === | Overwrite the default class equality method to provide support for association proxies. |
| [] | 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). |
| []= | Updates the attribute identified by attr_name with the specified value. (Alias for the protected write_attribute method). |
| abstract_ |
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. |
| accessible_ |
Returns an array of all the attributes that have been made accessible to mass-assignment. |
| active_ |
|
| allow_ |
set concurrency support flag (not thread safe, like most of the methods in this file) |
| attr_ |
Similar to the attr_protected macro, this protects attributes of your model from mass-assignment, such as new(attributes) and attributes=(attributes) however, it does it in the opposite way. This locks all attributes and only allows access to the attributes specified. Assignment to attributes not in this list will be ignored and need to be set using the direct writer methods instead. This is meant to protect sensitive attributes from being overwritten by URL/form hackers. If you’d rather start from an all-open default and restrict attributes as needed, have a look at attr_protected. |
| attr_ |
Attributes named in this macro are protected from mass-assignment, such as new(attributes) and attributes=(attributes). Their assignment will simply be ignored. Instead, you can use the direct writer methods to do assignment. This is meant to protect sensitive attributes from being overwritten by URL/form hackers. Example: |
| attr_ |
Attributes listed as readonly can be set for a new record, but will be ignored in database updates afterwards. |
| attribute_ |
Format attributes nicely for inspect. |
| attribute_ |
Returns an array of names for the attributes available on this object sorted alphabetically. |
| attribute_ |
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). |
| attributes | Returns a hash of all the attributes with their names as keys and clones of their objects as values. |
| attributes= | 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). 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. |
| attributes_ |
Returns a hash of cloned attributes before typecasting and deserialization. |
| base_ |
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. |
| becomes | 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. |
| benchmark | Log and benchmark multiple statements in a single block. Example: |
| class_ |
Turns the table_name back into a class name following the reverse rules of table_name. |
| clear_ |
|
| clear_ |
Clears the cache which maps classes to connections. |
| clear_ |
Clears the cache which maps classes |
| clone | 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. |
| column_ |
Returns the column object for the named attribute. |
| column_ |
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. |
| column_ |
Returns an array of column names as strings. |
| columns | Returns an array of column objects for the table associated with this class. |
| columns_ |
Returns a hash of column objects for the table associated with this class. |
| connected? | Returns true if a connection that’s accessible to this class has already been opened. |
| connection | 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. |
| connection | 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. |
| connection= | Set the connection for the class. |
| content_ |
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. |
| count_ |
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. |
| create | 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. |
| decrement | Initializes the attribute to zero if nil and subtracts one. Only makes sense for number-based attributes. Returns self. |
| decrement! | Decrements the attribute and saves the record. |
| decrement_ |
Decrement a number field by one, usually representing a count. |
| delete | Delete an object (or multiple objects) where the id given matches the primary_key. A SQL DELETE command is executed on the database which means that no callbacks are fired off running this. This is an efficient method of deleting records that don’t need cleaning up after or other actions to be taken. |
| delete_ |
Deletes the records matching conditions without instantiating the records first, and hence not calling the destroy method and invoking callbacks. This is a single SQL query, much more efficient than destroy_all. |
| descends_ |
True if this isn’t a concrete subclass needing a STI type condition. |
| destroy | 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. |
| destroy | Deletes the record in the database and freezes this instance to reflect that no changes should be made (since they can’t be persisted). |
| destroy_ |
Destroys the records matching conditions by instantiating each record and calling the destroy method. This means at least 2*N database queries to destroy N records, so avoid destroy_all if you are deleting many records. If you want to simply delete records without worrying about dependent associations or callbacks, use the much faster delete_all method instead. |
| eql? | Delegates to == |
| establish_ |
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): |
| exists? | Checks whether a record exists in the database that matches conditions given. These conditions can either be a single integer representing a primary key id to be found, or a condition to be matched like using ActiveRecord#find. |
| find | Find operates with three different retrieval approaches: |
| find_ |
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. |
| finder_ |
|
| freeze | Freeze the attributes hash such that associations are still accessible, even on destroyed records. |
| frozen? | Returns true if the attributes hash has been frozen. |
| has_ |
Returns true if the given attribute is in the attributes hash |
| hash | Delegates to id in order to allow two records of the same type and id to work with something like: |
| human_ |
Transforms attribute key names into a more humane format, such as "First name" instead of "first_name". Example: |
| id | 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. |
| id= | Sets the primary ID. |
| id_ |
|
| increment | Initializes the attribute to zero if nil and adds one. Only makes sense for number-based attributes. Returns self. |
| increment! | Increments the attribute and saves the record. |
| increment_ |
Increment a number field by one, usually representing a count. |
| inheritance_ |
Defines the column name for use with single table inheritance — can be set in subclasses like so: self.inheritance_column = "type_id" |
| inherited | |
| inspect | Returns a string like ‘Post id:integer, title:string, body:text’ |
| inspect | Returns the contents of the record as a nicely formatted string. |
| log_ |
connection state logging |
| mysql_ |
Establishes a connection to the database that’s used by all Active Record objects. |
| new | 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. |
| new_ |
Returns true if this object hasn’t been saved yet — that is, a record for the object doesn’t exist yet. |
| postgresql_ |
Establishes a connection to the database that’s used by all Active Record objects |
| primary_ |
Defines the primary key field — can be overridden in subclasses. Overwriting will negate any effect of the primary_key_prefix_type setting, though. |
| protected_ |
Returns an array of all the attributes that have been protected from mass-assignment. |
| quote_ |
|
| quoted_ |
|
| readonly! | Marks this record as read only. |
| readonly? | 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. |
| readonly_ |
Returns an array of all the attributes that have been specified as readonly. |
| reload | 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. |
| remove_ |
Remove the connection for this class. This will close the active connection and the defined connection (if they exist). The result can be used as an argument for establish_connection, for easily re-establishing the connection. |
| require_ |
|
| reset_ |
Resets all the cached information about columns, which will cause them to be reloaded on the next request. |
| reset_ |
|
| reset_ |
|
| reset_ |
|
| reset_ |
|
| reset_ |
|
| retrieve_ |
Locate the connection of the nearest super class. This can be an active or defined connection: if it is the latter, it will be opened and set as the active connection for the class it was defined for (not necessarily the current class). |
| sanitize | Used to sanitize objects before they’re used in an SQL SELECT statement. Delegates to connection.quote. |
| save | |
| save! | Attempts to save the record, but instead of just returning false if it couldn’t happen, it raises a RecordNotSaved exception |
| sequence_ |
Lazy-set the sequence name to the connection’s default. This method is only ever called once since set_sequence_name overrides it. |
| serialize | 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. |
| serialized_ |
Returns a hash of all the attributes that have been specified for serialization as keys and their class restriction as values. |
| set_ |
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. |
| set_ |
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. |
| set_ |
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. |
| set_ |
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. |
| silence | Silences the logger for the duration of the block. |
| single_ |
|
| sqlite3_ |
sqlite3 adapter reuses sqlite_connection. |
| sqlite_ |
Establishes a connection to the database that’s used by all Active Record objects |
| table_ |
Indicates whether the table associated with this class exists |
| table_ |
Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending directly from ActiveRecord. So if the hierarchy looks like: Reply < Message < ActiveRecord, 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. |
| thread_ |
Retrieve the connection cache. |
| to_ |
Enables Active Record objects to be used as URL parameters in Action Pack automatically. |
| toggle | Turns an attribute that’s currently true into false and vice versa. Returns self. |
| toggle! | Toggles the attribute and saves the record. |
| update | 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. |
| update_ |
Updates all records with details given if they match a set of conditions supplied, limits and order can also be supplied. |
| update_ |
Updates a single attribute and saves the record. This is especially useful for boolean flags on existing records. Note: This method is overwritten by the Validation module that’ll make sure that updates made with this method aren’t subjected to validation checks. Hence, attributes can be updated even if the full object isn’t valid. |
| update_ |
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. |
| update_ |
Updates an object just like Base.update_attributes but calls save! instead of save so an exception is raised if the record is invalid. |
| update_ |
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: |
| verify_ |
Verify active connections. |
| Protected Methods | |
|---|---|
| class_ |
Returns the name of the class descending directly from ActiveRecord in the inheritance hierarchy. |
| class_ |
Returns the class descending directly from ActiveRecord in the inheritance hierarchy. |
| compute_ |
Returns the class type of the record using the current module as a prefix. So descendents of MyApp::Business::Account would appear as MyApp::Business::AccountSubclass. |
| current_ |
|
| encode_ |
|
| expand_ |
|
| quote_ |
|
| raise_ |
|
| replace_ |
|
| replace_ |
|
| sanitize_ |
Accepts an array of conditions. The array has each value sanitized and interpolated into the sql statement. |
| sanitize_ |
Accepts an array, hash, or string of sql conditions and sanitizes them into a valid SQL fragment for a SET clause. |
| sanitize_ |
Accepts an array, hash, or string of sql conditions and sanitizes them into a valid SQL fragment for a WHERE clause. |
| sanitize_ |
Sanitizes a hash of attribute/value pairs into SQL conditions for a SET clause. |
| sanitize_ |
Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause. |
| scope | Retrieve the scope for the given method and optional key. |
| scoped? | Test whether the given method and optional key are scoped. |
| set_ |
|
| single_ |
|
| subclasses | |
| thread_ |
|
| validate_ |
|
| with_ |
Works like with_scope, but discards any nested properties. |
| with_ |
Scope parameters to method calls within the block. Takes a hash of method_name => parameters hash. method_name may be :find or :create. :find parameters may include the :conditions, :joins, :include, :offset, :limit, and :readonly options. :create parameters are an attributes hash. |
| Private Methods | |
|---|---|
| add_ |
Adds a sanitized version of conditions to the sql string. Note that the passed-in sql string is changed. The optional scope argument is for the current :find scope. |
| add_ |
|
| add_ |
The optional scope argument is for the current :find scope. |
| add_ |
The optional scope argument is for the current :find scope. |
| add_ |
The optional scope argument is for the current :find scope. The :lock option has precedence over a scoped :lock. |
| add_ |
|
| all_ |
|
| assign_ |
Instantiates objects for all attribute classes that needs more than one constructor parameter. This is done by calling new on the column type or aggregation type (through composed_of) object with these parameters. So having the pairs written_on(1) = "2004", written_on(2) = "6", written_on(3) = "24", will instantiate written_on (a date type) with Date.new("2004", "6", "24"). You can also specify a typecast character in the parentheses to have the parameters typecasted before they’re used in the constructor. Use i for Fixnum, f for Float, s for String, and a for Array. If all the values for a given attribute are empty, the attribute will be set to nil. |
| attribute_ |
|
| attributes_ |
Initializes the attributes array with keys matching the columns from the linked table and the values matching the corresponding default value of that column, so that a new instance, or one populated from a passed-in Hash, still has all the attributes that instances loaded from the database would. |
| attributes_ |
The primary key and inheritance column can never be set by mass-assignment for security reasons. |
| attributes_ |
Returns a copy of the attributes hash where all the values have been safely quoted for use in an SQL statement. |
| clear_ |
|
| clear_ |
|
| clone_ |
|
| clone_ |
|
| comma_ |
Returns a comma-separated pair list, like "key1 = val1, key2 = val2". |
| construct_ |
|
| construct_ |
|
| convert_ |
|
| create | Creates a record with values matching those of the instance attributes and returns its id. |
| create_ |
|
| define_ |
Defines an "attribute" method (like #inheritance_column or #table_name). A new (class) method will be created with the given name. If a value is specified, the new method will return that value (as a string). Otherwise, the given block will be used to compute the value of the method. |
| determine_ |
|
| determine_ |
|
| ensure_ |
Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord descendent. Considering the hierarchy Reply < Message < ActiveRecord, this makes it possible to do Reply.new without having to set Reply = "Reply" yourself. No such attribute would be set for objects of the Message class in that example. |
| execute_ |
Includes an ugly hack for Time.local instead of Time.new because the latter is reserved by Time itself. |
| expand_ |
Interpret Array and Hash as conditions and anything else as an id. |
| extract_ |
|
| extract_ |
|
| find_ |
|
| find_ |
|
| find_ |
|
| find_ |
|
| find_ |
|
| find_ |
|
| instantiate | Finder methods must instantiate through this method to work with the single-table inheritance model that makes it possible to create objects of different types from the same table. |
| interpolate_ |
Interpolate custom sql string in instance context. Optional record argument is meant for custom insert_sql. |
| merge_ |
Merges includes so that the result is a valid include |
| method_ |
Enables dynamic finders like find_by_user_name(user_name) and find_by_user_name_and_password(user_name, password) that are turned into find(:first, :conditions => ["user_name = ?", user_name]) and find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password]) respectively. Also works for find(:all) by using find_all_by_amount(50) that is turned into find(:all, :conditions => ["amount = ?", 50]). |
| object_ |
|
| parse_ |
|
| quote_ |
|
| quote_ |
Quote strings appropriately for SQL statements. |
| quoted_ |
|
| quoted_ |
|
| quoted_ |
|
| remove_ |
|
| remove_ |
Removes attributes which have been marked as readonly. |
| remove_ |
Remove stale threads from the cache. |
| safe_ |
Object#to_a is deprecated, though it does have the desired behavior |
| type_ |
|
| type_ |
|
| type_ |
Nest the type name in the same module as this class. Bar is "MyApp::Business::Bar" relative to MyApp::Business::Foo |
| undecorated_ |
Guesses the table name, but does not decorate it with prefix and suffix information. |
| update | Updates the associated record with values matching those of the instance attributes. Returns the number of affected rows. |
<code/>and<pre/>for code samples.