@dbml/connector 3.13.1 → 3.13.2

package/__tests__/connectors/mssql/expect-out-files/schema.json

@@ -111,6 +111,13 @@
       "note": {
         "value": ""
       }
+    },
+    {
+      "name": "TestDescriptionTable",
+      "schemaName": "dbo",
+      "note": {
+        "value": "This is the custom comment name on table."
+      }
     }
   ],
   "fields": {
@@ -1611,6 +1618,34 @@
           "value": ""
         }
       }
+    ],
+    "dbo.TestDescriptionTable": [
+      {
+        "name": "Id",
+        "type": {
+          "type_name": "int(10)",
+          "schemaName": null
+        },
+        "dbdefault": null,
+        "not_null": false,
+        "increment": false,
+        "note": {
+          "value": "Primary key identifier."
+        }
+      },
+      {
+        "name": "Name",
+        "type": {
+          "type_name": "nvarchar(100)",
+          "schemaName": null
+        },
+        "dbdefault": null,
+        "not_null": false,
+        "increment": false,
+        "note": {
+          "value": "Name of the entity."
+        }
+      }
     ]
   },
   "enums": [
@@ -2002,4 +2037,4 @@
       }
     }
   }
-}
+}

package/__tests__/connectors/mssql/out-files/schema.json

@@ -97,6 +97,27 @@
       "note": {
         "value": ""
       }
