@dbml/connector 3.9.0 → 3.9.1

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

@@ -500,7 +500,7 @@
         "not_null": false,
         "increment": false,
         "note": {
-          "value": "first name of the individual"
+          "value": "first name's of the individual"
         }
       },
       {
@@ -513,7 +513,7 @@
         "not_null": false,
         "increment": false,
         "note": {
-          "value": "last name of the individual"
+          "value": "last name's of the individual"
         }
       }
     ],

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

@@ -81,7 +81,7 @@
       "name": "table_with_comments",
       "schemaName": "public",
       "note": {
-        "value": "This table stores information about various items."
+        "value": "This table stores information about various items. Such as: 'id', 'name', 'description'"
       }
     },
     {
@@ -1007,7 +1007,7 @@
         "not_null": false,
         "increment": false,
         "note": {
-          "value": "Name of the item."
+          "value": "Item's name."
         }
       },
       {
@@ -1020,7 +1020,7 @@
         "not_null": false,
         "increment": false,
         "note": {
-          "value": "Detailed description of the item."
+          "value": "Item's description"
         }
       },
       {

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

@@ -1,5 +1,19 @@
 {
   "tables": [
+    {
+      "name": "table1",
+      "schemaName": "dbml_test",
+      "note": {
+        "value": ""
+      }
+    },
+    {
+      "name": "table3",
+      "schemaName": "dbml_test",
+      "note": {
+        "value": ""
+      }
+    },
     {
       "name": "all_default_values",
       "schemaName": "public",
@@ -49,11 +63,25 @@
         "value": ""
       }
     },
+    {
+      "name": "table1",
+      "schemaName": "public",
+      "note": {
+        "value": ""
+      }
+    },
+    {
+      "name": "table2",
+      "schemaName": "public",
+      "note": {
+        "value": ""
+      }
+    },
     {
       "name": "table_with_comments",
       "schemaName": "public",
       "note": {
-        "value": "This table stores information about various items."
+        "value": "This table stores information about various items. Such as: 'id', 'name', 'description'"
       }
     },
     {
@@ -69,9 +97,72 @@
       "note": {
         "value": ""
       }
+    },
+    {
+      "name": "employee",
+      "schemaName": "test",
+      "note": {
+        "value": ""
+      }
     }
   ],
   "fields": {
+    "dbml_test.table1": [
+      {
+        "name": "id",
+        "type": {
+          "type_name": "int4",
+          "schemaName": null
+        },
+        "dbdefault": null,
+        "not_null": true,
+        "increment": true,
+        "note": {
+          "value": ""
+        }
+      },
+      {
+        "name": "status",
+        "type": {
+          "type_name": "enum_type1",
+          "schemaName": "dbml_test"
+        },
+        "dbdefault": null,
+        "not_null": false,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      }
+    ],
+    "dbml_test.table3": [
+      {
+        "name": "id",
+        "type": {
+          "type_name": "int4",
+          "schemaName": null
+        },
+        "dbdefault": null,
+        "not_null": true,
+        "increment": true,
+        "note": {
+          "value": ""
+        }
+      },
+      {
+        "name": "status",
+        "type": {
+          "type_name": "enum_type3",
+          "schemaName": "dbml_test"
+        },
+        "dbdefault": null,
+        "not_null": false,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      }
+    ],
     "public.all_default_values": [
       {
         "name": "id",
@@ -843,6 +934,62 @@
         }
       }
     ],
+    "public.table1": [
+      {
+        "name": "id",
+        "type": {
+          "type_name": "int4",
+          "schemaName": null
+        },
+        "dbdefault": null,
+        "not_null": true,
+        "increment": true,
+        "note": {
+          "value": ""
+        }
+      },
+      {
+        "name": "status",
+        "type": {
+          "type_name": "enum_type1",
+          "schemaName": "public"
+        },
+        "dbdefault": null,
+        "not_null": false,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      }
+    ],
+    "public.table2": [
+      {
+        "name": "id",
+        "type": {
+          "type_name": "int4",
+          "schemaName": null
+        },
+        "dbdefault": null,
+        "not_null": true,
+        "increment": true,
+        "note": {
+          "value": ""
+        }
+      },
+      {
+        "name": "status",
+        "type": {
+          "type_name": "enum_type2",
+          "schemaName": "public"
+        },
+        "dbdefault": null,
+        "not_null": false,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      }
+    ],
     "public.table_with_comments": [
       {
         "name": "id",
@@ -867,7 +1014,7 @@
         "not_null": false,
         "increment": false,
         "note": {
-          "value": "Name of the item."
+          "value": "Item's name."
         }
       },
       {
@@ -880,7 +1027,7 @@
         "not_null": false,
         "increment": false,
         "note": {
-          "value": "Detailed description of the item."
+          "value": "Item's description"
         }
       },
       {
@@ -1130,6 +1277,34 @@
           "value": ""
         }
       }
+    ],
+    "test.employee": [
+      {
+        "name": "employeeid",
+        "type": {
+          "type_name": "int8",
+          "schemaName": null
+        },
+        "dbdefault": null,
+        "not_null": true,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      },
+      {
+        "name": "identifier",
+        "type": {
+          "type_name": "citext",
+          "schemaName": "test"
+        },
+        "dbdefault": null,
+        "not_null": false,
+        "increment": false,
+        "note": {
+          "value": ""
+        }
+      }
     ]
   },
   "refs": [
@@ -1229,6 +1404,54 @@
     }
   ],
   "enums": [
+    {
+      "name": "enum_type1",
+      "schemaName": "dbml_test",
+      "values": [
+        {
+          "name": "value1"
+        },
+        {
+          "name": "value2"
+        }
+      ]
+    },
+    {
+      "name": "enum_type3",
+      "schemaName": "dbml_test",
+      "values": [
+        {
+          "name": "value4"
+        },
+        {
+          "name": "value5"
+        }
+      ]
+    },
+    {
+      "name": "enum_type1",
+      "schemaName": "public",
+      "values": [
+        {
+          "name": "value1"
+        },
+        {
+          "name": "value2"
+        }
+      ]
+    },
+    {
+      "name": "enum_type2",
+      "schemaName": "public",
+      "values": [
+        {
+          "name": "value1"
+        },
+        {
+          "name": "value3"
+        }
+      ]
+    },
     {
       "name": "gender_type",
       "schemaName": "public",
@@ -1386,6 +1609,26 @@
         "pk": true
       }
     },
