Spec-Zone.ru › Ruby on Rails 7.0

модуль ActiveRecord::Persistence

Сохранение Active Record

Публичные методы экземпляра

becomes(klass) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 712
def becomes(klass)
  became = klass.allocate

  became.send(:initialize) do |becoming|
    becoming.instance_variable_set(:@attributes, @attributes)
    becoming.instance_variable_set(:@mutations_from_database, @mutations_from_database ||= nil)
    becoming.instance_variable_set(:@new_record, new_record?)
    becoming.instance_variable_set(:@destroyed, destroyed?)
    becoming.errors.copy!(errors)
  end

  became
end

Возвращает экземпляр указанного klass с атрибутами текущей записи. Это в основном полезно в отношении структур наследования одной таблицы (STI), когда вы хотите, чтобы подкласс отображался как суперкласс. Это можно использовать вместе с идентификацией записей в Action Pack, чтобы позволить, скажем, Client < Company сделать что-то вроде рендеринга partial: @client.becomes(Company) для рендеринга этого экземпляра с использованием частичных компаний/компании вместо клиентов/клиента.

Примечание: новый экземпляр будет совместно использовать ссылку на те же атрибуты, что и исходный класс. Поэтому значение столбца STI останется тем же. Любое изменение атрибутов в любом из экземпляров повлияет на оба экземпляра. Если вы также хотите изменить столбец STI, используйте becomes! вместо этого.

becomes!(klass) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 732
def becomes!(klass)
  became = becomes(klass)
  sti_type = nil
  if !klass.descends_from_active_record?
    sti_type = klass.sti_name
  end
  became.public_send("#{klass.inheritance_column}=", sti_type)
  became
end

Оболочка вокруг becomes, которая также изменяет значение столбца STI экземпляра. Это особенно полезно, если вы хотите сохранить измененный класс в своей базе данных.

Примечание: значение столбца STI старого экземпляра также будет изменено, поскольку оба объекта используют один и тот же набор атрибутов.

decrement(attribute, by = 1) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 856
def decrement(attribute, by = 1)
  increment(attribute, -by)
end

Инициализирует attribute в ноль, если nil и вычитает значение, переданное как by (по умолчанию 1). Уменьшение выполняется непосредственно по базовому атрибуту, сеттер не вызывается. Имеет смысл только для числовых атрибутов. Возвращает self.

decrement!(attribute, by = 1, touch: nil) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 866
def decrement!(attribute, by = 1, touch: nil)
  increment!(attribute, -by, touch: touch)
end

Оболочка вокруг decrement, которая записывает обновление в базу данных. Обновляется только attribute; сама запись не сохраняется. Это означает, что любые другие измененные атрибуты останутся измененными. Validations и обратные вызовы пропускаются. Поддерживает параметр touch из update_counters, см. его для получения дополнительной информации. Возвращает self.

delete() Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 664
def delete
  _delete_row if persisted?
  @destroyed = true
  freeze
end

Удаляет запись в базе данных и замораживает этот экземпляр, чтобы отразить, что изменения не должны вноситься (поскольку они не могут быть сохранены). Возвращает замороженный экземпляр.

Строка просто удаляется с помощью оператора SQL DELETE по первичному ключу записи, и обратные вызовы не выполняются.

Обратите внимание, что это также удалит записи, помеченные как #readonly?.

Чтобы применить обратные вызовы before_destroy и after_destroy объекта или любые параметры ассоциации :dependent, используйте destroy.

destroy() Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 677
def destroy
  _raise_readonly_record_error if readonly?
  destroy_associations
  @_trigger_destroy_callback = if persisted?
    destroy_row > 0
  else
    true
  end
  @destroyed = true
  freeze
end

Удаляет запись в базе данных и замораживает этот экземпляр, чтобы отразить, что изменения не должны вноситься (поскольку они не могут быть сохранены).

Существует ряд обратных вызовов, связанных с destroy. Если обратный вызов before_destroy вызывает :abort, действие отменяется, и destroy возвращает false. См. ActiveRecord::Callbacks для получения дополнительной информации.

destroy!() Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 696
def destroy!
  destroy || _raise_record_not_destroyed
end

Удаляет запись в базе данных и замораживает этот экземпляр, чтобы отразить, что изменения не должны вноситься (поскольку они не могут быть сохранены).

