Returns actual model table column amount (is grepped from db).

If somewhy you define model with custom table name after the place where adapter is used the first time - manually invoke this method anywhere after table name definition.

Initializes new object based on given arguments.

after_initialize callbacks are invoked. If model mapping allows creating an object without passing any argument - relevant #build method will be generated for such model.

Alias for .new.

Creates an object based on given values and saves it to the database, if validation pass.

The resulting object is return whether it was saved to the database or not.

Contact.create({:name => "Jennifer"})
Contact.create({name: "Jennifer"})

Creates an object based on an empty hash and saves it to the database, if validation pass.

The resulting object is return whether it was saved to the database or not.

Contact.create

Creates an object based on values and saves it to the database, if validation pass.

The resulting object is return whether it was saved to the database or not.

Contact.create(name: "Jennifer")

Creates an object based on values and saves it to the database, if validation pass.

Raises an RecordInvalid error if validation fail, unlike .create.

Contact.create!({:name => "Jennifer"})
Contact.create!({name: "Jennifer"})

Creates an object based on empty hash and saves it to the database, if validation pass.

Raises an RecordInvalid error if validation fail, unlike .create.

Contact.create!

Creates an object based on values and saves it to the database, if validation pass.

Raises an RecordInvalid error if validation fail, unlike .create.

Contact.create!(name: "Jennifer")

Deletes records by given ids.

Deletes records by given ids.

Destroys records by given ids.

All #destroy callbacks will be invoked for each record. All records are loaded in batches.

Contact.destroy(1, 2, 3)
Contact.destroy([1, 2, 3])

Destroys records by given ids.

All #destroy callbacks will be invoked for each record. All records are loaded in batches.

Contact.destroy(1, 2, 3)
Contact.destroy([1, 2, 3])

Returns record by given primary field or nil otherwise.

Contact.find(-1) # => nil

Returns record by given primary field or raises Jennifer::RecordNotFound exception otherwise.

Contact.find!(-1) # Jennifer::RecordNotFound

Sets custom model foreign key name.

class User < Jennifer::Model::Base
  foreign_key_name :client_id
end

Returns model foreign key name.

Returns whether model has a table.

NOTE shouldn't be used outside of tests.

Performs bulk import of given collection.

Any callback is ignored.

User.import([
  User.new({name: "John"}),
  User.new({name: "Fahad"}),
])

Returns array of all non-abstract subclasses of Jennifer::Model::Base.

Jennifer::Model::Base.models # => [Contact, Address, User]

Performs bulk import of given collection while ignoring models that would cause a duplicate value of any UNIQUE index on given unique_fields.

Some RDBMS (like MySQL) doesn't require specifying exact constraint to be violated, therefore unique_fields argument by default is [] of String.

Any callback is ignored.

Order.create({:uid => 123})
Order.upsert([
  Order.new({:uid => 123}),
  Order.new({:uid => 321}),
])

Performs table lock for current model's table.

Returns named tuple of all model fields to insert.

NOTE internal method

Returns named tuple of all fields should be saved (because they are changed).

NOTE internal method

Returns whether any field was changed. If field again got first value - true anyway will be returned.

user.name # => John
user.name = "Bill"
user.changed? # => true
user.name = "John"
user.changed? # => true

Hash of changed columns and their new values.

Deletes object from the database.

Any callback is invoked. Doesn't start any transaction.

Deletes object from db and calls all related callbacks.

It returns true if the object was successfully deleted.

Contact.first!.destroy # => true

Perform destroy without starting a database transaction.

Returns whether record isn't destroyed.

Lock current object in the database.

Returns whether record isn't persisted.

Returns true if the record is persisted, i.e. it’s not a new record and it wasn't destroyed, otherwise returns false.

Reloads the record from the database.

This method finds record by its primary key and modifies the receiver in-place. All relations are refreshed.

user = User.first!
user.name = "John"
user.reload # => #<User id: 1, name: "Will">

Saves the object.

If the object is a new record it is created in the database, otherwise the existing record get updated.

By default, #save triggers validations but they can be skipped passing true as the second argument. If any of them fails #save returns false.

There is a series of callbacks associated with #save. If any of the before_* callbacks return false the action is cancelled and false is returned. See Jennifer::Model::Callback for further details.

user.name = "Will"
user.save # => true

Saves the object.

If the object is a new record it is created in the database, otherwise the existing record get updated.

#save! always triggers validations. If any of them fails Jennifer::RecordInvalid gets raised.

There is a series of callbacks associated with #save!. If any of the before_* callbacks return false the action is cancelled and exception is raised. See Jennifer::Model::Callback for further details.

user.name = "Will"
user.save! # => true

Saves all changes to the database without starting a transaction; if any validation fails - returns false.

Sets name field with value

contact.set_attribute(:name, "Ivan")

Sets attributes based on values where keys are attribute names.

post.set_attributes({:title => "New Title", :created_at => Time.local})
post.set_attributes({title: "New Title", created_at: Time.local})
post.set_attributes(title: "New Title", created_at: Time.local)

Sets attributes based on values where keys are attribute names.

post.set_attributes({:title => "New Title", :created_at => Time.local})
post.set_attributes({title: "New Title", created_at: Time.local})
post.set_attributes(title: "New Title", created_at: Time.local)

Sets attributes based on given values using #set_attribute and saves it to the database, if validation pass.

Returns whether object is successfully saved.

contact.update({:name => "Jennifer"})
contact.update({name: "Jennifer"})

Sets attributes based on given values using #set_attribute and saves it to the database, if validation pass.

Returns whether object is successfully saved.

contact.update(name: "Jennifer")

Sets attributes based on given values and saves it to the database, if validation pass.

Raises an RecordInvalid error if validation fail, unlike #update.

contact.update!({:name => "Jennifer"})
contact.update!({name: "Jennifer"})

Sets attributes based on given values and saves it to the database, if validation pass.

Raises an RecordInvalid error if validation fail, unlike #update.

contact.update!(name: "Jennifer")

Sets value to field with name name and stores them directly to the database without any validation or callback.

Is a shorthand for #update_columns({ name => value }). Doesn't use attribute writer.

Assigns record properties based on key-value pairs of values and stores them directly to the database without running validations and callbacks.

updated_at property is not updated as well.

If at least one attribute get value of wrong type or attribute is missing or is virtual - BaseException is raised.

user.update_columns({:name => "Jennifer"})

Starts a transaction and locks current object.