Spec-Zone.ru › Ruby on Rails 6.1

module ActiveRecord::Persistence

Активный Запись Устойчивости

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

becomes(klass) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 570
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 с атрибутами текущей записи. Это в основном полезно в отношении структур наследования одной таблицы, где вы хотите, чтобы подкласс отображался как суперкласс. Это можно использовать вместе с идентификацией записей в Action Pack, чтобы разрешить, скажем, Client < Company делать что-то вроде render partial: @client.becomes(Company), чтобы отобразить этот экземпляр, используя частичный companies/company вместо clients/client.

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

becomes!(klass) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 590
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 713
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 723
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 522
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 535
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 554
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 438
def destroyed?
  @destroyed
end

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

increment(attribute, by = 1) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 690
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 702
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 426
def new_record?
  @new_record
end

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

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

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

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

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

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

  fresh_object =
    if options && options[:lock]
      self.class.unscoped { self.class.lock(options[:lock]).find(id) }
    else
      self.class.unscoped { self.class.find(id) }
    end

  @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) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 473
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.

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

save!(**options) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 506
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.

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

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

toggle(attribute) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 739
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) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 748
def toggle!(attribute)
  toggle(attribute).update_attribute(attribute, self[attribute])
end

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

touch(*names, time: nil) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 850
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) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 623
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) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 634
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) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 612
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, если атрибут помечен как readonly.

См. также update_column.

update_column(name, value) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 644
def update_column(name, value)
  update_columns(name => value)
end

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

update_columns(attributes) Показать исходный код
# File activerecord/lib/active_record/persistence.rb, line 664
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

  id_in_database = self.id_in_database
  attributes.each do |k, v|
    write_attribute_without_type_cast(k, v)
  end

  affected_rows = self.class._update_record(
    attributes,
    @primary_key => id_in_database
  )

  affected_rows == 1
end

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

user.update_columns(last_request_at: Time.current)

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

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

  • Коллбеки пропускаются.

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

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

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

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

Spec-Zone.ru

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