参照元テーブルから参照先テーブルを参照
適応バージョン
- 1.0.0
- 1.1.0
- 1.1.1
- 1.1.6
- 1.2.0
- 1.2.6
- 2.0.0
- 2.0.1
- 2.0.3
- 2.1.0
- 2.2.1
- 2.3.2
- 2.3.8
- 3.0.0
- 3.0.5
- 3.0.7
- 3.0.9
- 3.1.0
- 3.2.3
- 3.2.8
- 3.2.13
- 4.0.2
- 4.1.8
- 4.2.1
- 4.2.7
- 4.2.9
- 5.0.0.1
- 5.1.7
- 5.2.3
- 6.0.2.1
- 7.0.0
説明
参照元テーブルから参照先テーブルを参照するための設定
使い方
belongs_to(関連モデル名 [, scope, オプション])
オプション
| オプション | 説明 | デフォルト値 |
|---|---|---|
| :class_name | 関連を設定するモデル名を指定。関連名と参照先のクラス名を異なるものにしたい場合に指定 | |
| :foreign_key | 参照先を参照するための外部キーの名前を指定 | :foreign_key |
| :foreign_type | 参照先を参照するための外部キーの型を指定 | :foreign_type |
| :primary_key | 主キーを指定 | id |
| :dependent | 値を:destroyにすると、参照先が削除される場合に参照元もDBから削除 | |
| :counter_cache | カウンタキャッシュを使用するか | |
| :polymorphic | ポリモーフィック関連を定義 | |
| :validate | 関連オブジェクトのバリデーションの有無 | false |
| :autosave | 親のオブジェクトが保存されると、ロードされたオブジェクトも保存するか | |
| :touch | updated_atまたはupdated_onが保存または破棄された場合に現在の時刻を設定するか | |
| :inverse_of | モデルを指定 | |
| :optional | 関連付けの確認は行わないか？ | |
| :required | 関連付けの確認するか？ | true |
| :default | 特定のカラムの初期化 |
追加されているメソッド
| メソッド | 説明 |
|---|---|
| association=(associate) | 引数を参照元オブジェクトとして設定。それ以外の参照元との関連は破棄 |
| build_association(attributes = {}) | 新しいオブジェクトを生成。引数にはオブジェクトを生成するのに必要なパラメータを指定。この時点では保存されない |
| create_association(attributes = {}) | 新しいオブジェクトを生成して保存。引数にはオブジェクトを生成するのに必要なパラメータを指定 |
| create_association!(attributes = {}) | 新しいオブジェクトを生成して保存。引数にはオブジェクトを生成するのに必要なパラメータを指定。失敗時に例外を発生 |
| reload_association | キャッシュではなくデータベースから直接値を取得 |
保存
参照元オブジェクトが未保存の場合
- saveのタイミングで外部キーが設定され保存
- 参照先オブジェクトが未保存であれば、saveのタイミングで自動的に保存
参照元オブジェクトが保存済みの場合
- 保存済みの場合には、生成したタイミングで自動的にDBに保存
例
UserとProjectの関係
基本的な使い方
belongs_to :user
クラス名としてUserを指定
belongs_to :admin_user, class_name: "User"
user_id = 2を抽出
belongs_to :user, conditions: "user_id = 2"
逆順で並び替える
belongs_to :user, order: "id DESC"
データを削除するときに関連するテーブルを削除
belongs_to :user, dependent: :destroy
外部キーを指定
belongs_to :user, foreign_key: "blog_id"
特定のキーの初期化
belongs_to :account, default: -> { company.account }
ソースコード
* [GitHub](https://github.com/rails/rails/blob/f33d52c95217212cbacc8d5e44b5a8e3cdc6f5b3/activerecord/lib/active_record/associations.rb#L1657)