модуль ActiveRecord::Core
Ядро Active Record
Атрибуты
Общедоступные методы класса
# File activerecord/lib/active_record/core.rb, line 77 def self.configurations @@configurations end
Возвращает полностью разрешённый объект ActiveRecord::DatabaseConfigurations
# File activerecord/lib/active_record/core.rb, line 71 def self.configurations=(config) @@configurations = ActiveRecord::DatabaseConfigurations.new(config) end
Содержит конфигурацию базы данных — как обычно хранится в config/database.yml — в виде объекта ActiveRecord::DatabaseConfigurations.
Например, следующий database.yml…
development: adapter: sqlite3 database: storage/development.sqlite3 production: adapter: sqlite3 database: storage/production.sqlite3
…приведёт к тому, что ActiveRecord::Base.configurations будет выглядеть так:
#<ActiveRecord::DatabaseConfigurations:0x00007fd1acbdf800 @configurations=[
#<ActiveRecord::DatabaseConfigurations::HashConfig:0x00007fd1acbded10 @env_name="development",
@name="primary", @config={adapter: "sqlite3", database: "storage/development.sqlite3"}>,
#<ActiveRecord::DatabaseConfigurations::HashConfig:0x00007fd1acbdea90 @env_name="production",
@name="primary", @config={adapter: "sqlite3", database: "storage/production.sqlite3"}>
]> # File activerecord/lib/active_record/core.rb, line 117 def self.connection_handler ActiveSupport::IsolatedExecutionState[:active_record_connection_handler] || default_connection_handler end
# File activerecord/lib/active_record/core.rb, line 121 def self.connection_handler=(handler) ActiveSupport::IsolatedExecutionState[:active_record_connection_handler] = handler end
# File activerecord/lib/active_record/core.rb, line 180
def self.current_preventing_writes
connected_to_stack.reverse_each do |hash|
return hash[:prevent_writes] if !hash[:prevent_writes].nil? && hash[:klasses].include?(Base)
return hash[:prevent_writes] if !hash[:prevent_writes].nil? && hash[:klasses].include?(connection_class_for_self)
end
false
end Возвращает символ, представляющий текущее значение настройки для предотвращения записи.
ActiveRecord::Base.connected_to(role: :reading) do ActiveRecord::Base.current_preventing_writes #=> true end ActiveRecord::Base.connected_to(role: :writing) do ActiveRecord::Base.current_preventing_writes #=> false end
# File activerecord/lib/active_record/core.rb, line 143
def self.current_role
connected_to_stack.reverse_each do |hash|
return hash[:role] if hash[:role] && hash[:klasses].include?(Base)
return hash[:role] if hash[:role] && hash[:klasses].include?(connection_class_for_self)
end
default_role
end Возвращает символ, представляющий текущую подключённую роль.
ActiveRecord::Base.connected_to(role: :writing) do ActiveRecord::Base.current_role #=> :writing end ActiveRecord::Base.connected_to(role: :reading) do ActiveRecord::Base.current_role #=> :reading end
# File activerecord/lib/active_record/core.rb, line 161
def self.current_shard
connected_to_stack.reverse_each do |hash|
return hash[:shard] if hash[:shard] && hash[:klasses].include?(Base)
return hash[:shard] if hash[:shard] && hash[:klasses].include?(connection_class_for_self)
end
default_shard
end Возвращает символ, представляющий текущий подключённый фрагмент.
ActiveRecord::Base.connected_to(role: :reading) do ActiveRecord::Base.current_shard #=> :default end ActiveRecord::Base.connected_to(role: :writing, shard: :one) do ActiveRecord::Base.current_shard #=> :one end
# File activerecord/lib/active_record/core.rb, line 47 class_attribute :destroy_association_async_batch_size, instance_writer: false, instance_predicate: false, default: nil
Устанавливает максимальное количество записей, которые будут удалены в одной задаче фонового выполнения опцией dependent: :destroy_async ассоциации. Если значение nil (по умолчанию), все зависимые записи будут удалены в одной фоновой задаче. Если указано значение, записи, подлежащие удалению, будут разделены на несколько фоновых задач.
# File activerecord/lib/active_record/core.rb, line 27
def self.destroy_association_async_job
if _destroy_association_async_job.is_a?(String)
self._destroy_association_async_job = _destroy_association_async_job.constantize
end
_destroy_association_async_job
rescue NameError => error
raise NameError, "Unable to load destroy_association_async_job: #{error.message}"
end Класс задачи, используемый для удаления ассоциаций в фоновом режиме.
# File activerecord/lib/active_record/core.rb, line 87 class_attribute :enumerate_columns_in_select_statements, instance_accessor: false, default: false
Принудительно перечислить все столбцы в операторах SELECT. Например, SELECT first_name, last_name FROM ... вместо SELECT * FROM ... Это предотвращает ошибки PreparedStatementCacheExpired при добавлении столбца в базу данных во время работы приложения.
# File activerecord/lib/active_record/core.rb, line 22 class_attribute :logger, instance_writer: false
Принимает логгер, соответствующий интерфейсу Log4r или стандартному классу Ruby Logger, который затем передаётся всем новым базам данных. Вы можете получить доступ к этому логгеру, вызвав logger для класса или экземпляра модели Active Record.
# File activerecord/lib/active_record/core.rb, line 425 def initialize(attributes = nil) @new_record = true @attributes = self.class._default_attributes.deep_dup init_internals initialize_internals_callback assign_attributes(attributes) if attributes yield self if block_given? _run_initialize_callbacks end
Новые объекты могут быть созданы либо пустыми (не передавать параметр конструирования), либо предварительно заданными атрибутами, но ещё не сохранёнными (передать хэш с именами ключей, соответствующими именам столбцов связанной таблицы). В обоих случаях допустимые ключи атрибутов определяются именами столбцов связанной таблицы — поэтому у вас не может быть атрибутов, которые не являются частью столбцов таблицы.
Пример
# Instantiates a single new object User.new(first_name: 'Jamie')
Методы публичного экземпляра
# File activerecord/lib/active_record/core.rb, line 604
def <=>(other_object)
if other_object.is_a?(self.class)
to_key <=> other_object.to_key
else
super
end
end Позволяет сортировать объекты
# File activerecord/lib/active_record/core.rb, line 570
def ==(comparison_object)
super ||
comparison_object.instance_of?(self.class) &&
primary_key_values_present? &&
comparison_object.id == id
end Возвращает true, если comparison_object — это тот же самый объект, или comparison_object относится к тому же типу и self имеет идентификатор, равный comparison_object.id.
Обратите внимание, что новые записи по определению отличаются от любых других записей, если только другая запись не является самим получателем. Кроме того, если вы извлекаете существующие записи с помощью select и опускаете идентификатор, вы действуете на свой страх и риск; этот предикат вернёт false.
Также обратите внимание, что удаление записи сохраняет её идентификатор в экземпляре модели, поэтому удалённые модели всё ещё сравнимы.
# File activerecord/lib/active_record/core.rb, line 477
Идентично методу clone в Ruby. Это «поверхностная» копия. Будьте осторожны: ваши атрибуты не копируются. Это означает, что изменение атрибутов копии повлияет на оригинал, поскольку они оба указывают на один и тот же хэш атрибутов. Если вам нужна копия вашего хэша атрибутов, пожалуйста, используйте метод dup.
user = User.first new_user = user.clone user.name # => "Bob" new_user.name = "Joe" user.name # => "Joe" user.object_id == new_user.object_id # => false user.name.object_id == new_user.name.object_id # => true user.name.object_id == user.dup.name.object_id # => false
# File activerecord/lib/active_record/core.rb, line 680 def connection_handler self.class.connection_handler end
# File activerecord/lib/active_record/core.rb, line 494
Дублированные объекты не имеют назначенного идентификатора и обрабатываются как новые записи. Обратите внимание, что это «поверхностная» копия, так как она копирует только атрибуты объекта, а не его ассоциации. Степень «глубокой» копии зависит от приложения и поэтому оставляется на усмотрение приложения для реализации в соответствии с его потребностями. Метод dup не сохраняет временные метки (created|updated)_(at|on) и столбец блокировки.
# File activerecord/lib/active_record/core.rb, line 534 def encode_with(coder) self.class.yaml_encoder.encode(@attributes, coder) coder["new_record"] = new_record? coder["active_record_yaml_version"] = 2 end
Заполните coder атрибутами этой записи, которые должны быть сериализованы. Структура coder , определённая в этом методе, гарантированно соответствует структуре coder , переданной методу init_with.
Пример:
class Post < ActiveRecord::Base
end
coder = {}
Post.new.encode_with(coder)
coder # => {"attributes" => {"id" => nil, ... }}
# File activerecord/lib/active_record/core.rb, line 593 def freeze @attributes = @attributes.clone.freeze self end
Клонирует и замораживает хэш атрибутов таким образом, что ассоциации всё ещё доступны, даже для удалённых записей, но клонированные модели не будут заморожены.
# File activerecord/lib/active_record/core.rb, line 599 def frozen? @attributes.frozen? end
Возвращает true , если хэш атрибутов заморожен.
# File activerecord/lib/active_record/core.rb, line 580
def hash
id = self.id
if primary_key_values_present?
self.class.hash ^ id.hash
else
super
end
end Делегирует вызов к id, чтобы две записи одного типа и с одинаковым id могли работать с чем-то вроде:
[ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]
# File activerecord/lib/active_record/core.rb, line 452 def init_with(coder, &block) coder = LegacyYamlAdapter.convert(coder) attributes = self.class.yaml_encoder.decode(coder) init_with_attributes(attributes, coder["new_record"], &block) end
Инициализирует пустой объект модели из coder. coder должен быть результатом предыдущего кодирования модели Active Record с помощью encode_with.
class Post < ActiveRecord::Base
end
old_post = Post.new(title: "hello world")
coder = {}
old_post.encode_with(coder)
post = Post.allocate
post.init_with(coder)
post.title # => 'hello world'
# File activerecord/lib/active_record/core.rb, line 685
def inspect
# We check defined?(@attributes) not to issue warnings if the object is
# allocated but not initialized.
inspection = if defined?(@attributes) && @attributes
attribute_names.filter_map do |name|
if _has_attribute?(name)
"#{name}: #{attribute_for_inspect(name)}"
end
end.join(", ")
else
"not initialized"
end
"#<#{self.class} #{inspection}>"
end Возвращает содержимое записи в виде отформатированной строки.
# File activerecord/lib/active_record/core.rb, line 703
def pretty_print(pp)
return super if custom_inspect_method_defined?
pp.object_address_group(self) do
if defined?(@attributes) && @attributes
attr_names = self.class.attribute_names.select { |name| _has_attribute?(name) }
pp.seplist(attr_names, proc { pp.text "," }) do |attr_name|
pp.breakable " "
pp.group(1) do
pp.text attr_name
pp.text ":"
pp.breakable
value = _read_attribute(attr_name)
value = inspection_filter.filter_param(attr_name, value) unless value.nil?
pp.pp value
end
end
else
pp.breakable " "
pp.text "not initialized"
end
end
end Принимает PP и красиво выводит эту запись в него, позволяя вам получить хороший результат от pp record , когда требуется pp.
# File activerecord/lib/active_record/core.rb, line 676 def readonly! @readonly = true end
Помечает эту запись как только для чтения.
# File activerecord/lib/active_record/core.rb, line 621 def readonly? @readonly end
Возвращает true , если запись является только для чтения.
# File activerecord/lib/active_record/core.rb, line 541
Возвращает хэш заданных методов с их именами в качестве ключей и возвращаемыми значениями в качестве значений.
# File activerecord/lib/active_record/core.rb, line 659
def strict_loading!(value = true, mode: :all)
unless [:all, :n_plus_one_only].include?(mode)
raise ArgumentError, "The :mode option must be one of [:all, :n_plus_one_only] but #{mode.inspect} was provided."
end
@strict_loading_mode = mode
@strict_loading = value
end Устанавливает режим strict_loading для записи. Это вызовет ошибку, если запись попытается загрузить ассоциацию лениво.
user = User.first user.strict_loading! # => true user.address.city => ActiveRecord::StrictLoadingViolationError user.comments.to_a => ActiveRecord::StrictLoadingViolationError
Параметры
-
value— логическое значение, определяющее, включить или отключить строгий режим загрузки. -
:mode—Symbol, определяющий режим строгой загрузки. По умолчанию :all. Режим :n_plus_one_only вызовет ошибку только в том случае, если лениво загружается ассоциация, которая приведёт к запросу n + 1.
Примеры
user = User.first user.strict_loading!(false) # => false user.address.city # => "Tatooine" user.comments.to_a # => [#<Comment:0x00...] user.strict_loading!(mode: :n_plus_one_only) user.address.city # => "Tatooine" user.comments.to_a # => [#<Comment:0x00...] user.comments.first.ratings.to_a => ActiveRecord::StrictLoadingViolationError
# File activerecord/lib/active_record/core.rb, line 626 def strict_loading? @strict_loading end
Возвращает true , если запись находится в режиме strict_loading.
# File activerecord/lib/active_record/core.rb, line 671 def strict_loading_n_plus_one_only? @strict_loading_mode == :n_plus_one_only end
Возвращает true , если запись использует strict_loading с включённым режимом :n_plus_one_only .
# File activerecord/lib/active_record/core.rb, line 552
Возвращает массив значений, возвращаемых указанными методами.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.