module ActiveRecord::ModelSchema

Public Class Methods

immutable_strings_by_default=(bool) click to toggle source

Determines whether columns should infer their type as :string or :immutable_string. This setting does not affect the behavior of attribute :foo, :string. Defaults to false.

# File lib/active_record/model_schema.rb, line 129
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
  class_attribute :immutable_strings_by_default, instance_accessor: false

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

  delegate :type_for_attribute, :column_for_attribute, to: :class

  initialize_load_schema_monitor
end
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 106
    
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. Records are subsorted by the primary key if it exists to ensure deterministic results.

# File lib/active_record/model_schema.rb, line 113
    
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 78
    
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 84
    
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 90
    
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 98
    
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 10
    
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 20
    
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 66
    
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 72
    
table_name_prefix click to toggle source

The prefix string to prepend to every table name.

# File lib/active_record/model_schema.rb, line 30
    
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 36
    
table_name_suffix click to toggle source

The suffix string to append to every table name.

# File lib/active_record/model_schema.rb, line 49
    
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 55