module ActiveRecord::ModelSchema

Public Class Methods

implicit_order_column click to toggle source

The name of the column records are ordered by if no explicit order clause is used during an ordered finder call. If not set the primary key is used.

# File lib/active_record/model_schema.rb, line 111
    
implicit_order_column=(column_name) click to toggle source

Sets the column to sort records by when no explicit order clause is used during an ordered finder call. Useful when the primary key is not an auto-incrementing integer, for example when it's a UUID. Note that using a non-unique column can result in non-deterministic results.

# File lib/active_record/model_schema.rb, line 119
included do
  mattr_accessor :primary_key_prefix_type, instance_writer: false

  class_attribute :table_name_prefix, instance_writer: false, default: ""
  class_attribute :table_name_suffix, instance_writer: false, default: ""
  class_attribute :schema_migrations_table_name, instance_accessor: false, default: "schema_migrations"
  class_attribute :internal_metadata_table_name, instance_accessor: false, default: "ar_internal_metadata"
  class_attribute :pluralize_table_names, instance_writer: false, default: true
  class_attribute :implicit_order_column, instance_accessor: false

  self.protected_environments = ["production"]
  self.inheritance_column = "type"
  self.ignored_columns = [].freeze

  delegate :type_for_attribute, to: :class

  initialize_load_schema_monitor
end
internal_metadata_table_name click to toggle source

The name of the internal metadata table. By default, the value is "ar_internal_metadata".

# File lib/active_record/model_schema.rb, line 82
    
internal_metadata_table_name=(table_name) click to toggle source

Sets the name of the internal metadata table.

# File lib/active_record/model_schema.rb, line 88
    
pluralize_table_names click to toggle source

Indicates whether table names should be the pluralized versions of the corresponding class names. If true, the default table name for a Product class will be “products”. If false, it would just be “product”. See table_name for the full rules on table/class naming. This is true, by default.

# File lib/active_record/model_schema.rb, line 96
    
pluralize_table_names=(value) click to toggle source

Set whether table names should be the pluralized versions of the corresponding class names. If true, the default table name for a Product class will be “products”. If false, it would just be “product”. See table_name for the full rules on table/class naming. This is true, by default.

# File lib/active_record/model_schema.rb, line 104
    
primary_key_prefix_type click to toggle source

The prefix type that will be prepended to every primary key column name. The options are :table_name and :table_name_with_underscore. If the first is specified, the Product class will look for “productid” instead of “id” as the primary column. If the latter is specified, the Product class will look for “product_id” instead of “id”. Remember that this is a global setting for all Active Records.

# File lib/active_record/model_schema.rb, line 18
    
primary_key_prefix_type=(prefix_type) click to toggle source

Sets the prefix type that will be prepended to every primary key column name. The options are :table_name and :table_name_with_underscore. If the first is specified, the Product class will look for “productid” instead of “id” as the primary column. If the latter is specified, the Product class will look for “product_id” instead of “id”. Remember that this is a global setting for all Active Records.

# File lib/active_record/model_schema.rb, line 28
    
schema_migrations_table_name click to toggle source

The name of the schema migrations table. By default, the value is "schema_migrations".

# File lib/active_record/model_schema.rb, line 70
    
schema_migrations_table_name=(table_name) click to toggle source

Sets the name of the schema migrations table.

# File lib/active_record/model_schema.rb, line 76
    
table_name_prefix click to toggle source

The prefix string to prepend to every table name.

# File lib/active_record/model_schema.rb, line 34
    
table_name_prefix=(prefix) click to toggle source

Sets the prefix string to prepend to every table name. So if set to “basecamp_”, all table names will be named like “basecamp_projects”, “basecamp_people”, etc. This is a convenient way of creating a namespace for tables in a shared database. By default, the prefix is the empty string.

If you are organising your models within modules you can add a prefix to the models within a namespace by defining a singleton method in the parent module called ::table_name_prefix which returns your chosen prefix.

# File lib/active_record/model_schema.rb, line 47
    
table_name_suffix click to toggle source

The suffix string to append to every table name.

# File lib/active_record/model_schema.rb, line 53
    
table_name_suffix=(suffix) click to toggle source

Works like table_name_prefix=, but appends instead of prepends (set to “_basecamp” gives “projects_basecamp”, “people_basecamp”). By default, the suffix is the empty string.

If you are organising your models within modules, you can add a suffix to the models within a namespace by defining a singleton method in the parent module called ::table_name_suffix which returns your chosen suffix.

# File lib/active_record/model_schema.rb, line 64