修改資料庫表格的最佳作法

本文提供修改Adobe Commerce或協力廠商模組所建立之資料庫表格的最佳實務。 瞭解何時以及如何有效修改表格,有助於確保商務平台的長期可行性和穩定性。

從Magento 1和其他電子商務平台移轉,或使用來自Adobe Commerce Marketplace的模組,可能需要新增和儲存額外的資料。 您的第一反應可能是將資料行新增至資料庫表格,或是調整現有的資料行。 不過,您只能在有限的情況下修改核心Adobe Commerce表格(或協力廠商表格)。

為什麼Adobe建議避免修改

避免修改核心資料表的主要原因在於Adobe Commerce包含包含原始SQL查詢的基礎邏輯。 變更表格結構可能會造成難以疑難排解的意外副作用。 此變更也會影響DDL (資料定義語言)作業,對效能造成非預期和無法預測的影響。

避免變更資料庫表格結構的另一個原因是,如果核心開發團隊或第三方開發人員變更其資料庫表格的結構,則您的變更可能會導致問題。 例如,有一些核心資料庫資料表有一個名為additional_data的資料行。 這始終是text資料行型別。 然而,基於效能考量,核心團隊可能會將欄變更為longtext。 此型別的欄是JSON的別名。 透過轉換為此欄型別,該欄會增加效能和搜尋能力,但不會以text型別的形式存在。 您可以閱讀JSON資料型別中有關此主題的詳細資訊。

知道何時儲存或移除資料

Adobe建議您先決定是否需要儲存此資料。 如果您要從舊版系統行動資料,任何可移除的資料都會在移轉期間為您節省時間和精力。 (如果需要稍後存取資料,有一些方式可以封存資料。) 為了妥善管理應用程式和效能,您可以質疑儲存額外資料的要求。 您的目標是確保儲存資料是滿足企業需求(無法透過其他方式滿足)的需求。

舊版資料

如果您的專案包含舊有資料(如舊訂單或客戶記錄),請考慮其他查詢方法。 例如,如果企業僅需要存取資料以供偶爾參考,請考慮對託管於商務平台以外的舊資料庫實作外部搜尋,而非將舊資料移轉至Adobe Commerce。

此情況需要將資料庫移轉至伺服器,提供網頁介面來讀取資料,或訓練使用MySQL Workbench或類似工具。 將這個資料從新資料庫排除後,可讓開發團隊專注於新網站,而非疑難排解資料移轉問題,藉此加速移轉。

另一個將資料保留在商業外部,但可讓您即時使用的相關選項是運用其他工具,例如GraphQL mesh。 此選項會結合不同的資料來源,並將其傳回為單一回應。

例如,您可以stitch將來自外部資料庫的舊訂單(可能是已停止支援的舊Magento1網站)合併在一起。 然後使用GraphQL網格,將其顯示為客戶訂單歷史記錄的一部分。 這些舊訂單可與您目前Adobe Commerce環境中的訂單合併。

如需搭配GraphQL使用API網狀架構的詳細資訊,請參閱什麼是API網狀架構)和GraphQL網狀架構

使用擴充功能屬性移轉舊資料

如果您判斷舊版資料需要移轉,或新資料需要儲存在Adobe Commerce中,Adobe建議使用延伸屬性。 使用擴充功能屬性來儲存其他資料具備下列優點:

  • 您可以控制要儲存的資料和資料庫結構,以確保以正確的欄型別和正確的索引來儲存資料。
  • Adobe Commerce中的大部分實體都支援使用擴充屬性。
  • 擴充功能屬性是一種不受儲存影響的機制,可讓您靈活地將資料儲存在專案的最佳位置。

儲存位置的兩個範例是資料庫表格和Redis。 選擇位置時需要考慮的關鍵事項是,位置是否會帶來額外的複雜性,或影響效能。

考慮其他替代方案

作為開發人員,一定要考慮使用您Adobe Commerce環境以外的工具,例如GraphQL mesh和AdobeApp Builder。 這些工具可協助您保留資料的存取權,但對核心商務應用程式或其基礎資料庫表格沒有影響。 使用此方法,您可以透過API公開您的資料。 接著,將資料來源新增至App Builder設定。 使用GraphQL Mesh,您可以合併這些資料來源,並產生舊資料中提到的單一回應。

如需GraphQL Mesh的其他詳細資料,請參閱GraphQL Mesh閘道。 如需App BuilderAdobe的相關資訊,請參閱App Builder簡介

修改核心表格或協力廠商表格