+    },
+    {
+      "name": "AddressInfo",
+      "schemaName": "dbo",
+      "note": {
+        "value": ""
+      }
+    },
+    {
+      "name": "AddressInfo2",
+      "schemaName": "dbo",
+      "note": {
+        "value": ""
+      }
+    },
+    {
+      "name": "TestDescriptionTable",
+      "schemaName": "dbo",
+      "note": {
+        "value": "This is the custom comment name on table."
+      }
     }
   ],
   "fields": {
@@ -454,7 +475,7 @@
       {
         "name": "status",
         "type": {
-          "type_name": "chk_status",
+          "type_name": "chk_status_status",
           "schemaName": "dbo"
         },
         "dbdefault": {
@@ -1141,7 +1162,7 @@
         },
         "dbdefault": {
           "type": "string",
-          "value": "<Books>\r\n    <Book>\r\n      <Title>The Great Gatsby</Title>\r\n      <Author>F. Scott Fitzgerald</Author>\r\n      <Year>1925</Year>\r\n      <Price>10.99</Price>\r\n      <Publisher>Scribner</Publisher>\r\n      <Location>New York</Location>\r\n      <Genre>Fiction</Genre>\r\n      <Subgenre>Classic</Subgenre>\r\n    </Book>\r\n    <Book>\r\n      <Title>1984</Title>\r\n      <Author>George Orwell</Author>\r\n      <Year>1949</Year>\r\n      <Price>8.99</Price>\r\n      <Publisher>Secker & Warburg</Publisher>\r\n      <Location>London</Location>\r\n      <Genre>Dystopian</Genre>\r\n      <Subgenre>Political Fiction</Subgenre>\r\n    </Book>\r\n  </Books>"
+          "value": "<Books>\n    <Book>\n      <Title>The Great Gatsby</Title>\n      <Author>F. Scott Fitzgerald</Author>\n      <Year>1925</Year>\n      <Price>10.99</Price>\n      <Publisher>Scribner</Publisher>\n      <Location>New York</Location>\n      <Genre>Fiction</Genre>\n      <Subgenre>Classic</Subgenre>\n    </Book>\n    <Book>\n      <Title>1984</Title>\n      <Author>George Orwell</Author>\n      <Year>1949</Year>\n      <Price>8.99</Price>\n      <Publisher>Secker & Warburg</Publisher>\n      <Location>London</Location>\n      <Genre>Dystopian</Genre>\n      <Subgenre>Political Fiction</Subgenre>\n    </Book>\n  </Books>"
         },
         "not_null": false,
         "increment": false,
@@ -1275,7 +1296,7 @@
       {
         "name": "gender",
         "type": {
-          "type_name": "chk_gender",
+          "type_name": "chk_gender_gender",
           "schemaName": "dbo"
         },
         "dbdefault": null,
@@ -1515,11 +1536,121 @@
           "value": ""
         }
       }
+    ],
+    "dbo.AddressInfo": [
+      {
+        "name": "AddressID",
+        "type": {
+          "type_name": "CK_Address_Valid_AddressID_AddressFormatID",
+          "schemaName": "dbo"
+        },
+        "dbdefault": null,
+        "not_null": true,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      },
+      {
+        "name": "AddressFormatID",
+        "type": {
+          "type_name": "CK_Address_Valid_AddressID_AddressFormatID",
+          "schemaName": "dbo"
+        },
+        "dbdefault": null,
+        "not_null": true,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      }
+    ],
+    "dbo.AddressInfo2": [
+      {
+        "name": "A1",
+        "type": {
+          "type_name": "CK_Address_Valid2_A1",
+          "schemaName": "dbo"
+        },
+        "dbdefault": null,
+        "not_null": true,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      },
+      {
+        "name": "A2",
+        "type": {
+          "type_name": "CK_Address_Valid2_A2_A3",
+          "schemaName": "dbo"
+        },
+        "dbdefault": null,
+        "not_null": true,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      },
+      {
+        "name": "A3",
+        "type": {
+          "type_name": "CK_Address_Valid2_A2_A3",
+          "schemaName": "dbo"
+        },
+        "dbdefault": null,
+        "not_null": true,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      },
+      {
+        "name": "A4",
+        "type": {
+          "type_name": "CK_Address_Valid2_A4",
+          "schemaName": "dbo"
+        },
+        "dbdefault": null,
+        "not_null": true,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      }
+    ],
+    "dbo.TestDescriptionTable": [
+      {
+        "name": "Id",
+        "type": {
+          "type_name": "int(10)",
+          "schemaName": null
+        },
+        "dbdefault": null,
+        "not_null": false,
+        "increment": false,
+        "note": {
+          "value": "Primary key identifier."
+        }
+      },
+      {
+        "name": "Name",
+        "type": {
+          "type_name": "nvarchar(100)",
+          "schemaName": null
+        },
+        "dbdefault": null,
+        "not_null": false,
+        "increment": false,
+        "note": {
+          "value": "Name of the entity."
+        }
+      }
     ]
   },
   "enums": [
     {
-      "name": "chk_status",
+      "name": "chk_status_status",
       "schemaName": "dbo",
       "values": [
         {
@@ -1540,7 +1671,7 @@
       ]
     },
     {
-      "name": "chk_gender",
+      "name": "chk_gender_gender",
       "schemaName": "dbo",
       "values": [
         {
@@ -1553,6 +1684,57 @@
           "name": "Male"
         }
       ]
+    },
+    {
+      "name": "CK_Address_Valid_AddressID_AddressFormatID",
+      "schemaName": "dbo",
+      "values": [
+        {
+          "name": "176029FA-D6D3-49E1-A48C-000000000002"
+        },
+        {
+          "name": "176029FA-D6D3-49E1-A48C-000000000001"
+        }
+      ]
+    },
+    {
+      "name": "CK_Address_Valid2_A1",
+      "schemaName": "dbo",
+      "values": [
+        {
+          "name": "333"
+        },
+        {
+          "name": "2222"
+        },
+        {
+          "name": "1111"
+        }
+      ]
+    },
+    {
+      "name": "CK_Address_Valid2_A2_A3",
+      "schemaName": "dbo",
+      "values": [
+        {
+          "name": "2222"
+        },
+        {
+          "name": "1111"
+        }
+      ]
+    },
+    {
+      "name": "CK_Address_Valid2_A4",
+      "schemaName": "dbo",
+      "values": [
+        {
+          "name": "3333"
+        },
+        {
+          "name": "2222"
+        }
+      ]
     }
   ],
   "refs": [

package/dist/connectors/mssqlConnector.d.ts

@@ -1,3 +1,3 @@
 import { DatabaseSchema } from './types';
 declare const fetchSchemaJson: (connection: string) => Promise<DatabaseSchema>;
-export { fetchSchemaJson };
+export { fetchSchemaJson, };

package/dist/connectors/mssqlConnector.js

@@ -131,15 +131,15 @@ const getEnumValues = (definition, constraint_name) => {
     Object.keys(colMap).forEach((key) => {
         if (processedKeys.has(key))
             return;
-        let mergedColumns = [key];
-        const values = colMap[key];
+        const mergedColumns = [key];
+        const colValues = colMap[key];
         Object.keys(colMap).forEach((innerKey) => {
-            if (key !== innerKey && arraysEqual(values, colMap[innerKey])) {
+            if (key !== innerKey && arraysEqual(colValues, colMap[innerKey])) {
                 mergedColumns.push(innerKey);
                 processedKeys.add(innerKey);
             }
         });
-        const enumValues = values.map((value) => ({ name: value }));
+        const enumValues = colValues.map((value) => ({ name: value }));
         result.push({ columns: mergedColumns, enumValues, constraint_name: `${constraint_name}_${mergedColumns.join('_')}` });
         processedKeys.add(key);
     });
@@ -196,11 +196,11 @@ const generateTablesFieldsAndEnums = async (client, schemas) => {
         JOIN sys.columns c ON t.object_id = c.object_id
         JOIN sys.types ty ON c.user_type_id = ty.user_type_id
         LEFT JOIN sys.extended_properties p ON p.major_id = t.object_id
-          AND p.name = 'MS_Description'
+          AND p.name like '%description%'
           AND p.minor_id = 0 -- Ensure minor_id is 0 for table comments
         LEFT JOIN sys.extended_properties ep ON ep.major_id = c.object_id
           AND ep.minor_id = c.column_id
-          AND ep.name = 'MS_Description'
+          AND ep.name like '%description%'
       WHERE
         t.type = 'U' -- User-defined tables
     ),
@@ -347,10 +347,10 @@ const generateRefs = async (client, schemas) => {
     const endpointsEqual = (ep1, ep2) => {
         if (ep1.length !== ep2.length)
             return false;
-        return ep1.every((endpoint, index) => endpoint.tableName === ep2[index].tableName &&
-            endpoint.schemaName === ep2[index].schemaName &&
-            endpoint.fieldNames.length === ep2[index].fieldNames.length &&
-            endpoint.fieldNames.every((field, fieldIndex) => field === ep2[index].fieldNames[fieldIndex]));
+        return ep1.every((endpoint, index) => endpoint.tableName === ep2[index].tableName
+            && endpoint.schemaName === ep2[index].schemaName
+            && endpoint.fieldNames.length === ep2[index].fieldNames.length
+            && endpoint.fieldNames.every((field, fieldIndex) => field === ep2[index].fieldNames[fieldIndex]));
     };
     refsQueryResult.recordset.forEach((refRow) => {
         const { table_schema, fk_constraint_name, table_name, column_names, foreign_table_schema, foreign_table_name, foreign_column_names, on_delete, on_update, } = refRow;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbml/connector",
-  "version": "3.13.1",
+  "version": "3.13.2",
   "description": "This package was created to fetch the schema JSON from many kind of databases.",
   "author": "huy.phung.sw@gmail.com",
   "license": "MIT",
@@ -44,5 +44,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "8baea3c6a612f433f188efd6df5d24d1d5e16f2c"
+  "gitHead": "f9be31a9b9b3b509183637dc2527f1be8c260add"
 }

package/src/connectors/mssqlConnector.ts

@@ -6,7 +6,6 @@ import {
   DefaultInfo,
   DefaultType,
   Enum,
-  EnumValue,
   Field,
   FieldsDictionary,
   IndexesDictionary,
@@ -155,16 +154,16 @@ const getEnumValues = (definition: string, constraint_name: string): EnumValuesD
   Object.keys(colMap).forEach((key) => {
     if (processedKeys.has(key)) return;
 
-    let mergedColumns = [key];
-    const values = colMap[key];
+    const mergedColumns = [key];
+    const colValues = colMap[key];
 
     Object.keys(colMap).forEach((innerKey) => {
-      if (key !== innerKey && arraysEqual(values, colMap[innerKey])) {
+      if (key !== innerKey && arraysEqual(colValues, colMap[innerKey])) {
         mergedColumns.push(innerKey);
         processedKeys.add(innerKey);
       }
     });
-    const enumValues = values.map((value) => ({ name: value }));
+    const enumValues = colValues.map((value) => ({ name: value }));
     result.push({ columns: mergedColumns, enumValues, constraint_name: `${constraint_name}_${mergedColumns.join('_')}` });
     processedKeys.add(key);
   });
@@ -243,11 +242,11 @@ const generateTablesFieldsAndEnums = async (client: sql.ConnectionPool, schemas:
         JOIN sys.columns c ON t.object_id = c.object_id
         JOIN sys.types ty ON c.user_type_id = ty.user_type_id
         LEFT JOIN sys.extended_properties p ON p.major_id = t.object_id
-          AND p.name = 'MS_Description'
+          AND p.name like '%description%'
           AND p.minor_id = 0 -- Ensure minor_id is 0 for table comments
         LEFT JOIN sys.extended_properties ep ON ep.major_id = c.object_id
           AND ep.minor_id = c.column_id
-          AND ep.name = 'MS_Description'
+          AND ep.name like '%description%'
       WHERE
         t.type = 'U' -- User-defined tables
     ),
@@ -410,11 +409,11 @@ const generateRefs = async (client: sql.ConnectionPool, schemas: string[]): Prom
 
   const endpointsEqual = (ep1: RefEndpoint[], ep2: RefEndpoint[]): boolean => {
     if (ep1.length !== ep2.length) return false;
-    return ep1.every((endpoint, index) => 
-      endpoint.tableName === ep2[index].tableName &&
-      endpoint.schemaName === ep2[index].schemaName &&
-      endpoint.fieldNames.length === ep2[index].fieldNames.length &&
-      endpoint.fieldNames.every((field, fieldIndex) => field === ep2[index].fieldNames[fieldIndex])
+    return ep1.every(
+      (endpoint, index) => endpoint.tableName === ep2[index].tableName
+      && endpoint.schemaName === ep2[index].schemaName
+      && endpoint.fieldNames.length === ep2[index].fieldNames.length
+      && endpoint.fieldNames.every((field, fieldIndex) => field === ep2[index].fieldNames[fieldIndex]),
     );
   };
 
@@ -651,5 +650,5 @@ const fetchSchemaJson = async (connection: string): Promise<DatabaseSchema> => {
 };
 
 export {
-  fetchSchemaJson
+  fetchSchemaJson,
 };