neopg 0.0.0 → 1.0.0

package/lib/ModelDef.js

@@ -10,6 +10,9 @@ class ModelDef {
     this.modelName = rawSchema.modelName || rawSchema.tableName
     this.primaryKey = rawSchema.primaryKey || 'id'
     this.columns = rawSchema.column || {}
+    this.index = rawSchema.index || []
+    this.unique = rawSchema.unique || []
+    this.removeIndex = rawSchema.removeIndex || []
 
     this._parseColumns()
 
@@ -57,7 +60,7 @@ class ModelDef {
         throw new Error(`[NeoPG] Column name '${k}' in table '${this.tableName}' is FORBIDDEN.`)
       }
 
-      if (!/^[a-z][a-z0-9_]*$/i.test(colName)) {
+      if (!(/^[a-z][a-z0-9_]*$/i).test(k)) {
          throw new Error(`[NeoPG] Column name '${k}' is invalid. Only alphanumeric and underscore allowed, must start with letter.`)
       }
     }

package/lib/NeoPG.js

@@ -20,7 +20,7 @@ class NeoPG {
 
   table(tableName, schema = null) {
     const target = schema || this.defaultSchema
-    return new this.ModelChain(this.driver, {tableName, isRaw: true}, target)
+    return new this.ModelChain(this, {tableName, isRaw: true}, target)
   }
 
   model(name, schema = null) {
@@ -28,13 +28,14 @@ class NeoPG {
     if (!item) throw new Error(`[NeoPG] Model '${name}' not found.`)
     
     const target = schema || this.defaultSchema
-    return new item.Class(this.driver, item.def, target)
+    return new item.Class(this, item.def, target)
   }
 
   // --- 注册 ---
 
   add(input) {
-    let ModelClass;
+    let ModelClass
+
     if (typeof input === 'function') {
       ModelClass = input
     } else {
@@ -54,6 +55,10 @@ class NeoPG {
     return this
   }
 
+  define(model) {
+    return this.add(model)
+  }
+
   // --- 事务 ---
   async transaction(callback) {
     return await this.driver.begin(async (trxSql) => {
@@ -62,13 +67,62 @@ class NeoPG {
     })
   }
 
+  begin(callback) {
+    return this.transaction(callback)
+  }
+
   // --- 同步 ---
   async sync(options = {}) {
+    if (!options || typeof options !== 'object') {
+      options = {}
+    }
+
+    if (!options.schema) options.schema = this.defaultSchema
+
     for (const item of this.registry.values()) {
       await SchemaSync.execute(this.driver, item.def, this, options)
     }
   }
 
+  /**
+   * 监听 Postgres 消息通道
+   * @param {string} channel - 通道名称
+   * @param {Function} callback - (payload) => {}
+   * @returns {Object} 包含 unlisten 方法的对象
+   */
+  async listen(channel, callback) {
+    // postgres.js 的 listen 返回一个 Promise<void>
+    // 但它内部会维持连接。我们需要提供一种方式来取消监听。
+    // postgres.js v3 使用 sql.listen(channel, cb) 并返回一个 state 对象用于 close
+    const listener = await this.sql.listen(channel, (payload) => {
+      // 可以在这里统一处理 JSON 解析等
+      try {
+        const data = JSON.parse(payload)
+        callback(data)
+      } catch (e) {
+        // 无法解析则返回原始字符串
+        callback(payload)
+      }
+    })
+
+    return {
+      // 返回一个句柄用于取消监听
+      close: () => listener.unlisten() 
+    }
+  }
+
+  /**
+   * 发送通知
+   * @param {string} channel 
+   * @param {string|Object} payload 
+   */
+  async notify(channel, payload) {
+    const data = typeof payload === 'object' ? JSON.stringify(payload) : payload
+
+    // 使用 sql.notify 是最高效的
+    await this.sql.notify(channel, data)
+  }
+
   async close() {
     await this.driver.end()
   }

package/lib/SchemaSync.js

@@ -32,17 +32,33 @@ const DefaultWithType = ['varchar', 'char', 'text', 'bytea', 'timestamp', 'times
 
 class SchemaSync {
 
+  static async createSchema(sql, schema) {
+    return sql.unsafe(`create schema if not exists ${schema};`)
+  }
+
   /**
    * 入口方法
    */
   static async execute(sql, def, ctx, options = {}) {
     const debug = options.debug || false;
     const force = options.force || false;
-    const dropNotExistCol = options.dropNotExistCol || false;
-    const schema = ctx.defaultSchema || 'public';
+    const dropNotExistCol = force || options.dropNotExistCol || false;
+    const schema = options.schema || ctx.defaultSchema || 'public';
     const tableName = def.tableName;
     const curTableName = `${schema}.${tableName}`;
 
+    // [递归锁初始化] 记录本次同步过程中已经处理过的 Model，防止死循环
+    if (!options.syncedModels) {
+        options.syncedModels = new Set();
+    }
+
+    // 如果该表在本次递归链中已经同步过，则跳过
+    if (options.syncedModels.has(def.modelName)) {
+        return; 
+    }
+    // 标记当前表已开始同步
+    options.syncedModels.add(def.modelName);
+
     if (debug) console.log(`检测数据表 ${tableName} 的column...`);
 
     // 0. 检查列定义的合法性 (移植自 _checkFixColumn)
@@ -72,7 +88,7 @@ class SchemaSync {
       // 同步索引、约束、外键
       await this.syncIndex(sql, def, schema, curTableName, debug);
       await this.syncUnique(sql, def, schema, curTableName, debug);
-      await this.syncReferences(sql, def, schema, curTableName, schemaOid, debug, ctx);
+      await this.syncReferences(sql, def, schema, curTableName, schemaOid, debug, ctx, options);
       return;
     }
 
@@ -80,7 +96,7 @@ class SchemaSync {
     // 获取现有列信息
     const cols = await sql`
       SELECT column_name, data_type, column_default, character_maximum_length, 
-             numeric_precision, numeric_scale, is_nullable
+             numeric_precision, numeric_scale, is_nullable, is_generated
       FROM information_schema.columns 
       WHERE table_name = ${tableName} 
       AND table_schema = ${schema} 
@@ -99,7 +115,7 @@ class SchemaSync {
     await this.syncIndex(sql, def, schema, curTableName, debug);
     await this.syncUnique(sql, def, schema, curTableName, debug);
     await this.autoRemoveIndex(sql, def, schema, tableName, debug);
-    await this.syncReferences(sql, def, schema, curTableName, schemaOid, debug, ctx);
+    await this.syncReferences(sql, def, schema, curTableName, schemaOid, debug, ctx, options);
 
     if (debug) console.log(` - 表结构同步完成 (${tableName}) - `);
   }
@@ -130,7 +146,7 @@ class SchemaSync {
 
         if (col.default !== undefined) {
           if (col.default === null) line += ' default null';
-          else line += ` default $${qtag}$${col.default}$${qtag}$`;
+          else line += ` default $_${qtag}_$${col.default}$_${qtag}_$`;
         }
       }
       colSqls.push(line);
@@ -190,7 +206,7 @@ class SchemaSync {
 
         if (col.default !== undefined) {
             if (col.default === null) addSql += ' default null';
-            else addSql += ` default $${qtag}$${col.default}$${qtag}$`;
+            else addSql += ` default $_${qtag}_$${col.default}$_${qtag}_$`;
         }
 
         if (debug) console.log(addSql);
@@ -215,7 +231,7 @@ class SchemaSync {
              await sql.unsafe(`ALTER TABLE ${curTableName} DROP COLUMN ${this.fmtColName(k)}`);
              let reAddSql = `ALTER TABLE ${curTableName} ADD COLUMN ${this.fmtColName(k)} ${col.type}`;
              if (col.notNull !== false) reAddSql += ' not null';
-             if (col.default !== undefined) reAddSql += ` default $${qtag}$${col.default}$${qtag}$`;
+             if (col.default !== undefined) reAddSql += ` default $_${qtag}_$${col.default}$_${qtag}_$`;
              await sql.unsafe(reAddSql);
              col.changed = true; // 标记变更，供外键处理使用
              continue;
@@ -240,7 +256,7 @@ class SchemaSync {
         // 简单比对逻辑 (注：PG存储的默认值格式可能不同，这里仅作简单触发)
         // 实际生产中可能需要更复杂的解析，这里保留原逻辑结构
         // 原逻辑用了 _realDefault 方法，这里我们简单处理，仅当需要时设置
-        let default_val_sql = col.default === null ? 'null' : `$${qtag}$${col.default}$${qtag}$`;
+        let default_val_sql = col.default === null ? 'null' : `$_${qtag}_$${col.default}$_${qtag}_$`;
         // 这里为了简化，每次都重设默认值（开销很小），或者你需要实现 _realDefault
         await sql.unsafe(`ALTER TABLE ${curTableName} ALTER COLUMN ${this.fmtColName(k)} SET DEFAULT ${default_val_sql}`);
       }
@@ -259,24 +275,43 @@ class SchemaSync {
 
     // 7. Drop Not Exist (Force Mode)
     if (dropNotExistCol) {
-      for (let k in inf) {
-        if (!def.columns[k] && !renameTable[k]) {
-           await sql.unsafe(`ALTER TABLE ${curTableName} DROP COLUMN ${this.fmtColName(k)}`);
+      for (let dbColName in inf) {
+        // 如果代码中没定义，且不是刚改名的
+        if (!def.columns[dbColName] && !renameTable[dbColName]) {
+           
+           const dbCol = inf[dbColName];
+
+           // [核心逻辑] 如果是数据库层面的虚拟列 (is_generated == 'ALWAYS')，豁免，不删除
+           if (dbCol.is_generated === 'ALWAYS') {
+             if (debug) console.log(`[NeoPG] Ignoring DB-only generated column: ${dbColName}`);
+             continue;
+           }
+
+           // [额外建议] 如果是 identity 列 (自增列的一种新形式)，通常也建议豁免，防止误删
+           // if (dbCol.is_identity === 'YES') continue; 
+
+           if (debug) console.log(`Deleting unused column: ${dbColName}`);
+           await sql.unsafe(`ALTER TABLE ${curTableName} DROP COLUMN ${this.fmtColName(dbColName)}`);
         }
       }
     }
+      /* for (let k in inf) {
+        if (!def.columns[k] && !renameTable[k]) {
+           await sql.unsafe(`ALTER TABLE ${curTableName} DROP COLUMN ${this.fmtColName(k)}`);
+        }
+      } */
   }
 
   // --- 索引同步 ---
   static async syncIndex(sql, def, schema, curTableName, debug) {
     // 假设索引定义在 def.rawSchema.index (数组)
     // ModelDef 需要暴露这个属性，或 def.indices
-    const indices = def.rawSchema && def.rawSchema.index ? def.rawSchema.index : [];
+    const indices = def.index || [];
     if (!Array.isArray(indices)) return;
 
     for (const indname of indices) {
         // 检查 removeIndex 配置
-        const removeIndex = def.rawSchema.removeIndex || [];
+        const removeIndex = def.removeIndex || [];
         if (removeIndex.includes(indname)) continue;
 
         // 检查列是否存在
@@ -310,7 +345,7 @@ class SchemaSync {
   }
 
   static async syncUnique(sql, def, schema, curTableName, debug) {
-      const uniques = def.rawSchema && def.rawSchema.unique ? def.rawSchema.unique : [];
+      const uniques = def.unique || [];
       if (!Array.isArray(uniques)) return;
 
       for (const indname of uniques) {
@@ -347,8 +382,8 @@ class SchemaSync {
       const currentIdxNames = allIdx.map(i => i.indexname);
       
       // 2. 计算应该保留的索引名
-      const indices = def.rawSchema && def.rawSchema.index ? def.rawSchema.index : [];
-      const uniques = def.rawSchema && def.rawSchema.unique ? def.rawSchema.unique : [];
+      const indices = def.index || [];
+      const uniques = def.unique || [];
       
       const keepSet = new Set();
       const makeName = (n) => `${tableName}_${n.split(',').map(x=>x.trim()).filter(x=>x).join('_')}_idx`;
@@ -366,7 +401,7 @@ class SchemaSync {
   }
 
   // --- 外键同步 ---
-  static async syncReferences(sql, def, schema, curTableName, schemaOid, debug, ctx) {
+  static async syncReferences(sql, def, schema, curTableName, schemaOid, debug, ctx, options) {
       // 1. 收集定义中的外键
       // 格式: { fkName: "xxx", createSql: "..." }
       let targetFKs = new Map();
@@ -378,27 +413,32 @@ class SchemaSync {
 
           // 解析 ref: "ModelName:colName"
           const [refModelName, refColName] = this._parseRef(col.ref, k);
+
+          // 查找被引用的 Model 定义
+          // 假设 ctx.registry.get 返回 { Class, def }
+          const targetModelItem = ctx.registry.get(refModelName);
           
-          // 加载目标模型 (这里需要通过 ctx (NeoPG实例) 获取其他模型)
-          // 假设 ctx.registry.get(refModelName) 能拿到
-          // 或者如果是文件路径，尝试 require
-          
-          // 为了简化复刻，这里假设我们能拿到目标表名
-          // 在原逻辑中是 require 文件，这里建议 NeoPG 注册机制解决
-          // 这里做一个适配：
           let targetTableName = '';
-          if (ctx.registry && ctx.registry.get(refModelName)) {
-             targetTableName = ctx.registry.get(refModelName).def.tableName;
+
+          if (targetModelItem) {
+              targetTableName = targetModelItem.def.tableName;
+              // --- [关键] 递归同步 ---
+              // 在创建外键之前，确保目标表已经存在且结构最新
+              if (debug) console.log(`[Recursive Sync] Triggered by FK: ${def.modelName} -> ${refModelName}`);
+
+              await this.execute(sql, targetModelItem.def, ctx, options);
           } else {
-             // 尝试作为表名直接使用 (Fallback)
-             targetTableName = refModelName.toLowerCase(); 
+              // 目标模型未注册，可能是直接引用的表名 (Fallback)
+              if (debug) console.warn(`[NeoPG] Referenced model '${refModelName}' not found in registry. Using as table name.`);
+              targetTableName = refModelName.toLowerCase();
           }
 
-          // 构建外键名
+          // 准备外键 SQL
           const fkName = `${def.tableName}_${k}_fkey`;
           
           // 构建 REFERENCES 子句
           let refSql = `REFERENCES ${schema}.${targetTableName} (${refColName})`;
+
           if (col.refActionUpdate) refSql += ` ON UPDATE ${col.refActionUpdate}`;
           else refSql += ` ON UPDATE CASCADE`; // 默认
 
@@ -493,14 +533,15 @@ class SchemaSync {
 
   static _parseRef(refstr, curColumn) {
       if (refstr.includes(':')) {
-          const parts = refstr.split(':');
+          const parts = refstr.split(':')
           // 处理 Model:col 格式，取最后一部分做 col，前面做 Model
-          const col = parts.pop();
-          const model = parts.join(':');
-          return [model, col];
+          const col = parts.pop()
+          const model = parts.join(':')
+          return [model, col]
       }
-      return [refstr, curColumn];
+
+      return [refstr, curColumn]
   }
 }
 
-module.exports = SchemaSync;
+module.exports = SchemaSync

package/lib/TransactionScope.js

@@ -9,14 +9,14 @@ class TransactionScope {
 
   table(tableName, schema = null) {
     const target = schema || this.parent.defaultSchema
-    return new this.parent.ModelChain(this.driver, {tableName, isRaw: true}, target)
+    return new this.parent.ModelChain(this, {tableName, isRaw: true}, target)
   }
 
   model(name, schema = null) {
     const item = this.parent.registry.get(name)
     if (!item) throw new Error(`[NeoPG] Model '${name}' not found.`)
     const target = schema || this.parent.defaultSchema
-    return new item.Class(this.driver, item.def, target)
+    return new item.Class(this, item.def, target)
   }
 
   async transaction(callback) {
@@ -24,6 +24,10 @@ class TransactionScope {
       return await callback(new TransactionScope(this.parent, sp))
     })
   }
+
+  begin(callback) {
+    return this.transaction(callback)
+  }
 }
 
 module.exports = TransactionScope

package/package.json

@@ -1,11 +1,18 @@
 {
   "name": "neopg",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "orm for postgres",
   "keywords": [
+    "neopg",
+    "NeoPG",
+    "pg",
+    "neo",
+    "pgorm",
+    "psqlorm",
     "postgres",
     "orm",
-    "database"
+    "database",
+    "postgres.js"
   ],
   "homepage": "https://github.com/master-genius/neopg#readme",
   "bugs": {

package/test/test-db.js

@@ -1,44 +1,217 @@
 // index.js
 const NeoPG = require('../lib/NeoPG.js')
-const ModelChain = NeoPG.ModelChain
+const {dataTypes, ModelChain} = NeoPG
 
 // 1. 初始化
 const db = new NeoPG({
   host: '127.0.0.1',
-  database: 'eoms',
-  schema: 'ai' // 全局默认 Schema
+  user: 'wy',
+  database: 'wdata',
+  schema: 'test'
 });
 
 // 2. 定义模型
-const UserSchema = {
+const User = {
   modelName: 'User',
-  tableName: 'sys_users',
+  tableName: 'users',
+  primaryKey: 'id',
+
   column: {
-    id: { type: 'varchar', primaryKey: true },
-    name: { type: 'varchar', notNull: true },
-    age: { type: 'int', default: 18 }
-  }
-};
+    id : {
+      type: dataTypes.UID
+    },
+
+    /**
+     * @type {column}
+     */
+    username: {
+      type: dataTypes.STRING(50)
+    },
+
+    mobile: {
+      type: dataTypes.STRING(16)
+    },
+
+    mobile_state: {
+      type: dataTypes.SMALLINT,
+      default: 0
+    },
+
+    //真实姓名
+    realname: {
+      type: dataTypes.STRING(50),
+      default: ''
+    },
+
+    sex: {
+      type: dataTypes.SMALLINT,
+      default: 0
+    },
+
+    //其他信息，以JSON格式存储
+    info: {
+      type: dataTypes.TEXT,
+      default: ''
+    },
+
+    /**
+     * @type {column}
+     */
+    passwd: {
+      type: dataTypes.STRING(240)
+    },
+
+    //当验证失败，需要进行重复密码验证
+    repasswd: {
+      type: dataTypes.STRING(240)
+    },
+
+    /**
+     * @type {column}
+     */
+    level: {
+      type: 'smallint',
+      default: 1,
+      validate: v => {
+        return v >= 0 && v < 99
+      }
+    },
+
+    /**
+     * @type {column}
+     */
+    email: {
+      type: dataTypes.STRING(60),
+      default: ''
+    },
+
+    email_state: {
+      type: dataTypes.SMALLINT,
+      default: 0
+    },
+
+    create_time: {
+      type: dataTypes.BIGINT,
+      default: 0,
+      timestamp: 'insert'
+    },
+
+    update_time: {
+      type: dataTypes.BIGINT,
+      default: 0,
+      timestamp: 'update'
+    },
+
+    failed_count: {
+      type: dataTypes.INT,
+      default: 0
+    },
+
+    failed_time: {
+      type: dataTypes.BIGINT,
+      default: 0
+    },
+
+    forbid: {
+      type: dataTypes.SMALLINT,
+      default: 0
+    },
+
+    is_root: {
+      type: dataTypes.SMALLINT,
+      default: 0
+    }
+  },
+
+  //索引
+  index: [
+    'create_time',
+    'level',
+    'is_root'
+  ],
+
+  //唯一索引
+  unique: [
+    'username',
+    'email'
+  ]
+}
 
 // 3. 注册
-db.add(UserSchema);
+db.add(User);
 
 ;(async () => {
+  await db.sync({force: true, debug: true})
   // 插入
-  await db.model('User').insert({ name: 'Neo' });
 
-  // 动态切换 Schema
-  await db.model('User', 'tenant_a').select();
-  
-  // 链式切换
-  await db.model('User').schema('tenant_b').where({ age: 20 }).select();
+  await db.model('User').where('1=1').delete()
+
+  try {
+    console.log(
+      await db.model('User')
+              .returning(['id', 'username', 'level', 'create_time'])
+              .insert([
+                {
+                  username: 'Neo',
+                  email: '123@w.com',
+                  level: Math.floor((Math.random() * 105))
+                },
+                {
+                  username: 'PG',
+                  email: '1234@w.com',
+                  level: Math.floor((Math.random() * 100))
+                }
+            ])
+    )
+  } catch(err) {
+    console.error('\x1b[7;5m随机测试：让level超过99，validate验证失败\x1b[0m')
+  }
 
   // 事务
   await db.transaction(async tx => {
-    await tx.model('User').update({ age: 99 });
+    let data = {
+      level: Math.floor(Math.random() * 100),
+      info: `age=${Math.floor(Math.random() * 10 + 20)};delete from users;`
+    }
+
+    console.log('update', data)
+
+    let result = await tx.model('User').where(tx.sql`level > 10`).returning('*').update(data)
+    console.log(result)
+
+    console.log(
+      'test avg',
+      await tx.model('User').avg('level')
+    )
+
+    console.log(
+      'test max',
+      await tx.model('User').max('level')
+    )
+
+    console.log(
+      'test min',
+      await tx.model('User').min('username')
+    )
+
+    let n = Math.floor(Math.random() * 10)
+
+    if (n > 7) {
+      console.error('\x1b[7;5m随机测试：将会让事物执行失败\x1b[0m')
+      await tx.model('User').insert({username: 'Neo'})
+    }
+
+    console.log('test count',
+      await tx.model('User').where('level', '<', 10).count()
+    )
+
     // 嵌套
-    await tx.transaction(async subTx => {
+    /* await tx.transaction(async subTx => {
        await subTx.table('logs').insert({ msg: 'log' });
-    });
-  });
+    }); */
+  }).catch(err => {
+    console.error(err)
+  })
+
+  db.close()
 })();