module ActiveRecord::ModelSchema

Public Class Methods

internal_metadata_table_name Show source
# File activerecord/lib/active_record/model_schema.rb, line 81
    

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

internal_metadata_table_name=(table_name) Show source
# File activerecord/lib/active_record/model_schema.rb, line 87
    

Sets the name of the internal metadata table.

pluralize_table_names Show source
# File activerecord/lib/active_record/model_schema.rb, line 108
    

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.

pluralize_table_names=(value) Show source
# File activerecord/lib/active_record/model_schema.rb, line 116
included do
  mattr_accessor :primary_key_prefix_type, instance_writer: false

  class_attribute :table_name_prefix, instance_writer: false
  self.table_name_prefix = ""

  class_attribute :table_name_suffix, instance_writer: false
  self.table_name_suffix = ""

  class_attribute :schema_migrations_table_name, instance_accessor: false
  self.schema_migrations_table_name = "schema_migrations"

  class_attribute :internal_metadata_table_name, instance_accessor: false
  self.internal_metadata_table_name = "ar_internal_metadata"

  class_attribute :protected_environments, instance_accessor: false
  self.protected_environments = ["production"]

  class_attribute :pluralize_table_names, instance_writer: false
  self.pluralize_table_names = true

  self.inheritance_column = 'type'
  self.ignored_columns = [].freeze

  delegate :type_for_attribute, to: :class

  initialize_load_schema_monitor
end

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.

primary_key_prefix_type Show source
# File activerecord/lib/active_record/model_schema.rb, line 17
    

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.

primary_key_prefix_type=(prefix_type) Show source
# File activerecord/lib/active_record/model_schema.rb, line 27
    

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.

protected_environments Show source
# File activerecord/lib/active_record/model_schema.rb, line 94
    

The array of names of environments where destructive actions should be prohibited. By default, the value is ["production"].

protected_environments=(environments) Show source
# File activerecord/lib/active_record/model_schema.rb, line 100
    

Sets an array of names of environments where destructive actions should be prohibited.

schema_migrations_table_name Show source
# File activerecord/lib/active_record/model_schema.rb, line 69
    

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

schema_migrations_table_name=(table_name) Show source
# File activerecord/lib/active_record/model_schema.rb, line 75
    

Sets the name of the schema migrations table.

table_name_prefix Show source
# File activerecord/lib/active_record/model_schema.rb, line 33
    

The prefix string to prepend to every table name.

table_name_prefix=(prefix) Show source
# File activerecord/lib/active_record/model_schema.rb, line 46
    

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.

table_name_suffix Show source
# File activerecord/lib/active_record/model_schema.rb, line 52
    

The suffix string to append to every table name.

table_name_suffix=(suffix) Show source
# File activerecord/lib/active_record/model_schema.rb, line 63
    

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.

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.