如果您決定修改核心Adobe Commerce或協力廠商模組資料庫表格來儲存資料,請使用下列准則來將影響穩定度和效能的情況降至最低。

  • 僅新增欄。
  • 永遠不要修改現有資料行的​ type ​值。 例如,請勿將integer變更為varchar以滿足您獨特的使用案例。
  • 避免將欄新增至EAV屬性表格。 這些資料表已因邏輯和職責而超載。
  • 調整表格之前,請先決定表格的大小。 變更大型表格會影響部署,這可能會導致套用變更時延遲幾分鐘或幾小時。

修改外部資料庫表格的最佳作法

當您將資料行新增至核心資料庫表格或協力廠商表格時,Adobe建議遵循下列步驟:

  1. 在名稱空間中建立一個模組,使用代表您正在更新的專案之名稱。

    例如: app/code/YourCompany/Customer

  2. 建立適當的檔案以啟用模組(請參閱建立模組

  3. etc資料夾中建立名為db_schema.xml的檔案,並進行適當的變更。

    如果適用,請產生db_schema_whitelist.json檔案。 如需詳細資訊,請參閱宣告式結構描述

潛在影響

將欄新增至外部資料庫可能會以下列方式影響您的Adobe Commerce專案:

  • 升級可能會更複雜。
  • 如果修改的表格很大,則會影響部署。
  • 要移轉至新平台可能比較複雜。

避免修改核心表格的方法

您可以使用延伸屬性來避免修改Adobe Commerce資料庫表格。 另一種選擇是使用一些核心資料表上的特殊資料行(additional_data)來儲存資料,並以JSON編碼格式儲存。

將資料儲存在JSON編碼的資料欄中

某些核心表格有additional_data欄,其中包含JSON編碼資料。 此欄提供在一個欄位中對應其他資料的原生方式。 使用此方法可避免為小型簡單資料元素新增表格,這些元素儲存資料擷取的資訊,而不需要搜尋。 additional_data欄通常只適用於料號層次,不適用於整個報價單或訂單。

  • 使用additional_data欄位的優點

    • 不需要其他欄位,將欄數維持在最小。 這在銷售流程中很有幫助,因為其中已經涉及許多表格。 最好不要對這個已經複雜的程式增加更多複雜性。 此方法可滿足許多使用案例,但並非全部。
  • 缺點

    • 此方法僅適用於儲存唯讀資料。 發生此問題是因為我們的程式碼需要取消序列化才能修改和建置物件以新增相依性或資料庫關係。

    • 很難使用資料庫作業來搜尋這些欄位。 使用此方法搜尋時速度很慢。

    • 將資料儲存在additional_data欄中時,必須格外小心,避免觸發序列化或取消序列化作業,這些作業可能會建立無效的JSON來中斷程式碼,或在執行期間造成讀取錯誤。

    • 這些欄位必須在程式碼中清楚宣告,讓開發人員可輕鬆找到。

    • 其他可能發生且很難診斷的問題。 例如,對於某些原生PHP函式,如果您不使用核心應用程式提供的Adobe Commerce包裝函式方法,則轉換資料的結束結果可能會與預期格式不同。 請一律使用包裝函式,確保儲存或擷取資料的一致性和可預測性。

以下是具有additional_data欄的欄和結構的表格範例。

MariaDB [main]> DESCRIBE quote_item additional_data;
+-----------------+------+------+-----+---------+-------+
| Field           | Type | Null | Key | Default | Extra |
+-----------------+------+------+-----+---------+-------+
| additional_data | text | YES  |     | NULL    |       |
+-----------------+------+------+-----+---------+-------+
1 row in set (0.001 sec)


MariaDB [main]> DESCRIBE sales_order_item additional_data;
+-----------------+------+------+-----+---------+-------+
| Field           | Type | Null | Key | Default | Extra |
+-----------------+------+------+-----+---------+-------+
| additional_data | text | YES  |     | NULL    |       |
+-----------------+------+------+-----+---------+-------+
1 row in set (0.001 sec)

在2.4.3、2.4.4和2.4.5版中,有10個表格有資料行additional_data

MariaDB [magento]> SELECT DISTINCT TABLE_NAME FROM INFORMATION_SCHEMA.COLUMNS WHERE COLUMN_NAME IN ('additional_data') AND TABLE_SCHEMA='main';
+------------------------+
| TABLE_NAME             |
+------------------------+
| sales_shipment_item    |
| sales_creditmemo_item  |
| sales_invoice_item     |
| catalog_eav_attribute  |
| sales_order_payment    |
| quote_address_item     |
| quote_payment          |
| quote_item             |
| magento_reward_history |
| sales_order_item       |
+------------------------+
10 rows in set (0.020 sec)
recommendation-more-help
754cbbf3-3a3c-4af3-b6ce-9d34390f3a60