feat: Handle the database type mapping

Author: svetch

packages/cli/src/actions/pull/index.ts

@@ -1,5 +1,13 @@
 import type { ZModelServices } from '@zenstackhq/language';
-import { Attribute, isEnum, type DataField, type DataModel, type Enum, type Model } from '@zenstackhq/language/ast';
+import {
+    Attribute,
+    isEnum,
+    type DataField,
+    type DataModel,
+    type Enum,
+    type Model,
+    type BuiltinType,
+} from '@zenstackhq/language/ast';
 import {
     DataFieldAttributeFactory,
     DataFieldFactory,
@@ -260,9 +268,16 @@ export function syncTable({
             const dbAttr = services.shared.workspace.IndexManager.allElements('Attribute').find(
                 (d) => d.name.toLowerCase() === `@db.${column.datatype.toLowerCase()}`,
             )?.node as Attribute | undefined;
-            //TODO: exclude default types like text in postgres
-            //because Zenstack string = text in postgres so unnecessary to map to default types
-            if (dbAttr && !['text'].includes(column.datatype)) {
+
+            const defaultDatabaseType = provider.getDefaultDatabaseType(builtinType.type as BuiltinType);
+
+            if (
+                dbAttr &&
+                defaultDatabaseType &&
+                (defaultDatabaseType.type !== column.datatype ||
+                    (defaultDatabaseType.precisition &&
+                        defaultDatabaseType.precisition !== (column.length || column.precision)))
+            ) {
                 const dbAttrFactory = new DataFieldAttributeFactory().setDecl(dbAttr);
                 if (column.length || column.precision)
                     dbAttrFactory.addArg((a) => a.NumberLiteral.setValue(column.length! || column.precision!));

packages/cli/src/actions/pull/provider/postgresql.ts

@@ -2,6 +2,7 @@ import { DataFieldAttributeFactory } from '@zenstackhq/language/factory';
 import { Client } from 'pg';
 import { getAttributeRef, getDbName, getFunctionRef } from '../utils';
 import type { IntrospectedEnum, IntrospectedSchema, IntrospectedTable, IntrospectionProvider } from './provider';
+import type { BuiltinType } from '@zenstackhq/language/ast';
 
 export const postgresql: IntrospectionProvider = {
     getBuiltinType(type) {
@@ -78,6 +79,28 @@ export const postgresql: IntrospectionProvider = {
             tables,
         };
     },
+    getDefaultDatabaseType(type: BuiltinType) {
+        switch (type) {
+            case 'String':
+                return { type: 'text' };
+            case 'Boolean':
+                return { type: 'boolean' };
+            case 'Int':
+                return { type: 'integer' };
+            case 'BigInt':
+                return { type: 'bigint' };
+            case 'Float':
+                return { type: 'double precision' };
+            case 'Decimal':
+                return { type: 'decimal' };
+            case 'DateTime':
+                return { type: 'timestamp', precisition: 3 };
+            case 'Json':
+                return { type: 'jsonb' };
+            case 'Bytes':
+                return { type: 'bytea' };
+        }
+    },
     getDefaultValue({ defaultValue, fieldName, services, enums }) {
         const val = defaultValue.trim();
         const factories: DataFieldAttributeFactory[] = [];
@@ -276,7 +299,7 @@ SELECT
           ),
           '[]'
         ) AS "options"
-      
+
             FROM "pg_catalog"."pg_attribute" AS "att"
 
             INNER JOIN "pg_catalog"."pg_type" AS "typ" ON "typ"."oid" = "att"."atttypid"

packages/cli/src/actions/pull/provider/provider.ts

@@ -64,6 +64,7 @@ export interface IntrospectionProvider {
         type: BuiltinType | 'Unsupported';
         isArray: boolean;
     };
+    getDefaultDatabaseType(type: BuiltinType): { precisition?: number; type: string } | undefined;
     getDefaultValue(args: {
         fieldName: string;
         defaultValue: string;

packages/cli/src/actions/pull/provider/sqlite.ts

@@ -1,3 +1,4 @@
+import type { BuiltinType } from '@zenstackhq/language/ast';
 import type { IntrospectedEnum, IntrospectedSchema, IntrospectedTable, IntrospectionProvider } from './provider';
 
 // Note: We dynamically import better-sqlite3 inside the async function to avoid
@@ -71,6 +72,29 @@ export const sqlite: IntrospectionProvider = {
         }
     },
 
+    getDefaultDatabaseType(type: BuiltinType) {
+        switch (type) {
+            case 'String':
+                return { type: 'TEXT' };
+            case 'Boolean':
+                return { type: 'INTEGER' };
+            case 'Int':
+                return { type: 'INTEGER' };
+            case 'BigInt':
+                return { type: 'INTEGER' };
+            case 'Float':
+                return { type: 'REAL' };
+            case 'Decimal':
+                return { type: 'DECIMAL' };
+            case 'DateTime':
+                return { type: 'NUMERIC' };
+            case 'Json':
+                return { type: 'JSONB' };
+            case 'Bytes':
+                return { type: 'BLOB' };
+        }
+    },
+
     async introspect(connectionString: string): Promise<IntrospectedSchema> {
         const SQLite = (await import('better-sqlite3')).default;
         const db = new SQLite(connectionString, { readonly: true });