Существует ряд обратных вызовов, связанных с destroy!. Если обратный вызов before_destroy вызывает :abort, действие отменяется, и destroy! вызывает ActiveRecord::RecordNotDestroyed. См. ActiveRecord::Callbacks для получения дополнительной информации.

destroyed?() Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 580
def destroyed?
  @destroyed
end

Возвращает true, если этот объект был уничтожен, иначе возвращает false.

increment(attribute, by = 1) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 833
def increment(attribute, by = 1)
  self[attribute] ||= 0
  self[attribute] += by
  self
end

Инициализирует attribute в ноль, если nil и добавляет значение, переданное как by (по умолчанию 1). Приращение выполняется непосредственно по базовому атрибуту, сеттер не вызывается. Имеет смысл только для числовых атрибутов. Возвращает self.

increment!(attribute, by = 1, touch: nil) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 845
def increment!(attribute, by = 1, touch: nil)
  increment(attribute, by)
  change = public_send(attribute) - (public_send(:"#{attribute}_in_database") || 0)
  self.class.update_counters(id, attribute => change, touch: touch)
  public_send(:"clear_#{attribute}_change")
  self
end

Оболочка вокруг increment, которая записывает обновление в базу данных. Обновляется только attribute; сама запись не сохраняется. Это означает, что любые другие измененные атрибуты останутся измененными. Validations и обратные вызовы пропускаются. Поддерживает параметр touch из update_counters, см. его для получения дополнительной информации. Возвращает self.

new_record?() Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 563
def new_record?
  @new_record
end

Возвращает true, если этот объект еще не сохранен — то есть запись для объекта еще не существует в базе данных; в противном случае возвращает false.

persisted?() Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 586
def persisted?
  !(@new_record || @destroyed)
end

Возвращает true, если запись сохранена, т. е. это не новая запись и она не была удалена, иначе возвращает false.

previously_new_record?() Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 570
def previously_new_record?
  @previously_new_record
end

Возвращает true, если этот объект только что создан — то есть до последнего сохранения объект не существовал в базе данных, и new_record? вернул бы true.

previously_persisted?() Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 575
def previously_persisted?
  !new_record? && destroyed?
end

Возвращает true, если этот объект был ранее сохранен, но теперь он был удален.

reload(options = nil) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 943
def reload(options = nil)
  self.class.connection.clear_query_cache

  fresh_object = if apply_scoping?(options)
    _find_record(options)
  else
    self.class.unscoped { _find_record(options) }
  end

  @association_cache = fresh_object.instance_variable_get(:@association_cache)
  @attributes = fresh_object.instance_variable_get(:@attributes)
  @new_record = false
  @previously_new_record = false
  self
end

Перезагружает запись из базы данных.

Этот метод находит запись по ее первичному ключу (который может быть назначен вручную) и изменяет получатель на месте:

account = Account.new
# => #<Account id: nil, email: nil>
account.id = 1
account.reload
# Account Load (1.2ms)  SELECT "accounts".* FROM "accounts" WHERE "accounts"."id" = $1 LIMIT 1  [["id", 1]]
# => #<Account id: 1, email: 'account@example.com'>

Attributes перезагружаются из базы данных, а кэши очищаются, в частности кэш ассоциаций и QueryCache.

Если запись больше не существует в базе данных, возникает исключение ActiveRecord::RecordNotFound. В противном случае, помимо модификации на месте, метод возвращает self для удобства.

Необязательный параметр флага :lock позволяет заблокировать перезагруженную запись:

reload(lock: true) # reload with pessimistic locking

Перезагрузка обычно используется в тестовых наборах для проверки того, что что-то действительно записано в базу данных, или когда какое-то действие изменяет соответствующую строку в базе данных, но не объект в памяти:

assert account.deposit!(25)
assert_equal 25, account.credit        # check it is updated in memory
assert_equal 25, account.reload.credit # check it is also persisted

Еще один распространенный случай использования — обработка оптимистичной блокировки:

def with_optimistic_retry
  begin
    yield
  rescue ActiveRecord::StaleObjectError
    begin
      # Reload lock_version in particular.
      reload
    rescue ActiveRecord::RecordNotFound
      # If the record is gone there is nothing to do.
    else
      retry
    end
  end
