модуль ActiveRecord::ModelSchema::ClassMethods

# File activerecord/lib/active_record/model_schema.rb, line 474
def column_defaults
  load_schema
  @column_defaults ||= _default_attributes.deep_dup.to_hash.freeze
end

Возвращает хеш, где ключами являются имена столбцов, а значениями — значения по умолчанию при создании объекта Active Record для этой таблицы.

# File activerecord/lib/active_record/model_schema.rb, line 465
def column_for_attribute(name)
  name = name.to_s
  columns_hash.fetch(name) do
    ConnectionAdapters::NullColumn.new(name)
  end
end

Возвращает объект столбца для указанного атрибута. Возвращает ActiveRecord::ConnectionAdapters::NullColumn, если атрибут с указанным именем не существует.

class Person < ActiveRecord::Base
end

person = Person.new
person.column_for_attribute(:name) # the result depends on the ConnectionAdapter
# => #<ActiveRecord::ConnectionAdapters::Column:0x007ff4ab083980 @name="name", @sql_type="varchar(255)", @null=true, ...>

person.column_for_attribute(:nothing)
# => #<ActiveRecord::ConnectionAdapters::NullColumn:0xXXX @name=nil, @sql_type=nil, @cast_type=#<Type::Value>, ...>

# File activerecord/lib/active_record/model_schema.rb, line 480
def column_names
  @column_names ||= columns.map(&:name).freeze
end

Возвращает массив имён столбцов в виде строк.

# File activerecord/lib/active_record/model_schema.rb, line 491
def content_columns
  @content_columns ||= columns.reject do |c|
    c.name == primary_key ||
    c.name == inheritance_column ||
    c.name.end_with?("_id", "_count")
  end.freeze
end

Возвращает массив объектов столбцов, из которого удалены первичный ключ, все столбцы, оканчивающиеся на «_id» или «_count», и столбцы, используемые для наследования таблицы.

# File activerecord/lib/active_record/model_schema.rb, line 332
def ignored_columns
  @ignored_columns || superclass.ignored_columns
end

Список имён столбцов, которые модель должна игнорировать. Для игнорируемых столбцов не будут определены аксессоры атрибутов, и они не будут участвовать в SQL-запросах.

# File activerecord/lib/active_record/model_schema.rb, line 367
def ignored_columns=(columns)
  reload_schema_from_cache
  @ignored_columns = columns.map(&:to_s).freeze
end

Устанавливает имена столбцов, которые модель должна игнорировать. Для игнорируемых столбцов не будут определены аксессоры атрибутов, и они не будут участвовать в SQL-запросах.

Типичный способ использования этого метода — убедиться, что все ссылки на атрибут были удалены и развернуты до развертывания и выполнения миграции для удаления столбца из базы данных. Такой двухступенчатый подход к удалению столбцов гарантирует, что не существует кода, который генерирует ошибки из-за кэшированной схемы в памяти в момент запуска миграции схемы.

Например, если в модели требуется удалить атрибут «category», сначала пометьте его как игнорируемый:

class Project < ActiveRecord::Base
  # schema:
  #   id         :bigint
  #   name       :string, limit: 255
  #   category   :string, limit: 255

  self.ignored_columns += [:category]
end

Схема всё ещё содержит «category», но теперь модель его пропускает, поэтому любой код или кэширование схемы не будет пытаться использовать этот столбец:

Project.columns_hash["category"] => nil

Если попытаться получить доступ к этому атрибуту напрямую, возникнет ошибка, поэтому убедитесь, что все использования столбца удалены (автоматические тесты могут помочь вам найти все места использования).

user = Project.create!(name: "First Project")
user.category # => raises NoMethodError

# File activerecord/lib/active_record/model_schema.rb, line 536
def load_schema
  return if schema_loaded?
  @load_schema_monitor.synchronize do
    return if schema_loaded?

    load_schema!

    @schema_loaded = true
  rescue
    reload_schema_from_cache # If the schema loading failed half way through, we must reset the state.
    raise
  end
end

Загрузить информацию о схеме модели из кэша схемы или непосредственно из базы данных.

# File activerecord/lib/active_record/model_schema.rb, line 412
def next_sequence_value
  with_connection { |c| c.next_sequence_value(sequence_name) }
end

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

# File activerecord/lib/active_record/model_schema.rb, line 406
def prefetch_primary_key?
  with_connection { |c| c.prefetch_primary_key?(table_name) }
end

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

# File activerecord/lib/active_record/model_schema.rb, line 313
def protected_environments
  if defined?(@protected_environments)
    @protected_environments
  else
    superclass.protected_environments
  end
end

Массив имён сред, в которых запрещены разрушающие действия. По умолчанию значение равно ["production"].

# File activerecord/lib/active_record/model_schema.rb, line 322
def protected_environments=(environments)
  @protected_environments = environments.map(&:to_s)
