跳至内容 跳至搜索

Active Record 连接适配器表定义 ↑

以抽象的方式表示 SQL 表的 schema。此类提供了操作 schema 表示的方法。

在 migration 文件中，create_table 中的 t 对象实际上是此类型的实例。

class SomeMigration < ActiveRecord::Migration[8.1]
  def up
    create_table :foo do |t|
      puts t.class  # => "ActiveRecord::ConnectionAdapters::TableDefinition"
    end
  end

  def down
    ...
  end
end
方法
#
B
C
F
I
N
R
S
T
包含的模块

Attributes

[R] as
[R] check_constraints
[R] comment
[R] foreign_keys
[R] if_not_exists
[R] indexes
[R] name
[R] options
[R] temporary

类公共方法

new( conn, name, temporary: false, if_not_exists: false, options: nil, as: nil, comment: nil, ** )

Source: 显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 363
def initialize(
  conn,
  name,
  temporary: false,
  if_not_exists: false,
  options: nil,
  as: nil,
  comment: nil,
  **
)
  @conn = conn
  @columns_hash = {}
  @indexes = []
  @foreign_keys = []
  @primary_keys = nil
  @check_constraints = []
  @temporary = temporary
  @if_not_exists = if_not_exists
  @options = options
  @as = as
  @name = name
  @comment = comment
end

实例公共方法

[](name)

返回名为 name 的列的 ColumnDefinition。

Source: 显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 413
def [](name)
  @columns_hash[name.to_s]
end

belongs_to(*args, **options)

别名: references

check_constraint(expression, **options)

Source: 显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 517
def check_constraint(expression, **options)
  check_constraints << new_check_constraint_definition(expression, options)
end

column(name, type, index: nil, **options)

为表实例化一个新列。请参阅 connection.add_column 以了解可用选项。

附加选项包括

  • :index - 为列创建索引。可以是 true 或选项哈希。

此方法返回 self。

示例 ↑

# Assuming `td` is an instance of TableDefinition
td.column(:granted, :boolean, index: true)

简写示例 ↑

与其直接调用 column，您还可以使用默认类型的简写定义。它们使用类型作为方法名而不是参数，并允许在单个语句中定义多个列。

使用常规的 column 调用可以这样写

create_table :products do |t|
  t.column :shop_id,     :integer
  t.column :creator_id,  :integer
  t.column :item_number, :string
  t.column :name,        :string, default: "Untitled"
  t.column :value,       :string, default: "Untitled"
  t.column :created_at,  :datetime
  t.column :updated_at,  :datetime
end
add_index :products, :item_number

使用简写也可以这样写

create_table :products do |t|
  t.integer :shop_id, :creator_id
  t.string  :item_number, index: true
  t.string  :name, :value, default: "Untitled"
  t.timestamps null: false
end

为顶部的每种类型值都有一个简写方法。然后是 TableDefinition#timestamps，它将添加 created_at 和 updated_at 作为 datetime 类型。

TableDefinition#references 将添加一个命名合适的 _id 列，如果提供了 :polymorphic 选项，还将添加一个相应的 _type 列。如果 :polymorphic 是一个选项哈希，这些选项将在创建 _type 列时使用。:index 选项也将创建索引，类似于调用 add_index。所以这样写

create_table :taggings do |t|
  t.integer :tag_id, :tagger_id, :taggable_id
  t.string  :tagger_type
  t.string  :taggable_type, default: 'Photo'
end
add_index :taggings, :tag_id, name: 'index_taggings_on_tag_id'
add_index :taggings, [:tagger_id, :tagger_type]

使用 references 也可以这样写

create_table :taggings do |t|
  t.references :tag, index: { name: 'index_taggings_on_tag_id' }
  t.references :tagger, polymorphic: true
  t.references :taggable, polymorphic: { default: 'Photo' }, index: false
end

Source: 显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 484
def column(name, type, index: nil, **options)
  name = name.to_s
  type = type.to_sym if type

  raise_on_duplicate_column(name)
  @columns_hash[name] = new_column_definition(name, type, **options)

  if index
    index_options = index.is_a?(Hash) ? index : {}
    index(name, **index_options)
  end

  self
end

columns()

返回表中列的 ColumnDefinition 对象数组。

Source: 显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 410
def columns; @columns_hash.values; end

foreign_key(to_table, **options)

Source: 显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 513
def foreign_key(to_table, **options)
  foreign_keys << new_foreign_key_definition(to_table, options)
end

index(column_name, **options)

将索引选项添加到索引哈希中，以列名作为键。这主要用于跟踪需要在表创建后创建的索引。

index(:account_id, name: 'index_projects_on_account_id')

Source: 显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 509
def index(column_name, **options)
  indexes << [column_name, options]
end

references(*args, **options)

添加一个引用。

t.references(:user)
t.belongs_to(:supplier, foreign_key: true)
t.belongs_to(:supplier, foreign_key: true, type: :integer)

有关可使用的选项的详细信息，请参阅 connection.add_reference。

也别名为: belongs_to

Source: 显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 543
def references(*args, **options)
  args.each do |ref_name|
    ReferenceDefinition.new(ref_name, **options).add_to(self)
  end
end

remove_column(name)

从表中移除名为 name 的列。

remove_column(:account_id)

Source: 显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 501
def remove_column(name)
  @columns_hash.delete name.to_s
end

set_primary_key(table_name, id, primary_key, **options)

Source: 显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 387
def set_primary_key(table_name, id, primary_key, **options)
  if id && !as
    pk = primary_key || Base.get_primary_key(table_name.to_s.singularize)

    if id.is_a?(Hash)
      options.merge!(id.except(:type))
      id = id.fetch(:type, :primary_key)
    end

    if pk.is_a?(Array)
      primary_keys(pk)
    else
      primary_key(pk, id, **options)
    end
  end
end

timestamps(**options)

将 :datetime 类型的 :created_at 和 :updated_at 列追加到表中。请参阅 connection.add_timestamps

t.timestamps null: false

Source: 显示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 525
def timestamps(**options)
  options[:null] = false if options[:null].nil?

  if !options.key?(:precision) && @conn.supports_datetime_with_precision?
    options[:precision] = 6
  end

  column(:created_at, :datetime, **options)
  column(:updated_at, :datetime, **options)
end