更多資訊請參考 rubyonrails.org:

複合主鍵

本指南介紹資料庫表格的複合主鍵。

閱讀本指南後，您將能夠

  • 建立具有複合主鍵的表格
  • 查詢具有複合主鍵的模型
  • 啟用您的模型，以使用複合主鍵進行查詢和關聯
  • 為使用複合主鍵的模型建立表單
  • 從控制器參數中擷取複合主鍵
  • 將資料庫固定裝置用於具有複合主鍵的表格

1 什麼是複合主鍵？

有時，單一欄位的值不足以唯一識別表格的每一列，需要結合兩個或多個欄位。當使用沒有單一 id 欄位作為主鍵的舊版資料庫結構描述時，或當變更結構描述以進行分片或多租戶時，可能會發生這種情況。

複合主鍵會增加複雜性，並且可能比單一主鍵欄位慢。在使用複合主鍵之前，請確保您的使用案例需要複合主鍵。

2 複合主鍵遷移

您可以透過將 :primary_key 選項傳遞給 create_table 並使用陣列值來建立具有複合主鍵的表格

class CreateProducts < ActiveRecord::Migration[8.0]
  def change
    create_table :products, primary_key: [:store_id, :sku] do |t|
      t.integer :store_id
      t.string :sku
      t.text :description
    end
  end
end

3 查詢模型

3.1 使用 #find

如果您的表格使用複合主鍵，您需要在使用 #find 來尋找記錄時傳遞陣列

# Find the product with store_id 3 and sku "XYZ12345"
irb> product = Product.find([3, "XYZ12345"])
=> #<Product store_id: 3, sku: "XYZ12345", description: "Yellow socks">

上述的 SQL 等效語句是

SELECT * FROM products WHERE store_id = 3 AND sku = "XYZ12345"

若要使用複合 ID 尋找多個記錄，請將陣列的陣列傳遞給 #find

# Find the products with primary keys [1, "ABC98765"] and [7, "ZZZ11111"]
irb> products = Product.find([[1, "ABC98765"], [7, "ZZZ11111"]])
=> [
  #<Product store_id: 1, sku: "ABC98765", description: "Red Hat">,
  #<Product store_id: 7, sku: "ZZZ11111", description: "Green Pants">
]

上述的 SQL 等效語句是

SELECT * FROM products WHERE (store_id = 1 AND sku = 'ABC98765' OR store_id = 7 AND sku = 'ZZZ11111')

具有複合主鍵的模型在排序時也會使用完整的複合主鍵

irb> product = Product.first
=> #<Product store_id: 1, sku: "ABC98765", description: "Red Hat">

上述的 SQL 等效語句是

SELECT * FROM products ORDER BY products.store_id ASC, products.sku ASC LIMIT 1

3.2 使用 #where

#where 的雜湊條件可以使用類似元組的語法指定。這對於查詢複合主鍵關係非常有用

Product.where(Product.primary_key => [[1, "ABC98765"], [7, "ZZZ11111"]])

3.2.1 使用 :id 的條件

當在 find_by 和 where 等方法上指定條件時，使用 id 將會與模型上的 :id 屬性進行比對。這與 find 不同，後者傳遞的 ID 應該是主鍵值。

當在 :id 不是主鍵的模型上使用 find_by(id:) 時，例如複合主鍵模型，請務必小心。請參閱 Active Record 查詢指南以了解更多資訊。

4 具有複合主鍵的模型之間的關聯

Rails 通常可以推斷關聯模型之間的主鍵-外部索引鍵關係。但是，在處理複合主鍵時，Rails 通常預設僅使用複合鍵的一部分，通常是 id 欄位，除非另有明確指示。此預設行為僅在模型的複合主鍵包含 :id 欄位且該欄位對所有記錄都是唯一時才有效。

請考慮以下範例

class Order < ApplicationRecord
  self.primary_key = [:shop_id, :id]
  has_many :books
end

class Book < ApplicationRecord
  belongs_to :order
end

在此設定中，Order 具有由 [:shop_id, :id] 組成的複合主鍵，而 Book 屬於 Order。Rails 會假設 :id 欄位應該用作訂單及其書籍之間關聯的主鍵。它會推斷書籍表格上的外部索引鍵欄位是 :order_id。

以下我們建立一個 Order 和一個與之關聯的 Book

order = Order.create!(id: [1, 2], status: "pending")
book = order.books.create!(title: "A Cool Book")

若要存取書籍的訂單，我們需要重新載入關聯

book.reload.order

