[PaaS uniquement]{class="badge informative" title="S’applique uniquement aux projets Adobe Commerce on Cloud (infrastructure PaaS gérée par Adobe) et aux projets On-premise."}

Bonnes pratiques relatives à la modification des tables de base de données

Cet article présente les bonnes pratiques pour modifier les tables de base de données créées par des modules Adobe Commerce ou tiers. Comprendre quand et comment modifier efficacement les tableaux permet d’assurer la viabilité et la stabilité à long terme de votre plateforme commerciale.

La migration à partir de Magento 1 et d’autres plateformes d’e-commerce, ou l’utilisation de modules du Marketplace Adobe Commerce, peut nécessiter l’ajout et l’enregistrement de données supplémentaires. Votre premier instinct peut être d'ajouter une colonne à une table de base de données ou d'en ajuster une existante. Cependant, vous ne devez modifier une table de Adobe Commerce principale (ou une table de fournisseurs tiers) que dans des situations limitées.

Pourquoi Adobe recommande d’éviter les modifications

La principale raison pour laquelle vous devez éviter de modifier les tables principales est qu’Adobe Commerce inclut une logique sous-jacente qui contient des requêtes SQL brutes. Les modifications apportées à la structure du tableau peuvent provoquer des effets indésirables inattendus difficiles à résoudre. La modification peut également affecter les opérations DDL (Data Definition Language), ce qui a des répercussions inattendues et imprévisibles sur les performances.

Si vous évitez de modifier la structure des tables de la base de données, c'est également parce que vos modifications peuvent entraîner des problèmes si l'équipe de développement principale ou des développeurs tiers modifient la structure de leurs tables de base de données. Par exemple, quelques tables de base de données principales comportent une colonne appelée additional_data. Il s’agit toujours d’un type de colonne text. Toutefois, pour des raisons de performances, l’équipe principale peut modifier la colonne en longtext. Ce type de colonne est un alias pour JSON. En effectuant la conversion en ce type de colonne, vous augmenterez les performances et la capacité de recherche de cette colonne, qui n’existe pas en tant que type de text. Vous pouvez en savoir plus à ce sujet dans Type de données JSON.

Savoir quand enregistrer ou supprimer des données

Adobe vous recommande de déterminer d’abord si vous devez enregistrer ces données. Si vous déplacez des données à partir d’un système hérité, toute suppression de données vous permet de gagner du temps et vous évite des tâches inutiles lors de la migration. (Il existe des moyens d’archiver les données si elles doivent être consultées ultérieurement.) Pour être un bon gestionnaire de l’application et de la performance, il est acceptable de mettre en doute une demande d’enregistrement de données supplémentaires. Votre objectif est de vous assurer que l’enregistrement des données est une exigence pour répondre à un besoin commercial qui ne peut pas être satisfait d’une autre manière.

Données héritées

Si votre projet contient des données héritées, telles que d’anciennes commandes ou des enregistrements de client, envisagez une autre méthode de recherche. Par exemple, si l’entreprise a besoin d’accéder aux données uniquement à titre de référence occasionnelle, envisagez d’implémenter une recherche externe de l’ancienne base de données hébergée en dehors de la plateforme commerciale au lieu de migrer les anciennes données vers Adobe Commerce.

Dans ce cas, la base de données doit être migrée vers un serveur, offrant soit une interface web pour lire les données, soit une formation à l’utilisation de MySQL Workbench ou d’autres outils similaires. L’exclusion de ces données de la nouvelle base de données accélère la migration en permettant à l’équipe de développement de se concentrer sur le nouveau site plutôt que de résoudre les problèmes de migration des données.

Une autre option permettant de conserver les données externes à Commerce, mais de les utiliser en temps réel, consisterait à utiliser d’autres outils, tels que le maillage GraphQL. Cette option combine différentes sources de données et les renvoie sous la forme d’une réponse unique.

Par exemple, vous pouvez stitch d’anciennes commandes à partir d’une base de données externe, par exemple l’ancien site Magento 1 qui est mis hors service. Ensuite, à l’aide du maillage GraphQL, affichez-les dans l’historique des commandes des clients. Ces anciennes commandes peuvent être combinées avec les commandes de votre environnement de Adobe Commerce actuel.

Pour plus d’informations sur l’utilisation du maillage API avec GraphQL, voir En quoi consiste le maillage API ​) et Passerelle du maillage GraphQL.

Migration des données héritées avec des attributs d’extension

Si vous déterminez que les données héritées nécessitent une migration ou que les nouvelles données doivent être enregistrées dans Adobe Commerce, Adobe recommande d’utiliser des attributs d’extension. L’utilisation d’attributs d’extension pour enregistrer des données supplémentaires offre les avantages suivants :

Deux exemples d’emplacements de stockage sont les tables de base de données et les Redis. Les éléments clés à prendre en compte lors du choix d’un emplacement sont les suivants : l’emplacement introduit une complexité supplémentaire ou affecte les performances.

Envisager d’autres alternatives

En tant que développeur, il est essentiel de toujours envisager d’utiliser des outils en dehors de votre environnement de Adobe Commerce, tels que le maillage GraphQL et Adobe App Builder. Ces outils peuvent vous aider à conserver l’accès aux données, mais n’ont aucun impact sur l’application commerciale principale ou ses tables de base de données sous-jacentes. Grâce à cette approche, vous exposez vos données par le biais d’une API. Ajoutez ensuite une source de données à votre configuration App Builder. À l’aide du maillage GraphQL, vous pouvez combiner ces sources de données et produire une seule réponse, comme indiqué dans données héritées.

Pour plus d’informations sur le maillage GraphQL, voir Passerelle du maillage GraphQL. Pour plus d’informations sur Adobe App Builder, voir Présentation d’App Builder.

Modifier une table principale ou une table tierce

Si vous décidez de stocker des données en modifiant un Adobe Commerce principal ou une table de base de données de module tiers, suivez les instructions suivantes afin de minimiser l’impact sur la stabilité et les performances.

Bonnes pratiques pour modifier une table de base de données externe

Adobe recommande de suivre les étapes suivantes lorsque vous ajoutez une colonne à une table de base de données principale ou à une table tierce :

Impacts potentiels

L’ajout d’une colonne à une base de données externe peut avoir un impact sur votre projet Adobe Commerce des manières suivantes :

Méthodes pour éviter de modifier des tables principales

Vous pouvez éviter de modifier les tables de la base de données Adobe Commerce à l’aide d’attributs extension. Une autre alternative consiste à utiliser une colonne spéciale (additional_data) qui se trouve sur quelques tables principales pour stocker les données et les enregistrer au format codé JSON.

Enregistrer des données dans une colonne de données codée en JSON

Certains tableaux principaux comportent une colonne additional_data qui contient des données codées JSON. Cette colonne offre un moyen natif de mapper des données supplémentaires dans un champ. L’utilisation de cette méthode évite d’ajouter un tableau pour les petits éléments de données simples qui stockent des informations pour la récupération des données sans avoir à effectuer de recherche. La colonne additional_data n'est généralement disponible qu'au niveau de l'article, et non pour l'ensemble du devis ou de la commande.

Voici des exemples de tableaux qui ont la colonne et la structure pour la colonne 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)

Dans les versions 2.4.3, 2.4.4 et 2.4.5, dix tableaux comportent la colonne 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)