end

Устанавливает массив имён сред, в которых запрещены разрушающие действия.

# File activerecord/lib/active_record/model_schema.rb, line 286
def quoted_table_name
  @quoted_table_name ||= adapter_class.quote_table_name(table_name)
end

Возвращает цитированное представление имени таблицы, используемое для построения SQL-запросов.

# File activerecord/lib/active_record/model_schema.rb, line 525
def reset_column_information
  connection_pool.active_connection&.clear_cache!
  ([self] + descendants).each(&:undefine_attribute_methods)
  schema_cache.clear_data_source_cache!(table_name)

  reload_schema_from_cache
  initialize_find_by_cache
end

Сбрасывает всю кэшированную информацию о столбцах, что приведет к их перезагрузке при следующем запросе.

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

class CreateJobLevels < ActiveRecord::Migration[7.2]
  def up
    create_table :job_levels do |t|
      t.integer :id
      t.string :name

      t.timestamps
    end

    JobLevel.reset_column_information
    %w{assistant executive manager director}.each do |type|
      JobLevel.create(name: type)
    end
  end

  def down
    drop_table :job_levels
  end
end

# File activerecord/lib/active_record/model_schema.rb, line 399
def sequence_name=(value)
  @sequence_name          = value.to_s
  @explicit_sequence_name = true
end

Устанавливает имя последовательности, используемой при генерации идентификаторов, заданным значением или (если значение равно nil или false) значению, возвращаемому заданным блоком. Это необходимо для Oracle и полезно для баз данных, которые полагаются на последовательности для генерации первичных ключей.

Если имя последовательности не указано явно при использовании Oracle, оно будет по умолчанию соответствовать общепринятому шаблону: #{table_name}_seq

Если имя последовательности не указано явно при использовании PostgreSQL, система обнаружит соответствующую последовательность для вашего первичного ключа автоматически.

class Project < ActiveRecord::Base
  self.sequence_name = "projectseq"   # default would have been "project_seq"
end

# File activerecord/lib/active_record/model_schema.rb, line 417
def table_exists?
  schema_cache.data_source_exists?(table_name)
end

Указывает, существует ли таблица, связанная с этим классом

# File activerecord/lib/active_record/model_schema.rb, line 260
def table_name
  reset_table_name unless defined?(@table_name)
  @table_name
end

Определяет имя таблицы (в принудительно нижнем регистре) на основе имени класса в иерархии наследования, непосредственно унаследованной от ActiveRecord::Base. Таким образом, если иерархия выглядит как: Reply < Message < ActiveRecord::Base, то Message используется для определения имени таблицы даже при вызове из Reply. Правила определения имени таблицы обрабатываются классом Inflector в Active Support, который знает практически все распространённые английские склонения. Вы можете добавить новые склонения в файл config/initializers/inflections.rb.

Вложенным классам присваиваются имена таблиц, начинающиеся с единственного числа имени родительской таблицы. Вложенные модули не рассматриваются.

Примеры

class Invoice < ActiveRecord::Base
end

file                  class               table_name
invoice.rb            Invoice             invoices

class Invoice < ActiveRecord::Base
  class Lineitem < ActiveRecord::Base
  end
end

file                  class               table_name
invoice.rb            Invoice::Lineitem   invoice_lineitems

module Invoice
  class Lineitem < ActiveRecord::Base
  end
end

file                  class               table_name
invoice/lineitem.rb   Invoice::Lineitem   lineitems

Кроме того, к имени класса добавляется префикс уровня класса table_name_prefix и суффикс table_name_suffix. Таким образом, если у вас есть префикс «myapp_», то предполагаемое имя таблицы для класса Invoice становится «myapp_invoices». Invoice::Lineitem станет «myapp_invoice_lineitems».

Базовое имя, используемое для определения имени таблицы, — это model_name из Active Model Naming. В случае определения пользовательского имени Active Model Name, оно также будет использоваться для имени таблицы:

class PostRecord < ActiveRecord::Base
  class << self
    def model_name
      ActiveModel::Name.new(self, nil, "Post")
    end
  end
end

PostRecord.table_name
# => "posts"

Также вы можете явно задать имя таблицы:

class Mouse < ActiveRecord::Base
  self.table_name = "mice"
end

# File activerecord/lib/active_record/model_schema.rb, line 270
def table_name=(value)
  value = value && value.to_s

  if defined?(@table_name)
    return if value == @table_name
    reset_column_information if connected?
  end

  @table_name        = value
  @quoted_table_name = nil
  @arel_table        = nil
  @sequence_name     = nil unless @explicit_sequence_name
  @predicate_builder = nil
end

Явно устанавливает имя таблицы. Пример:

class Project < ActiveRecord::Base
  self.table_name = "project"
end