+    "public.table1": {
+      "id": {
+        "pk": true
+      }
+    },
+    "dbml_test.table1": {
+      "id": {
+        "pk": true
+      }
+    },
+    "public.table2": {
+      "id": {
+        "pk": true
+      }
+    },
+    "dbml_test.table3": {
+      "id": {
+        "pk": true
+      }
+    },
     "public.table_with_comments": {
       "id": {
         "pk": true

package/dist/connectors/mssqlConnector.js

@@ -7,6 +7,7 @@ exports.fetchSchemaJson = void 0;
 /* eslint-disable camelcase */
 const mssql_1 = __importDefault(require("mssql"));
 const parseSchema_1 = require("../utils/parseSchema");
+// https://learn.microsoft.com/en-us/sql/t-sql/data-types/date-and-time-types?view=sql-server-ver15
 const MSSQL_DATE_TYPES = [
     'date',
     'datetime',
@@ -36,18 +37,43 @@ const getValidatedClient = async (connection) => {
     }
 };
 const convertQueryBoolean = (val) => val === 'YES';
-const getFieldType = (data_type, default_type, character_maximum_length, numeric_precision, numeric_scale) => {
+const getFieldType = (data_type, character_maximum_length, numeric_precision, numeric_scale) => {
     if (MSSQL_DATE_TYPES.includes(data_type)) {
         return data_type;
     }
+    // timestamp is a synonym of rowversion and we cannot specify the precision for it
+    // https://learn.microsoft.com/en-us/sql/t-sql/data-types/rowversion-transact-sql?view=sql-server-ver15
+    if (data_type === 'timestamp') {
+        return data_type;
+    }
+    // process numeric-based type
     if (data_type === 'bit') {
         return data_type;
     }
-    if (numeric_precision && numeric_scale && default_type === 'number') {
-        return `${data_type}(${numeric_precision},${numeric_scale})`;
+    // if precision != 0 => numeric-based column
+    if (numeric_precision) {
+        return numeric_scale
+            ? `${data_type}(${numeric_precision},${numeric_scale})`
+            : `${data_type}(${numeric_precision})`;
+    }
+    // process string-based type
+    // ntext, text & image
+    if (['ntext', 'text', 'image'].includes(data_type)) {
+        return data_type;
+    }
+    // Column data type is varchar(max), nvarchar(max), varbinary(max), or xml
+    if (character_maximum_length < 0) {
+        return data_type === 'xml' ? data_type : `${data_type}(MAX)`;
     }
-    if (character_maximum_length && character_maximum_length > 0 && default_type === 'string') {
-        return `${data_type}(${character_maximum_length})`;
+    // character_maximum_length is the lenght in bytes
+    // nchar and nvarchar store Unicode characters, each character needs 2 bytes
+    // so we have to divide it by 2 to get the correct maximum lenght in character.
+    // ref: https://learn.microsoft.com/en-us/sql/t-sql/data-types/nchar-and-nvarchar-transact-sql?view=sql-server-ver15
+    if (character_maximum_length > 0) {
+        const maximum_length_in_character = (data_type === 'nchar' || data_type === 'nvarchar')
+            ? character_maximum_length / 2
+            : character_maximum_length;
+        return `${data_type}(${maximum_length_in_character})`;
     }
     return data_type;
 };
@@ -90,7 +116,7 @@ const generateField = (row) => {
     const { column_name, data_type, character_maximum_length, numeric_precision, numeric_scale, identity_increment, is_nullable, column_default, default_type, column_comment, } = row;
     const dbdefault = column_default && default_type !== 'increment' ? getDbdefault(data_type, column_default, default_type) : null;
     const fieldType = {
-        type_name: getFieldType(data_type, default_type, character_maximum_length, numeric_precision, numeric_scale),
+        type_name: getFieldType(data_type, character_maximum_length, numeric_precision, numeric_scale),
         schemaName: null,
     };
     return {
@@ -194,7 +220,7 @@ const generateTablesFieldsAndEnums = async (client, schemas) => {
       constraints_with_row_number
     WHERE
       rn = 1
-      ${(0, parseSchema_1.buildSchemaQuery)('table_schema', schemas, 'WHERE')}
+      ${(0, parseSchema_1.buildSchemaQuery)('table_schema', schemas)}
     ORDER BY
       table_schema,
       table_name,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbml/connector",
-  "version": "3.9.0",
+  "version": "3.9.1",
   "description": "This package was created to fetch the schema JSON from many kind of databases.",
   "author": "huy.phung.sw@gmail.com",
   "license": "MIT",
@@ -40,5 +40,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "d40aaa3827853d17fa385aa27ae1e099c9234e4b"
+  "gitHead": "8494c278b97347945cf3b71d6f75cd658dbae85d"
 }

package/src/connectors/mssqlConnector.ts

@@ -16,6 +16,7 @@ import {
   TableConstraintsDictionary,
 } from './types';
 
+// https://learn.microsoft.com/en-us/sql/t-sql/data-types/date-and-time-types?view=sql-server-ver15
 const MSSQL_DATE_TYPES = [
   'date',
   'datetime',
@@ -49,19 +50,51 @@ const getValidatedClient = async (connection: string): Promise<sql.ConnectionPoo
 
 const convertQueryBoolean = (val: string | null): boolean => val === 'YES';
 
-const getFieldType = (data_type: string, default_type: DefaultType, character_maximum_length: number, numeric_precision: number, numeric_scale: number): string => {
+const getFieldType = (data_type: string, character_maximum_length: number, numeric_precision: number, numeric_scale: number): string => {
   if (MSSQL_DATE_TYPES.includes(data_type)) {
     return data_type;
   }
+
+  // timestamp is a synonym of rowversion and we cannot specify the precision for it
+  // https://learn.microsoft.com/en-us/sql/t-sql/data-types/rowversion-transact-sql?view=sql-server-ver15
+  if (data_type === 'timestamp') {
+    return data_type;
+  }
+
+  // process numeric-based type
   if (data_type === 'bit') {
     return data_type;
   }
-  if (numeric_precision && numeric_scale && default_type === 'number') {
-    return `${data_type}(${numeric_precision},${numeric_scale})`;
+  // if precision != 0 => numeric-based column
+  if (numeric_precision) {
+    return numeric_scale
+      ? `${data_type}(${numeric_precision},${numeric_scale})`
+      : `${data_type}(${numeric_precision})`;
+  }
+
+  // process string-based type
+  // ntext, text & image
+  if (['ntext', 'text', 'image'].includes(data_type)) {
+    return data_type;
+  }
+
+  // Column data type is varchar(max), nvarchar(max), varbinary(max), or xml
+  if (character_maximum_length < 0) {
+    return data_type === 'xml' ? data_type : `${data_type}(MAX)`;
   }
-  if (character_maximum_length && character_maximum_length > 0 && default_type === 'string') {
-    return `${data_type}(${character_maximum_length})`;
+
+  // character_maximum_length is the lenght in bytes
+  // nchar and nvarchar store Unicode characters, each character needs 2 bytes
+  // so we have to divide it by 2 to get the correct maximum lenght in character.
+  // ref: https://learn.microsoft.com/en-us/sql/t-sql/data-types/nchar-and-nvarchar-transact-sql?view=sql-server-ver15
+  if (character_maximum_length > 0) {
+    const maximum_length_in_character = (data_type === 'nchar' || data_type === 'nvarchar')
+      ? character_maximum_length / 2
+      : character_maximum_length;
+
+    return `${data_type}(${maximum_length_in_character})`;
   }
+
   return data_type;
 };
 
@@ -119,7 +152,7 @@ const generateField = (row: Record<string, any>): Field => {
   const dbdefault = column_default && default_type !== 'increment' ? getDbdefault(data_type, column_default, default_type) : null;
 
   const fieldType = {
-    type_name: getFieldType(data_type, default_type, character_maximum_length, numeric_precision, numeric_scale),
+    type_name: getFieldType(data_type, character_maximum_length, numeric_precision, numeric_scale),
     schemaName: null,
   };
 
@@ -229,7 +262,7 @@ const generateTablesFieldsAndEnums = async (client: sql.ConnectionPool, schemas:
       constraints_with_row_number
     WHERE
       rn = 1
-      ${buildSchemaQuery('table_schema', schemas, 'WHERE')}
+      ${buildSchemaQuery('table_schema', schemas)}
     ORDER BY
       table_schema,
       table_name,