這樣做時，Rails 將會產生以下 SQL 來存取訂單

SELECT * FROM orders WHERE id = 2

您可以看到 Rails 在其查詢中使用訂單的 id，而不是 shop_id 和 id。在這種情況下，id 足夠，因為模型的複合主鍵確實包含 :id 欄位，且該欄位對所有記錄都是唯一的。

但是，如果未滿足上述要求，或者您想要在關聯中使用完整的複合主鍵，您可以在關聯上設定 foreign_key: 選項。此選項會在關聯上指定複合外部索引鍵；在查詢關聯的記錄時，將會使用外部索引鍵中的所有欄位。例如

class Author < ApplicationRecord
  self.primary_key = [:first_name, :last_name]
  has_many :books, foreign_key: [:first_name, :last_name]
end

class Book < ApplicationRecord
  belongs_to :author, foreign_key: [:author_first_name, :author_last_name]
end

在此設定中，Author 具有由 [:first_name, :last_name] 組成的複合主鍵，而 Book 屬於 Author，並具有複合外部索引鍵 [:author_first_name, :author_last_name]。

建立一個 Author 和一個與之關聯的 Book

author = Author.create!(first_name: "Jane", last_name: "Doe")
book = author.books.create!(title: "A Cool Book", author_first_name: "Jane", author_last_name: "Doe")

若要存取書籍的作者，我們需要重新載入關聯

book.reload.author

Rails 現在將在 SQL 查詢中使用複合主鍵的 :first_name *和* :last_name

SELECT * FROM authors WHERE first_name = 'Jane' AND last_name = 'Doe'

5 複合主鍵模型的表單

也可以為複合主鍵模型建立表單。請參閱 表單輔助方法指南以了解有關表單產生器語法的更多資訊。

假設有一個具有複合鍵 [:author_id, :id] 的 @book 模型物件

@book = Book.find([2, 25])
# => #<Book id: 25, title: "Some book", author_id: 2>

以下表單

<%= form_with model: @book do |form| %>
  <%= form.text_field :title %>
  <%= form.submit %>
<% end %>

輸出

<form action="/books/2_25" method="post" accept-charset="UTF-8" >
  <input name="authenticity_token" type="hidden" value="..." />
  <input type="text" name="book[title]" id="book_title" value="My book" />
  <input type="submit" name="commit" value="Update Book" data-disable-with="Update Book">
</form>

請注意，產生的 URL 包含由底線分隔的 author_id 和 id。提交後，控制器可以從參數中擷取主鍵值並更新記錄。請參閱下一節以了解更多詳細資訊。

6 複合鍵參數

複合鍵參數在一個參數中包含多個值。因此，我們需要能夠擷取每個值並將其傳遞給 Active Record。我們可以利用 extract_value 方法來達到此目的。

假設有以下控制器

class BooksController < ApplicationController
  def show
    # Extract the composite ID value from URL parameters.
    id = params.extract_value(:id)
    # Find the book using the composite ID.
    @book = Book.find(id)
    # use the default rendering behaviour to render the show view.
  end
end

以及以下路由

get "/books/:id", to: "books#show"

當使用者開啟 URL /books/4_2 時，控制器將擷取複合鍵值 ["4", "2"] 並將其傳遞給 Book.find，以便在視圖中呈現正確的記錄。extract_value 方法可以用於從任何分隔的參數中擷取陣列。

7 複合主鍵固定裝置

複合主鍵表格的固定裝置與一般表格非常相似。當使用 id 欄位時，該欄位可以像往常一樣省略

class Book < ApplicationRecord
  self.primary_key = [:author_id, :id]
  belongs_to :author
end

# books.yml
alices_adventure_in_wonderland:
  author_id: <%= ActiveRecord::FixtureSet.identify(:lewis_carroll) %>
  title: "Alice's Adventures in Wonderland"

但是，為了支援複合主鍵關係，您必須使用 composite_identify 方法

class BookOrder < ApplicationRecord
  self.primary_key = [:shop_id, :id]
  belongs_to :order, foreign_key: [:shop_id, :order_id]
  belongs_to :book, foreign_key: [:author_id, :book_id]
end

# book_orders.yml
alices_adventure_in_wonderland_in_books:
  author: lewis_carroll
  book_id: <%= ActiveRecord::FixtureSet.composite_identify(
              :alices_adventure_in_wonderland, Book.primary_key)[:id] %>
  shop: book_store
  order_id: <%= ActiveRecord::FixtureSet.composite_identify(
              :books, Order.primary_key)[:id] %>
回到頂端