# File lib/active_record/model_schema.rb, line 10
module ActiveRecord::ModelSchema
Public Class Methods
Source
# File lib/active_record/model_schema.rb, line 122
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.
Source
# File lib/active_record/model_schema.rb, line 106
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.
Source
# File lib/active_record/model_schema.rb, line 113
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.
Source
# File lib/active_record/model_schema.rb, line 130
The name of the table column which stores the class name on single-table inheritance situations.
The default inheritance column name is type
, which means it’s a reserved word inside Active Record. To be able to use single-table inheritance with another column name, or to use the column type
in your own model for something else, you can set inheritance_column
:
self.inheritance_column = 'zoink'
Source
# File lib/active_record/model_schema.rb, line 150 included do class_attribute :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 class_attribute :inheritance_column, instance_accessor: false, default: "type" singleton_class.class_eval do alias_method :_inheritance_column=, :inheritance_column= private :_inheritance_column= alias_method :inheritance_column=, :real_inheritance_column= end self.protected_environments = ["production"] self.ignored_columns = [].freeze delegate :type_for_attribute, :column_for_attribute, to: :class initialize_load_schema_monitor end
Defines the name of the table column which will store the class name on single-table inheritance situations.
Source
# File lib/active_record/model_schema.rb, line 78
The name of the internal metadata table. By default, the value is "ar_internal_metadata"
.
Source
# File lib/active_record/model_schema.rb, line 84
Sets the name of the internal metadata table.
Source
# File lib/active_record/model_schema.rb, line 90
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.
Source
# File lib/active_record/model_schema.rb, line 98
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.
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.
Source
# File lib/active_record/model_schema.rb, line 20
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.
Source
# File lib/active_record/model_schema.rb, line 66
The name of the schema migrations table. By default, the value is "schema_migrations"
.
Source
# File lib/active_record/model_schema.rb, line 72
Sets the name of the schema migrations table.
Source
# File lib/active_record/model_schema.rb, line 30
The prefix string to prepend to every table name.
Source
# File lib/active_record/model_schema.rb, line 36
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.
Source
# File lib/active_record/model_schema.rb, line 49
The suffix string to append to every table name.
Source
# File lib/active_record/model_schema.rb, line 55
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.