跳到內容 跳到搜尋

Active Record 連線適配器表格定義

以抽象的方式表示 SQL 表格架構。此類別提供用於操作架構表示法的各種方法。

在遷移檔案內部，create_table 中的 t 物件的類型實際上是此類型的

class SomeMigration < ActiveRecord::Migration[8.0]
  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
包含模組

屬性

[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, ** )

來源: 顯示 | 在 GitHub 中

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 367
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。

來源: 顯示 | 在 GitHub 中

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

belongs_to(*args, **options)

別名為: references

check_constraint(expression, **options)

來源: 顯示 | 在 GitHub 中

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 521
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 作為日期時間新增。

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

來源：顯示 | 於 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 488
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 物件陣列。

來源：顯示 | 於 GitHub 上

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

foreign_key(to_table, **options)

來源：顯示 | 於 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 517
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')

來源：顯示 | 於 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 513
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

來源：顯示 | 於 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 547
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)

來源：顯示 | 於 GitHub 上

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

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

來源：顯示 | 於 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 391
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

時間戳記(**options)

附加 :datetime 欄位 :created_at 和 :updated_at 到資料表。請參閱 connection.add_timestamps

t.timestamps null: false

原始碼：顯示 | 在 GitHub 上

# File activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb, line 529
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