end
save(**options) Show source
# File activerecord/lib/active_record/persistence.rb, line 615
def save(**options, &block)
  create_or_update(**options, &block)
rescue ActiveRecord::RecordInvalid
  false
end

Сохраняет модель.

Если модель новая, в базе данных создается запись, в противном случае существующая запись обновляется.

По умолчанию save всегда запускает валидацию. Если какая-либо из проверок не пройдена, действие отменяется и save возвращает false, и запись не будет сохранена. Однако, если вы укажете validate: false, валидация полностью игнорируется. См. ActiveRecord::Validations для получения дополнительной информации.

По умолчанию, save также устанавливает атрибуты updated_at/updated_on на текущее время. Однако, если вы укажете touch: false, эти метки времени не будут обновлены.

Существует ряд обратных вызовов, связанных с save. Если какой-либо из обратных вызовов before_* вызывает исключение :abort, действие отменяется, и save возвращает false. См. ActiveRecord::Callbacks для получения дополнительной информации.

Attributes, помеченные как доступные только для чтения, игнорируются, если запись обновляется.

save!(**options) Show source
# File activerecord/lib/active_record/persistence.rb, line 648
def save!(**options, &block)
  create_or_update(**options, &block) || raise(RecordNotSaved.new("Failed to save the record", self))
end

Сохраняет модель.

Если модель новая, в базе данных создается запись, в противном случае существующая запись обновляется.

По умолчанию, save! всегда запускает валидацию. Если какая-либо из проверок не пройдена, генерируется исключение ActiveRecord::RecordInvalid, и запись не будет сохранена. Однако, если вы укажете validate: false, валидация полностью игнорируется. См. ActiveRecord::Validations для получения дополнительной информации.

По умолчанию, save! также устанавливает атрибуты updated_at/updated_on на текущее время. Однако, если вы укажете touch: false, эти метки времени не будут обновлены.

Существует ряд обратных вызовов, связанных с save!. Если какой-либо из обратных вызовов before_* вызывает исключение :abort, действие отменяется, и save! вызывает исключение ActiveRecord::RecordNotSaved. См. ActiveRecord::Callbacks для получения дополнительной информации.

Attributes, помеченные как доступные только для чтения, игнорируются, если запись обновляется.

Если исключение не вызвано, возвращает true.

toggle(attribute) Show source
# File activerecord/lib/active_record/persistence.rb, line 882
def toggle(attribute)
  self[attribute] = !public_send("#{attribute}?")
  self
end

Присваивает attribute булево значение, противоположное attribute?. Таким образом, если предикат возвращает true, атрибут станет false. Этот метод переключает непосредственно базовое значение без вызова любого сеттера. Возвращает self.

Пример:

user = User.first
user.banned? # => false
user.toggle(:banned)
user.banned? # => true
toggle!(attribute) Show source
# File activerecord/lib/active_record/persistence.rb, line 891
def toggle!(attribute)
  toggle(attribute).update_attribute(attribute, self[attribute])
end

Обёртка вокруг toggle, которая сохраняет запись. Этот метод отличается от своей версии без «!» тем, что он проходит через сеттер атрибута. Сохранение не подвергается проверкам валидации. Возвращает true, если запись может быть сохранена.

touch(*names, time: nil) Show source
# File activerecord/lib/active_record/persistence.rb, line 993
def touch(*names, time: nil)
  _raise_record_not_touched_error unless persisted?

  attribute_names = timestamp_attributes_for_update_in_model
  attribute_names |= names.map! do |name|
    name = name.to_s
    self.class.attribute_aliases[name] || name
  end unless names.empty?

  unless attribute_names.empty?
    affected_rows = _touch_row(attribute_names, time)
    @_trigger_update_callback = affected_rows == 1
  else
    true
  end
end

Сохраняет запись с атрибутами updated_at/on, установленными на текущее время или указанное время. Обратите внимание, что валидация не выполняется и выполняются только обратные вызовы after_touch, after_commit и after_rollback.

Этому методу могут быть переданы имена атрибутов и необязательный аргумент времени. Если передаются имена атрибутов, они обновляются вместе с атрибутами updated_at/on. Если аргумент времени не передан, по умолчанию используется текущее время.

