w-orm-postgresql 1.0.7 → 1.0.9

package/src/WOrmPostgresql.mjs

@@ -368,11 +368,131 @@ function WOrmPostgresql(opt = {}) {
     }
 
     /**
-     * 插入數據
+     * 由主鍵time查詢單筆數據，因直接由資料表主鍵索引取值，不需如select提取數據至前端再處理，故數據量大時效能較佳
+     *
+     * 函數名依主鍵欄位命名為selectByTime而不另掛selectById別名，因本套件之主鍵為具業務語義之time，
+     * 與以無語義識別碼為主鍵者性質不同，該差異須由呼叫端知悉而非由別名掩蓋。
+     * 主鍵未命中或主鍵值無效皆回傳null而不reject，命中之判定基準與insert、save、del內對既有數據之認定一致。
+     *
+     * @memberOf WOrmPostgresql
+     * @param {String|Date} time 輸入主鍵time值，本套件以time欄位為主鍵
+     * @returns {Promise} 回傳Promise，resolve回傳數據物件，若無此time則回傳null，reject回傳錯誤訊息
+     */
+    async function selectByTime(time) {
+        let isErr = false
+        let res = null
+
+        //check
+        if (!isDate(time)) {
+            //未給有效主鍵值視為查無數據, 判定基準與insert、save、del內對time之認定一致
+            return null
+        }
+
+        //find, 本套件以time欄位為主鍵, 與save、del、genConflictSQL之認定一致
+        let find = {
+            time,
+        }
+
+        //cache, 與select共用快取, 因快取鍵值由find與order組成, 故此處等同select(find)之結果
+        if (useCache) {
+            let cache = getCache(find, {})
+            if (isarr(cache)) {
+                return get(cache, 0, null)
+            }
+        }
+
+        //client
+        let client = new PgClient({ connectionString })
+
+        //connect
+        try {
+
+            //connect
+            await client.connect()
+
+        }
+        catch (err) {
+            isErr = true
+            res = err
+            client = null
+        }
+
+        //check
+        if (isErr) {
+            return Promise.reject(res)
+        }
+
+        try {
+
+            //mr, 不使用limit以令結果與select(find)完全等價, 方能安全共用快取,
+            //time為主鍵時本就僅回傳1筆, 不會因此多拉數據
+            let mr = mongoSql.sql({
+                type: 'select',
+                table: cl,
+                where: find,
+            })
+            // console.log('mr', mr)
+            // console.log('mr.query', mr.query)
+            // console.log('mr.values', mr.values)
+
+            //select
+            let r = await client.query(mr.query, mr.values)
+            // console.log('r', r)
+
+            //rows
+            let rows = get(r, 'rows')
+
+            //check
+            if (!isarr(rows)) {
+                throw new Error(`can not select by time[${time}]`)
+            }
+
+            //cache
+            if (useCache) {
+                setCache(find, {}, rows)
+            }
+
+            //v
+            let v = get(rows, 0, null)
+
+            //check, 判定基準與save、del內對既有數據之認定一致
+            if (iseobj(v)) {
+                res = v
+            }
+            else {
+                //不存在time, 回傳null
+                res = null
+            }
+
+        }
+        catch (err) {
+            isErr = true
+            res = err
+        }
+        finally {
+            await client.end()
+            client = null
+        }
+        // console.log('res', res)
+
+        //check
+        if (isErr) {
+            return Promise.reject(res)
+        }
+
+        return res
+    }
+
+    /**
+     * 插入數據，僅於主鍵time不存在時寫入，已存在者跳過且不覆寫
+     *
+     * n為輸入筆數，即本次嘗試插入之基準；nInserted為實際插入筆數，全數已存在而nInserted為0屬正常結果，
+     * 不視為錯誤。同批含重複time時僅首筆計入nInserted。
+     * 因主鍵time承載觀測時間之業務意義，未帶有效time時不自動補值，一律以reject回報。
      *
      * @memberOf WOrmPostgresql
      * @param {Object|Array} data 輸入數據物件或陣列
-     * @returns {Promise} 回傳Promise，resolve回傳插入結果，reject回傳錯誤訊息
+     * @returns {Promise} 回傳Promise，resolve回傳插入結果物件{n,nInserted,ok}，reject回傳錯誤訊息
      */
     async function insert(data) {
         let isErr = false
@@ -436,18 +556,22 @@ function WOrmPostgresql(opt = {}) {
             // console.log('mr.query', mr.query)
             // console.log('mr.values', mr.values)
 
-            //nAll, nInsert
+            //添加conflict, 令已存在time者跳過而不中斷整批插入, 主鍵認定與genConflictSQL一致
+            //由PostgreSQL於單一語句內原子完成[檢查time未存在]與[寫入], 併發時同一time僅有一次成功,
+            //同批含重複time時亦僅首筆成功, 故不須逐筆插入即可取得實際插入筆數
+            let sql = `${mr.query} ON CONFLICT (time) DO NOTHING`
+
+            //nAll
             let nAll = size(data)
-            let nInsert = nAll //一次插入全部數據加速, 但也因此沒法個別處理conflict, 無法個別計算已插入數量
 
-            //insert
-            await client.query(mr.query, mr.values)
-                .then(() => {
+            //insert, ON CONFLICT DO NOTHING時rowCount即為實際插入筆數
+            await client.query(sql, mr.values)
+                .then((r) => {
 
                     //res
                     res = {
                         n: nAll,
-                        nInserted: nInsert,
+                        nInserted: r.rowCount,
                         ok: 1,
                     }
 
@@ -491,13 +615,21 @@ function WOrmPostgresql(opt = {}) {
     }
 
     /**
-     * 儲存數據
+     * 儲存數據，以主鍵time為準更新既有數據，未給之欄位保留
+     *
+     * 回傳陣列恆與輸入等長，輸入單一物件亦回傳長度1之陣列。
+     * 各筆之n為主鍵命中筆數，值為0或1，命中(不論內容有無變更)或經插入而產生皆為1；
+     * nInserted與nModified恆同時出現，無對應行為時填0。
+     * [內容相同]之判定基準為待寫入物件合併進現值後與現值相同，非待寫入物件與現值全等，
+     * 故只給部份欄位且該些欄位值皆與現值相同時，合併結果等於現值，nModified為0，
+     * 令nModified忠實反映資料庫端是否真的寫入。
+     * 因主鍵time承載觀測時間之業務意義，未帶有效time時不自動補值，一律以reject回報。
      *
      * @memberOf WOrmPostgresql
      * @param {Object|Array} data 輸入數據物件或陣列
      * @param {Object} [option={}] 輸入設定物件，預設為{}
      * @param {boolean} [option.autoInsert=true] 輸入是否於儲存時發現原本無數據，則自動改以插入處理，預設為true
-     * @returns {Promise} 回傳Promise，resolve回傳儲存結果，reject回傳錯誤訊息
+     * @returns {Promise} 回傳Promise，resolve回傳儲存結果陣列[{n,nInserted,nModified,ok}]，reject回傳錯誤訊息
      */
     async function save(data, option = {}) {
         let isErr = false
@@ -588,98 +720,160 @@ function WOrmPostgresql(opt = {}) {
 
                 }
 
-                //check
+                //快速路徑, 先不寫入直接由前述預讀判斷內容是否相同, 內容相同者本就不須寫入,
+                //預讀值縱使已被其他寫入者更動而過期亦不影響正確性, 因內容相同時本次save等價於無操作,
+                //無操作可視為於預讀當下即已完成, 其後他人之寫入結果與[本次save先執行再輪到他人]相同
                 if (iseobj(_v)) {
-                    //存在
 
                     //_vt
                     let _vt = omit(_v, 'time')
                     // console.log('_vt', _vt)
 
-                    //vt
-                    let vt = omit(v, 'time')
+                    //vt, [內容相同]之判定基準為[待寫入物件合併進現值後與現值相同],
+                    //非[待寫入物件與現值全等], 故只給部份欄位且該些欄位值皆與現值相同時視為相同而不寫入,
+                    //合併採淺層覆蓋, 與後端以EXCLUDED整欄取代之寫入行為一致
+                    let vt = {
+                        ..._vt,
+                        ...omit(v, 'time'),
+                    }
                     // console.log('vt', vt)
 
-                    if (isEqual(_vt, vt)) {
+                    if (isEqual(vt, _vt)) {
                         //相同時不更新
 
                         //rest
                         rest = {
                             n: 1,
+                            nInserted: 0,
                             nModified: 0,
                             ok: 1,
                         }
                         // console.log('相同時不更新', rest, v)
 
+                        return rest
                     }
-                    else {
-                        //不相同時須更新
-
-                        //mr
-                        let mr = mongoSql.sql({
-                            type: 'insert',
-                            table: cl,
-                            values: v,
-                        })
-                        // console.log('mr', mr)
-                        // console.log('mr.query', mr.query)
-                        // console.log('mr.values', mr.values)
 
-                        //添加conflict
-                        let conflict = genConflictSQL(v)
+                }
+                else {
+
+                    //check
+                    if (!autoInsert) {
+                        //不存在且未開啟autoInsert則不寫入
+
+                        //rest
+                        rest = {
+                            n: 0,
+                            nInserted: 0,
+                            nModified: 0,
+                            ok: 1,
+                        }
+                        // console.log('不存在', rest, v)
+
+                        return rest
+                    }
+
+                }
+
+                //check
+                if (autoInsert) {
+                    //由PostgreSQL於單一語句內原子完成[查找time]與[插入或更新],
+                    //併發時不會因他方已先插入同一time而報錯, 亦不會有兩方各自讀到同一舊值再各自寫入
+
+                    //mr
+                    let mr = mongoSql.sql({
+                        type: 'insert',
+                        table: cl,
+                        values: v,
+                    })
+                    // console.log('mr', mr)
+                    // console.log('mr.query', mr.query)
+                    // console.log('mr.values', mr.values)
+
+                    //添加conflict, 僅有time欄位時genConflictSQL無可更新欄位而回傳空字串,
+                    //此時退回DO NOTHING, 以免併發插入同一time者報錯
+                    let conflict = genConflictSQL(v)
+                    if (!isestr(conflict)) {
+                        conflict = 'ON CONFLICT (time) DO NOTHING'
+                    }
 
-                        //sql
-                        let sql = `${mr.query} ${conflict}`
+                    //sql, xmax為0表該列由本語句插入, 非0表係由DO UPDATE更新而來,
+                    //衝突且落入DO NOTHING時不回傳任何列, 代表該time已存在且未變更
+                    let sql = `${mr.query} ${conflict} RETURNING (xmax = 0) AS inserted`
 
-                        //save
-                        await client.query(sql, mr.values)
-                            .then(() => {
+                    //save
+                    await client.query(sql, mr.values)
+                        .then((r) => {
+
+                            //rows
+                            let rows = get(r, 'rows')
+
+                            //check
+                            if (!isearr(rows)) {
+                                //衝突且未更新
 
                                 //rest
                                 rest = {
                                     n: 1,
-                                    nModified: 1,
+                                    nInserted: 0,
+                                    nModified: 0,
                                     ok: 1,
                                 }
-                                // console.log('不相同時須更新', rest, vt)
 
-                            })
-                            .catch((err) => {
+                            }
+                            else if (get(rows, '0.inserted') === true) {
+                                //原不存在而插入
 
                                 //rest
                                 rest = {
                                     n: 1,
+                                    nInserted: 1,
                                     nModified: 0,
-                                    ok: 0,
-                                    err: err.message,
+                                    ok: 1,
                                 }
+                                // console.log('之前不存在且可自動插入', rest, v)
 
-                            })
+                            }
+                            else {
+                                //原已存在而更新
 
-                    }
-                }
-                else {
-                    //不存在
+                                //rest
+                                rest = {
+                                    n: 1,
+                                    nInserted: 0,
+                                    nModified: 1,
+                                    ok: 1,
+                                }
+                                // console.log('不相同時須更新', rest, v)
 
-                    //rest
-                    rest = {
-                        n: 0,
-                        nModified: 0,
-                        ok: 1,
-                    }
-                    // console.log('不存在', rest, v)
+                            }
 
-                }
+                        })
+                        .catch((err) => {
 
-                //autoInsert
-                if (autoInsert && rest.n === 0) {
-                    //之前不存在(rest.n)且可自動插入(autoInsert=true)
+                            //rest
+                            rest = {
+                                n: 1,
+                                nInserted: 0,
+                                nModified: 0,
+                                ok: 0,
+                                err: err.message,
+                            }
+
+                        })
+
+                }
+                else {
+                    //未開啟autoInsert則僅能更新既有數據, 不可用INSERT以免無中生有,
+                    //由UPDATE...WHERE time原子完成[查找time]與[更新], 併發時不會遺失更新
 
                     //mr
                     let mr = mongoSql.sql({
-                        type: 'insert',
+                        type: 'update',
                         table: cl,
-                        values: v,
+                        updates: omit(v, 'time'),
+                        where: {
+                            time: v.time,
+                        },
                     })
                     // console.log('mr', mr)
                     // console.log('mr.query', mr.query)
@@ -687,15 +881,34 @@ function WOrmPostgresql(opt = {}) {
 
                     //save
                     await client.query(mr.query, mr.values)
-                        .then(() => {
+                        .then((r) => {
+
+                            //check
+                            if (r.rowCount > 0) {
+                                //已更新
+
+                                //rest
+                                rest = {
+                                    n: 1,
+                                    nInserted: 0,
+                                    nModified: 1,
+                                    ok: 1,
+                                }
+                                // console.log('不相同時須更新', rest, v)
+
+                            }
+                            else {
+                                //預讀後至更新前已被他人刪除, 視為不存在
+
+                                //rest
+                                rest = {
+                                    n: 0,
+                                    nInserted: 0,
+                                    nModified: 0,
+                                    ok: 1,
+                                }
 
-                            //rest
-                            rest = {
-                                n: 1,
-                                nInserted: 1,
-                                ok: 1,
                             }
-                            // console.log('之前不存在且可自動插入', rest, v)
 
                         })
                         .catch((err) => {
@@ -704,6 +917,7 @@ function WOrmPostgresql(opt = {}) {
                             rest = {
                                 n: 1,
                                 nInserted: 0,
+                                nModified: 0,
                                 ok: 0,
                                 err: err.message,
                             }
@@ -751,9 +965,14 @@ function WOrmPostgresql(opt = {}) {
     /**
      * 刪除數據
      *
+     * 回傳陣列恆與輸入等長，各筆之n與nDeleted皆為主鍵命中筆數，值為0或1，未命中為0且屬正常結果。
+     * 判斷某筆是否真的被刪除一律以nDeleted為準。
+     * 未帶有效time者為該筆之輸入問題，回ok:0與err且不送查詢，不中斷其餘筆數，
+     * 以此與[主鍵未命中]之ok:1區辨。
+     *
      * @memberOf WOrmPostgresql
      * @param {Object|Array} data 輸入數據物件或陣列
-     * @returns {Promise} 回傳Promise，resolve回傳刪除結果，reject回傳錯誤訊息
+     * @returns {Promise} 回傳Promise，resolve回傳刪除結果陣列[{n,nDeleted,ok}]，reject回傳錯誤訊息
      */
     async function del(data) {
         let isErr = false
@@ -799,39 +1018,49 @@ function WOrmPostgresql(opt = {}) {
                 data = [data]
             }
 
-            //check time
-            data = map(data, function(v, k) {
-                if (!isDate(v.time)) {
-                    throw new Error(`invalid data[${k}].time[${v.time}]`)
-                }
-                return v
-            })
-
             //pmSeries
             res = await pmSeries(data, async(v) => {
 
                 //rest
                 let rest = null
 
+                //time
+                let time = get(v, 'time')
+
+                //check time, 未帶有效主鍵者不補值亦不送查詢,
+                //因mongo-sql會將無效值轉為null而誤中其他數據, 故直接視為該筆無法處理
+                if (!isDate(time)) {
+
+                    //rest
+                    rest = {
+                        n: 0,
+                        nDeleted: 0,
+                        ok: 0,
+                        err: `invalid time[${time}]`,
+                    }
+
+                    return rest
+                }
+
                 //mr
                 let mr = mongoSql.sql({
                     type: 'delete',
                     table: cl,
                     where: {
-                        time: v.time,
+                        time,
                     },
                 })
                 // console.log('mr', mr)
                 // console.log('mr.query', mr.query)
                 // console.log('mr.values', mr.values)
 
-                //del
+                //del, n與nDeleted皆為主鍵命中筆數, 未命中為0
                 await client.query(mr.query, mr.values)
                     .then((r) => {
 
                         //res
                         rest = {
-                            n: 1,
+                            n: r.rowCount,
                             nDeleted: r.rowCount,
                             ok: 1,
                         }
@@ -888,9 +1117,12 @@ function WOrmPostgresql(opt = {}) {
     /**
      * 刪除全部數據，需與del分開，避免未傳數據導致直接刪除全表
      *
+     * n與nDeleted皆為實際刪除筆數，不取全表筆數。find未給或為空物件時刪除全部數據，
+     * 條件無命中時回{n:0,nDeleted:0,ok:1}，不視為錯誤。
+     *
      * @memberOf WOrmPostgresql
      * @param {Object} [find={}] 輸入刪除條件物件
-     * @returns {Promise} 回傳Promise，resolve回傳刪除結果，reject回傳錯誤訊息
+     * @returns {Promise} 回傳Promise，resolve回傳刪除結果物件{n,nDeleted,ok}，reject回傳錯誤訊息
      */
     async function delAll(find = {}) {
         let isErr = false
@@ -996,6 +1228,7 @@ function WOrmPostgresql(opt = {}) {
     //save
     ee.createTable = createTable
     ee.select = select
+    ee.selectByTime = selectByTime
     ee.insert = insert
     ee.save = save
     ee.del = del