@mlagie/sql-connector 1.2.3 → 1.3.0

package/README.md

@@ -149,6 +149,30 @@ const transferSchema = new Schema({
   2. **De supprimer le backup** après restauration ou non.
   3. Si vous refusez la suppression, le backup est renommé en `.ignored` et ne sera plus proposé.
 
+### Synchronisation intelligente des colonnes
+
+Lors de la synchronisation (`Model.syncAllTables()`), le module compare chaque colonne existante avec la définition du schéma JS :
+
+- **Type** : Si le type SQL attendu diffère de celui en base, la colonne est modifiée.
+- **Nullabilité** : Si la contrainte `NOT NULL` ou `NULL` diffère, la colonne est modifiée.  
+  > ⚠️ Une colonne `primary_key` est toujours considérée comme `NOT NULL` même si `required` n'est pas précisé.
+- **Valeur par défaut** : Si la valeur par défaut diffère, la colonne est modifiée.
+- **Unique** : Si la contrainte `UNIQUE` diffère, la colonne est modifiée.
+- **Primary key** : Si la contrainte `PRIMARY KEY` diffère, la colonne est modifiée.
+
+Seules les différences réelles entraînent une modification SQL, ce qui évite les migrations inutiles.
+
+> **Note :**  
+> Il est interdit de déclarer une colonne à la fois `primary_key: true` et `unique: true` dans le schéma JS.  
+> **Explication :** En SQL, une clé primaire (`PRIMARY KEY`) est déjà unique par définition et impose la contrainte `UNIQUE` et `NOT NULL` sur la colonne. Ajouter explicitement `unique: true` en plus de `primary_key: true` est redondant et provoque une erreur SQL ("Multiple primary key defined").  
+>  
+> **En résumé :**  
+> - Utilisez seulement `primary_key: true` pour une colonne qui doit être la clé primaire.  
+> - Utilisez `unique: true` pour une colonne qui doit être unique mais n'est pas la clé primaire.
+
+---
+
+
 #### Exemple d’utilisation
 
 ```js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mlagie/sql-connector",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "description": "Le module sql-connector permet de gérer les connexions à une base de données MySQL, de définir des schémas de tables, et d'interagir avec les données de manière simple et efficace.",
   "main": "index.js",
   "scripts": {

package/src/models/Model.js

@@ -6,6 +6,7 @@ const formatObject = require("../utils/formatObject");
 const fs = require('fs');
 const path = require('path');
 const glob = require('glob');
+const { ModelInstance } = require("./ModelInstance");
 
 function getFieldType(field) {
     if (typeof field === "object") {
@@ -51,6 +52,10 @@ function ifReservedKeywords(tableName) {
 }
 
 function getColumnDefinition(fieldName, field) {
+    if (field.primary_key && field.unique) {
+        throw new Error(`Field '${fieldName}' cannot be both PRIMARY KEY and UNIQUE.`);
+    }
+
     const fieldType = getFieldType(field);
     let colDef = "";
 
@@ -232,8 +237,50 @@ class Model {
             );
             let existingCols = columns.map(col => col.Field);
 
-            // --- Warn si oldName est présent dans le schéma ---
             for (const [fieldName, field] of Object.entries(model.schema.schemaDict)) {
+                if (existingCols.includes(fieldName)) {
+                    // 1. Récupère infos colonne
+                    const currentCol = columns.find(col => col.Field === fieldName);
+                    const [indexes] = await conn.promise().query(
+                        `SHOW INDEX FROM \`${model.name}\` WHERE Column_name = ?`, [fieldName]
+                    );
+
+                    // 2. Vérifie les propriétés principales
+                    let needModify = false;
+
+                    // Type
+                    const expectedType = sqlTypeMap[getFieldType(field)]?.toUpperCase();
+                    const dbType = currentCol.Type.toUpperCase().split('(')[0];
+                    if (expectedType !== dbType)
+                        needModify = true;
+
+                    // Nullability check
+                    const shouldBeNotNull = field.required === true || field.primary_key === true;
+                    if ((shouldBeNotNull && currentCol.Null === "YES") || (!shouldBeNotNull && currentCol.Null === "NO"))
+                        needModify = true;
+
+                    // Default
+                    if ((field.default ?? null) != (currentCol.Default ?? null))
+                        needModify = true;
+
+                    // Unique
+                    const isUniqueInDB = indexes.some(idx => idx.Non_unique === 0 && idx.Key_name !== 'PRIMARY');
+                    if (!!field.unique !== isUniqueInDB)
+                        needModify = true;
+
+                    // Primary key
+                    const isPrimaryInDB = indexes.some(idx => idx.Key_name === 'PRIMARY');
+                    if (!!field.primary_key !== isPrimaryInDB)
+                        needModify = true;
+
+                    // 3. Si différence, on modifie
+                    if (needModify) {
+                        const newColDef = getColumnDefinition(fieldName, field);
+                        const alterSQL = `ALTER TABLE \`${model.name}\` MODIFY COLUMN ${newColDef}`;
+                        await conn.promise().query(alterSQL);
+                    }
+                }
+                // --- Warn si oldName est présent dans le schéma ---
                 if (field.oldName) {
                     logs(`⚠️  Pensez à retirer la propriété 'oldName' du champ '${fieldName}' dans le schéma JS de '${model.name}' pour éviter des renommages inutiles à l'avenir.`);
                 }