product.touch                         # updates updated_at/on with current time
product.touch(time: Time.new(2015, 2, 16, 0, 0, 0)) # updates updated_at/on with specified time
product.touch(:designed_at)           # updates the designed_at attribute and updated_at/on
product.touch(:started_at, :ended_at) # updates started_at, ended_at and updated_at/on attributes

При использовании вместе с belongs_to touch вызовет метод touch на связанном объекте.

class Brake < ActiveRecord::Base
  belongs_to :car, touch: true
end

class Car < ActiveRecord::Base
  belongs_to :corporation, touch: true
end

# triggers @brake.car.touch and @brake.car.corporation.touch
@brake.touch

Обратите внимание, что touch должен использоваться для сохраняемого объекта, иначе будет вызвано исключение ActiveRecordError. Например:

ball = Ball.new
ball.touch(:updated_at)   # => raises ActiveRecordError
update(attributes) Show source
# File activerecord/lib/active_record/persistence.rb, line 765
def update(attributes)
  # The following transaction covers any possible database side-effects of the
  # attributes assignment. For example, setting the IDs of a child collection.
  with_transaction_returning_status do
    assign_attributes(attributes)
    save
  end
end

Обновляет атрибуты модели из переданного хэша и сохраняет запись, всё это в рамках транзакции. Если объект неверен, сохранение не состоится и будет возвращено false.

update!(attributes) Show source
# File activerecord/lib/active_record/persistence.rb, line 776
def update!(attributes)
  # The following transaction covers any possible database side-effects of the
  # attributes assignment. For example, setting the IDs of a child collection.
  with_transaction_returning_status do
    assign_attributes(attributes)
    save!
  end
end

Обновляет получатель, как и update, но вызывает save! вместо save, поэтому исключение генерируется, если запись неверна и сохранение не состоится.

update_attribute(name, value) Show source
# File activerecord/lib/active_record/persistence.rb, line 754
def update_attribute(name, value)
  name = name.to_s
  verify_readonly_attribute(name)
  public_send("#{name}=", value)

  save(validate: false)
end

Обновляет один атрибут и сохраняет запись. Это особенно полезно для булевых флагов в существующих записях. Также обратите внимание, что

  • Валидация пропускается.

  • Обратные вызовы вызываются.

  • Столбец updated_at/updated_on обновляется, если этот столбец доступен.

  • Обновляются все атрибуты, которые являются изменёнными в этом объекте.

Этот метод вызывает исключение ActiveRecord::ActiveRecordError, если атрибут помечен как доступный только для чтения.

См. также update_column.

update_column(name, value) Show source
# File activerecord/lib/active_record/persistence.rb, line 786
def update_column(name, value)
  update_columns(name => value)
end

Эквивалент update_columns(name => value).

update_columns(attributes) Show source
# File activerecord/lib/active_record/persistence.rb, line 806
def update_columns(attributes)
  raise ActiveRecordError, "cannot update a new record" if new_record?
  raise ActiveRecordError, "cannot update a destroyed record" if destroyed?

  attributes = attributes.transform_keys do |key|
    name = key.to_s
    name = self.class.attribute_aliases[name] || name
    verify_readonly_attribute(name) || name
  end

  update_constraints = _primary_key_constraints_hash
  attributes = attributes.each_with_object({}) do |(k, v), h|
    h[k] = @attributes.write_cast_value(k, v)
    clear_attribute_change(k)
  end

  affected_rows = self.class._update_record(
    attributes,
    update_constraints
  )

  affected_rows == 1
end

Непосредственно обновляет атрибуты в базе данных, выполняя оператор SQL UPDATE, и устанавливает их в получателе:

user.update_columns(last_request_at: Time.current)

Это самый быстрый способ обновления атрибутов, поскольку он идёт напрямую в базу данных, но учтите, что в результате обычные процедуры обновления полностью обходятся. В частности:

  • Валидация пропускается.

  • Обратные вызовы пропускаются.

  • updated_at/updated_on не обновляются.

  • Однако атрибуты сериализуются по тем же правилам, что и ActiveRecord::Relation#update_all

Этот метод вызывает исключение ActiveRecord::ActiveRecordError, когда вызывается для новых объектов или когда хотя бы один из атрибутов помечен как доступный только для чтения.

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API