w-orm-postgresql 1.0.1 → 1.0.3

package/docs/WOrmPostgresql.mjs.html

@@ -66,6 +66,7 @@ import isnum from 'wsemi/src/isnum.mjs'
 import isint from 'wsemi/src/isint.mjs'
 import isbol from 'wsemi/src/isbol.mjs'
 import isDate from 'wsemi/src/isDate.mjs'
+import haskey from 'wsemi/src/haskey.mjs'
 import pmSeries from 'wsemi/src/pmSeries.mjs'
 
 
@@ -77,10 +78,14 @@ import pmSeries from 'wsemi/src/pmSeries.mjs'
  * @param {String} [opt.url='postgresql://127.0.0.1:5432'] 輸入連接資料庫字串，預設'postgresql://127.0.0.1:5432'
  * @param {String} [opt.db='worm'] 輸入使用資料庫名稱字串，預設'worm'
  * @param {String} [opt.cl='test'] 輸入使用資料表名稱字串，預設'test'
+ * @param {Boolean} [opt.useCache=false] 輸入是否使用select快取，適用於單程序操作，預設false
  * @returns {Object} 回傳操作資料庫物件，各事件功能詳見說明
  */
 function WOrmPostgresql(opt = {}) {
 
+    //_cache
+    let _cache = null
+
     //url
     let url = get(opt, 'url')
     if (!isestr(url)) {
@@ -99,6 +104,12 @@ function WOrmPostgresql(opt = {}) {
         cl = 'test'
     }
 
+    //useCache
+    let useCache = get(opt, 'useCache')
+    if (!isbol(useCache)) {
+        useCache = false
+    }
+
     //getValueType
     function getValueType(value) {
         if (isstr(value)) {
@@ -191,6 +202,39 @@ function WOrmPostgresql(opt = {}) {
     let PgClient = pg.Client
     // console.log('PgClient', PgClient)
 
+    //clearCache
+    function clearCache() {
+        _cache = null
+    }
+
+    //getCacheKey
+    function getCacheKey(find = {}, order = {}) {
+        return JSON.stringify({
+            find,
+            order,
+        })
+    }
+
+    //getCache
+    function getCache(find = {}, order = {}) {
+        if (iseobj(_cache)) {
+            let key = getCacheKey(find, order)
+            if (haskey(_cache, key)) {
+                return cloneDeep(_cache[key]) //與外部使用數據脫勾
+            }
+        }
+        return null
+    }
+
+    //setCache
+    function setCache(find = {}, order = {}, data = []) {
+        if (!iseobj(_cache)) {
+            _cache = {}
+        }
+        let key = getCacheKey(find, order)
+        _cache[key] = cloneDeep(data) //與外部使用數據脫勾
+    }
+
     /**
      * 創建資料表
      *
@@ -265,6 +309,11 @@ function WOrmPostgresql(opt = {}) {
         }
         // console.log('res', res)
 
+        //update
+        if (useCache) {
+            clearCache()
+        }
+
         //check
         if (isErr) {
             return Promise.reject(res)
@@ -285,6 +334,14 @@ function WOrmPostgresql(opt = {}) {
         let isErr = false
         let res = null
 
+        //cache
+        if (useCache) {
+            let cache = getCache(find, order)
+            if (isarr(cache)) {
+                return cache
+            }
+        }
+
         //client
         let client = new PgClient({ connectionString })
 
@@ -333,6 +390,11 @@ function WOrmPostgresql(opt = {}) {
                 res = `can not select by find[${JSON.stringify(find)}]`
             }
 
+            //cache
+            if (useCache && !isErr) {
+                setCache(find, order, res)
+            }
+
         }
         catch (err) {
             isErr = true
@@ -436,9 +498,6 @@ function WOrmPostgresql(opt = {}) {
                         ok: 1,
                     }
 
-                    //emit
-                    ee.emit('change', 'insert', data, res)
-
                 })
                 .catch((err) => {
                     isErr = true
@@ -455,6 +514,21 @@ function WOrmPostgresql(opt = {}) {
             client = null
         }
 
+        //update
+        if (useCache) {
+            clearCache()
+        }
+
+        //emit
+        if (!isErr) {
+            try {
+                ee.emit('change', 'insert', data, res)
+            }
+            catch (err) {
+                console.log(err)
+            }
+        }
+
         //check
         if (isErr) {
             return Promise.reject(res)
@@ -688,9 +762,6 @@ function WOrmPostgresql(opt = {}) {
                 return rest
             })
 
-            //emit
-            ee.emit('change', 'save', data, res)
-
         }
         catch (err) {
             isErr = true
@@ -701,6 +772,21 @@ function WOrmPostgresql(opt = {}) {
             client = null
         }
 
+        //update
+        if (useCache) {
+            clearCache()
+        }
+
+        //emit
+        if (!isErr) {
+            try {
+                ee.emit('change', 'save', data, res)
+            }
+            catch (err) {
+                console.log(err)
+            }
+        }
+
         //check
         if (isErr) {
             return Promise.reject(res)
@@ -813,9 +899,6 @@ function WOrmPostgresql(opt = {}) {
                 return rest
             })
 
-            //emit
-            ee.emit('change', 'del', data, res)
-
         }
         catch (err) {
             isErr = true
@@ -826,6 +909,21 @@ function WOrmPostgresql(opt = {}) {
             client = null
         }
 
+        //update
+        if (useCache) {
+            clearCache()
+        }
+
+        //emit
+        if (!isErr) {
+            try {
+                ee.emit('change', 'del', data, res)
+            }
+            catch (err) {
+                console.log(err)
+            }
+        }
+
         //check
         if (isErr) {
             return Promise.reject(res)
@@ -903,9 +1001,6 @@ function WOrmPostgresql(opt = {}) {
                         ok: 1,
                     }
 
-                    //emit
-                    ee.emit('change', 'delAll', null, res)
-
                 })
                 .catch((err) => {
                     isErr = true
@@ -922,6 +1017,21 @@ function WOrmPostgresql(opt = {}) {
             client = null
         }
 
+        //update
+        if (useCache) {
+            clearCache()
+        }
+
+        //emit
+        if (!isErr) {
+            try {
+                ee.emit('change', 'delAll', null, res)
+            }
+            catch (err) {
+                console.log(err)
+            }
+        }
+
         //check
         if (isErr) {
             return Promise.reject(res)
@@ -957,7 +1067,7 @@ export default WOrmPostgresql
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Sun May 11 2025 15:23:24 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Fri May 15 2026 13:15:32 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.html

@@ -71,7 +71,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Sun May 11 2025 15:23:24 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Fri May 15 2026 13:15:32 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/g-basic.mjs

@@ -103,6 +103,13 @@ let rsm = [
     },
 ]
 
+let rsa = [
+    {
+        time: '2025-01-01T00:13:00Z',
+        name: 'sandler',
+    },
+]
+
 async function test() {
 
     //wo
@@ -145,7 +152,7 @@ async function test() {
         })
 
     //save
-    await wo.save(rsm, { autoInsert: true })
+    await wo.save(rsm, { autoInsert: false })
         .then(function(msg) {
             console.log('save then', msg)
         })
@@ -177,6 +184,15 @@ async function test() {
     // let sr = await wo.select({ name: { $regex: 'PeT', $options: '$i' } })
     // console.log('selectReg', sr)
 
+    //save
+    await wo.save(rsa, { autoInsert: true })
+        .then(function(msg) {
+            console.log('save then', msg)
+        })
+        .catch(function(msg) {
+            console.log('save catch', msg)
+        })
+
     //del
     let d = {
         time: '2024-01-01T00:00:00Z',
@@ -190,7 +206,8 @@ async function test() {
         })
 
     //del
-    let ds = ss.filter(function(v) {
+    let ssDel = await wo.select()
+    let ds = ssDel.filter(function(v) {
         return v.name.indexOf('peter') >= 0 || v.name.indexOf('kettle') >= 0 || v.name.indexOf('sandler') >= 0
     })
     await wo.del(ds)
@@ -205,6 +222,68 @@ async function test() {
     let ss2 = await wo.select()
     console.log('select all final', ss2)
 
+    //清除數據, 後續cache測試共用users表
+    await wo.delAll()
+
+    //woc, 啟用useCache
+    let woc = WOrm({
+        ...opt,
+        useCache: true,
+    })
+
+    let rsc = [
+        {
+            time: '2025-01-01T00:00:00Z',
+            name: 'peter',
+            value: 123,
+        },
+        {
+            time: '2025-01-01T00:01:00Z',
+            name: 'rosemary',
+            value: 123.456,
+        },
+        {
+            time: '2025-01-01T00:02:00Z',
+            name: 'kettle',
+            value: 456,
+        },
+    ]
+
+    let rscm = [
+        {
+            time: '2025-01-01T00:01:00Z',
+            name: 'rosemary(modify)',
+            value: 654.321,
+        },
+    ]
+
+    //insert
+    await woc.insert(rsc)
+
+    //select all (1st time, 從DB讀取並填入快取)
+    let sc1 = await woc.select()
+    sc1 = sc1.sort((a, b) => a.time - b.time)
+    console.log('select all 1st (fill cache)', sc1)
+
+    //select all (2nd time, 命中快取, 內容須與第一次相同)
+    let sc2 = await woc.select()
+    sc2 = sc2.sort((a, b) => a.time - b.time)
+    console.log('select all 2nd (cache hit)', sc2)
+
+    //save (更新rosemary, 觸發快取重設)
+    await woc.save(rscm, { autoInsert: false })
+        .then(function(msg) {
+            console.log('save (invalidate cache) then', msg)
+        })
+        .catch(function(msg) {
+            console.log('save (invalidate cache) catch', msg)
+        })
+
+    //select all (3rd time, 快取已重設, 從DB重新讀取, 須反映rosemary更新)
+    let sc3 = await woc.select()
+    sc3 = sc3.sort((a, b) => a.time - b.time)
+    console.log('select all 3rd (reload after save)', sc3)
+
 }
 test()
 // change delAll
@@ -217,7 +296,7 @@ test()
 //   { n: 1, nModified: 1, ok: 1 },
 //   { n: 1, nModified: 1, ok: 1 },
 //   { n: 1, nModified: 1, ok: 1 },
-//   { n: 1, nInserted: 1, ok: 1 }
+//   { n: 0, nModified: 0, ok: 1 }
 // ]
 // select all [
 //   { time: 2025-01-01T00:00:00.000Z, name: 'peter', value: 123 },
@@ -240,8 +319,7 @@ test()
 //     name: 'kettle(modify)',
 //     value: 447
 //   },
-//   { time: 2025-01-01T00:12:00.000Z, name: 'peter', value: 99 },
-//   { time: 2025-01-01T00:13:00.000Z, name: 'sandler', value: null }
+//   { time: 2025-01-01T00:12:00.000Z, name: 'peter', value: 99 }
 // ]
 // select by name [
 //   { time: 2025-01-01T00:01:00.000Z, name: 'rosemary', value: 123.456 },
@@ -277,6 +355,8 @@ test()
 //     value: 447
 //   }
 // ]
+// change save
+// save then [ { n: 1, nInserted: 1, ok: 1 } ]
 // change del
 // del then [ { n: 1, nDeleted: 0, ok: 1 } ]
 // change del
@@ -302,5 +382,26 @@ test()
 //     value: 113.98
 //   }
 // ]
+// change delAll
+// select all 1st (fill cache) [
+//   { time: 2025-01-01T00:00:00.000Z, name: 'peter', value: 123 },
+//   { time: 2025-01-01T00:01:00.000Z, name: 'rosemary', value: 123.456 },
+//   { time: 2025-01-01T00:02:00.000Z, name: 'kettle', value: 456 }
+// ]
+// select all 2nd (cache hit) [
+//   { time: 2025-01-01T00:00:00.000Z, name: 'peter', value: 123 },
+//   { time: 2025-01-01T00:01:00.000Z, name: 'rosemary', value: 123.456 },
+//   { time: 2025-01-01T00:02:00.000Z, name: 'kettle', value: 456 }
+// ]
+// save (invalidate cache) then [ { n: 1, nModified: 1, ok: 1 } ]
+// select all 3rd (reload after save) [
+//   { time: 2025-01-01T00:00:00.000Z, name: 'peter', value: 123 },
+//   {
+//     time: 2025-01-01T00:01:00.000Z,
+//     name: 'rosemary(modify)',
+//     value: 654.321
+//   },
+//   { time: 2025-01-01T00:02:00.000Z, name: 'kettle', value: 456 }
+// ]
 
 //node g-basic.mjs

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "w-orm-postgresql",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "main": "dist/w-orm-postgresql.umd.js",
   "dependencies": {
     "mongo-sql": "^6.2.0",
-    "pg": "^8.15.6",
-    "lodash-es": "^4.17.21",
-    "wsemi": "^1.7.90"
+    "pg": "^8.20.0",
+    "lodash-es": "^4.18.1",
+    "wsemi": "^1.8.52"
   },
   "devDependencies": {
-    "w-package-tools": "^1.0.90"
+    "w-package-tools": "^1.1.5"
   },
   "scripts": {
     "test": "mocha --parallel --timeout 60000",

package/script.txt

@@ -15,4 +15,3 @@ npm run deploy
 #npm test
 
 #npm publish
-

package/src/WOrmPostgresql.mjs

@@ -19,6 +19,7 @@ import isnum from 'wsemi/src/isnum.mjs'
 import isint from 'wsemi/src/isint.mjs'
 import isbol from 'wsemi/src/isbol.mjs'
 import isDate from 'wsemi/src/isDate.mjs'
+import haskey from 'wsemi/src/haskey.mjs'
 import pmSeries from 'wsemi/src/pmSeries.mjs'
 
 
@@ -30,10 +31,14 @@ import pmSeries from 'wsemi/src/pmSeries.mjs'
  * @param {String} [opt.url='postgresql://127.0.0.1:5432'] 輸入連接資料庫字串，預設'postgresql://127.0.0.1:5432'
  * @param {String} [opt.db='worm'] 輸入使用資料庫名稱字串，預設'worm'
  * @param {String} [opt.cl='test'] 輸入使用資料表名稱字串，預設'test'
+ * @param {Boolean} [opt.useCache=false] 輸入是否使用select快取，適用於單程序操作，預設false
  * @returns {Object} 回傳操作資料庫物件，各事件功能詳見說明
  */
 function WOrmPostgresql(opt = {}) {
 
+    //_cache
+    let _cache = null
+
     //url
     let url = get(opt, 'url')
     if (!isestr(url)) {
@@ -52,6 +57,12 @@ function WOrmPostgresql(opt = {}) {
         cl = 'test'
     }
 
+    //useCache
+    let useCache = get(opt, 'useCache')
+    if (!isbol(useCache)) {
+        useCache = false
+    }
+
     //getValueType
     function getValueType(value) {
         if (isstr(value)) {
@@ -144,6 +155,39 @@ function WOrmPostgresql(opt = {}) {
     let PgClient = pg.Client
     // console.log('PgClient', PgClient)
 
+    //clearCache
+    function clearCache() {
+        _cache = null
+    }
+
+    //getCacheKey
+    function getCacheKey(find = {}, order = {}) {
+        return JSON.stringify({
+            find,
+            order,
+        })
+    }
+
+    //getCache
+    function getCache(find = {}, order = {}) {
+        if (iseobj(_cache)) {
+            let key = getCacheKey(find, order)
+            if (haskey(_cache, key)) {
+                return cloneDeep(_cache[key]) //與外部使用數據脫勾
+            }
+        }
+        return null
+    }
+
+    //setCache
+    function setCache(find = {}, order = {}, data = []) {
+        if (!iseobj(_cache)) {
+            _cache = {}
+        }
+        let key = getCacheKey(find, order)
+        _cache[key] = cloneDeep(data) //與外部使用數據脫勾
+    }
+
     /**
      * 創建資料表
      *
@@ -218,6 +262,11 @@ function WOrmPostgresql(opt = {}) {
         }
         // console.log('res', res)
 
+        //update
+        if (useCache) {
+            clearCache()
+        }
+
         //check
         if (isErr) {
             return Promise.reject(res)
@@ -238,6 +287,14 @@ function WOrmPostgresql(opt = {}) {
         let isErr = false
         let res = null
 
+        //cache
+        if (useCache) {
+            let cache = getCache(find, order)
+            if (isarr(cache)) {
+                return cache
+            }
+        }
+
         //client
         let client = new PgClient({ connectionString })
 
@@ -286,6 +343,11 @@ function WOrmPostgresql(opt = {}) {
                 res = `can not select by find[${JSON.stringify(find)}]`
             }
 
+            //cache
+            if (useCache && !isErr) {
+                setCache(find, order, res)
+            }
+
         }
         catch (err) {
             isErr = true
@@ -389,9 +451,6 @@ function WOrmPostgresql(opt = {}) {
                         ok: 1,
                     }
 
-                    //emit
-                    ee.emit('change', 'insert', data, res)
-
                 })
                 .catch((err) => {
                     isErr = true
@@ -408,6 +467,21 @@ function WOrmPostgresql(opt = {}) {
             client = null
         }
 
+        //update
+        if (useCache) {
+            clearCache()
+        }
+
+        //emit
+        if (!isErr) {
+            try {
+                ee.emit('change', 'insert', data, res)
+            }
+            catch (err) {
+                console.log(err)
+            }
+        }
+
         //check
         if (isErr) {
             return Promise.reject(res)
@@ -641,9 +715,6 @@ function WOrmPostgresql(opt = {}) {
                 return rest
             })
 
-            //emit
-            ee.emit('change', 'save', data, res)
-
         }
         catch (err) {
             isErr = true
@@ -654,6 +725,21 @@ function WOrmPostgresql(opt = {}) {
             client = null
         }
 
+        //update
+        if (useCache) {
+            clearCache()
+        }
+
+        //emit
+        if (!isErr) {
+            try {
+                ee.emit('change', 'save', data, res)
+            }
+            catch (err) {
+                console.log(err)
+            }
+        }
+
         //check
         if (isErr) {
             return Promise.reject(res)
@@ -766,9 +852,6 @@ function WOrmPostgresql(opt = {}) {
                 return rest
             })
 
-            //emit
-            ee.emit('change', 'del', data, res)
-
         }
         catch (err) {
             isErr = true
@@ -779,6 +862,21 @@ function WOrmPostgresql(opt = {}) {
             client = null
         }
 
+        //update
+        if (useCache) {
+            clearCache()
+        }
+
+        //emit
+        if (!isErr) {
+            try {
+                ee.emit('change', 'del', data, res)
+            }
+            catch (err) {
+                console.log(err)
+            }
+        }
+
         //check
         if (isErr) {
             return Promise.reject(res)
@@ -856,9 +954,6 @@ function WOrmPostgresql(opt = {}) {
                         ok: 1,
                     }
 
-                    //emit
-                    ee.emit('change', 'delAll', null, res)
-
                 })
                 .catch((err) => {
                     isErr = true
@@ -875,6 +970,21 @@ function WOrmPostgresql(opt = {}) {
             client = null
         }
 
+        //update
+        if (useCache) {
+            clearCache()
+        }
+
+        //emit
+        if (!isErr) {
+            try {
+                ee.emit('change', 'delAll', null, res)
+            }
+            catch (err) {
+                console.log(err)
+            }
+        }
+
         //check
         if (isErr) {
             return Promise.reject(res)