古いバージョンのドキュメントです。最新のバージョンはRails7.0.0

Railsドキュメント(v6.0.2.1)

多対多の関連を宣言

説明

多対多の関連付けを指定

使い方

has_and_belongs_to_many(関連モデル名 [, scope, オプション])

オプション

オプション 説明
:class_name 関連モデルのクラス名を指定。関連モデル名から推測できない場合のみ指定
:join_table 結合テーブルの名前を指定
:foreign_key 多対多の関連で使用する外部キーの名前を指定
:association_foreign_key 多対多の関係で関連先への外部キーを指定
:validate 現在のモデルを保存する場合、関連先のバリデーションを実行
:autosave 親モデルに合わせて、保存や削除

使えるようになるメソッド

メソッド 説明
collection(force_reload = false) 多対多でひも付いた先のモデルである一覧を取得
collection«(object, …) 1つ以上のモデルを多対多の関連に追加
collection.delete(object, …) 1つ以上のモデルを多対多の関連から外す
collection.destroy(object, …) 1つ以上のモデルを多対多の関連から外す
collection=objects 多対多でひも付いたモデルを更新
collection_singular_ids 多対多でひも付いたモデルのidの配列を取得
collection_singular_ids=ids 多対多でひも付いたモデルのidが指定された物に更新
collection.clear 多対多の関連をすべて削除
collection.empty? 多対多の関連にあるモデルが1つもないときにtrue
collection.size 多対多でひも付いたモデル数を取得
collection.find(id) 多対多の関連モデルでfindを実行
collection.exists?(…) 与えられた条件に一致するモデルが存在するか確認
collection.build(attributes = {}) 新しいモデルを作り、多対多で関連付けるがDBは更新しない
collection.create(attributes = {}) 新しいモデルを作り、多対多で関連付けてDBを更新
collection.reload リロード

UserとProjectの関係

マイグレーションファイル
class CreateUsersProjectsTable < ActiveRecord::Migration
  def self.up
    create_table :users_projects, id: false do |t|
      t.integer :user_id
      t.integer :project_id
    end
  end
  def self.down
    drop_table :users_projects
  end
end
Userモデル
class User < ActiveRecord::Base
  has_and_belongs_to_many :projects
end
Projectモデル
class Project < ActiveRecord::Base
  has_and_belongs_to_many :users
end

ソースコード