w-orm-mongodb 1.1.37 → 1.1.39

package/docs/index.html

@@ -29,7 +29,7 @@
 <nav >
     
     
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WOrmMongodb.html">WOrmMongodb</a><ul class='methods'><li data-type='method'><a href="WOrmMongodb.html#.del">del</a></li><li data-type='method'><a href="WOrmMongodb.html#.delAll">delAll</a></li><li data-type='method'><a href="WOrmMongodb.html#.delAllGfs">delAllGfs</a></li><li data-type='method'><a href="WOrmMongodb.html#.delGfs">delGfs</a></li><li data-type='method'><a href="WOrmMongodb.html#.insert">insert</a></li><li data-type='method'><a href="WOrmMongodb.html#.insertGfs">insertGfs</a></li><li data-type='method'><a href="WOrmMongodb.html#.save">save</a></li><li data-type='method'><a href="WOrmMongodb.html#.select">select</a></li><li data-type='method'><a href="WOrmMongodb.html#.selectGfs">selectGfs</a></li></ul></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WOrmMongodb.html">WOrmMongodb</a><ul class='methods'><li data-type='method'><a href="WOrmMongodb.html#.del">del</a></li><li data-type='method'><a href="WOrmMongodb.html#.delAll">delAll</a></li><li data-type='method'><a href="WOrmMongodb.html#.delAllGfs">delAllGfs</a></li><li data-type='method'><a href="WOrmMongodb.html#.delGfs">delGfs</a></li><li data-type='method'><a href="WOrmMongodb.html#.insert">insert</a></li><li data-type='method'><a href="WOrmMongodb.html#.insertGfs">insertGfs</a></li><li data-type='method'><a href="WOrmMongodb.html#.save">save</a></li><li data-type='method'><a href="WOrmMongodb.html#.select">select</a></li><li data-type='method'><a href="WOrmMongodb.html#.selectByPk">selectByPk</a></li><li data-type='method'><a href="WOrmMongodb.html#.selectByPkGfs">selectByPkGfs</a></li></ul></li></ul>
     
 </nav>
 
@@ -71,7 +71,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Sat Aug 08 2026 14:31:31 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 Sun Aug 16 2026 23:36:47 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/g-basic.mjs

@@ -98,10 +98,18 @@ async function test() {
     let spc = await wo.select({ '$or': [{ '$and': [{ value: { '$ne': 123 } }, { value: { '$in': [123, 321, 123.456, 456] } }, { value: { '$nin': [456, 654] } }] }, { '$or': [{ value: { '$lte': -1 } }, { value: { '$gte': 400 } }] }] })
     console.log('select by $or, $and, $ne, $in, $nin', spc)
 
-    //select by regex
-    let sr = await wo.select({ name: { $regex: 'PeT', $options: '$i' } })
+    //select by regex, $options之合法flag僅有i、m、x、s
+    let sr = await wo.select({ name: { $regex: 'PeT', $options: 'i' } })
     console.log('selectReg', sr)
 
+    //selectByPk, 由id直接查找單筆, 不需如select提取全部符合數據再處理
+    let sbi = await wo.selectByPk('id-rosemary')
+    console.log('selectByPk', sbi)
+
+    //selectByPk by id not existed
+    let sbn = await wo.selectByPk('id-not-existed')
+    console.log('selectByPk by id not existed', sbn)
+
     //del
     let d = ss.filter(function(v) {
         return v.name === 'kettle'
@@ -117,14 +125,14 @@ async function test() {
 }
 test()
 // change delAll
-// delAll then { n: 2, nDeleted: 2, ok: 1 }
+// delAll then { n: 0, nDeleted: 0, ok: 1 }
 // change insert
 // insert then { n: 3, nInserted: 3, ok: 1 }
 // change save
 // save then [
-//   { n: 1, nModified: 1, ok: 1 },
-//   { n: 1, nModified: 1, ok: 1 },
-//   { n: 0, nModified: 0, ok: 1 }
+//   { n: 1, nInserted: 0, nModified: 1, ok: 1 },
+//   { n: 1, nInserted: 0, nModified: 1, ok: 1 },
+//   { n: 0, nInserted: 0, nModified: 0, ok: 1 }
 // ]
 // select all [
 //   { id: 'id-peter', name: 'peter(modify)', value: 123 },
@@ -157,6 +165,8 @@ test()
 //   }
 // ]
 // selectReg [ { id: 'id-peter', name: 'peter(modify)', value: 123 } ]
+// selectByPk { id: 'id-rosemary', name: 'rosemary(modify)', value: 123.456 }
+// selectByPk by id not existed null
 // change del
 // del then [ { n: 1, nDeleted: 1, ok: 1 } ]
 

package/g-gfs.mjs

@@ -1,102 +1,102 @@
-import path from 'path'
-import fs from 'fs'
-import WOrm from './src/WOrmMongodb.mjs'
-//import WOrm from './dist/w-orm-mongodb.umd.js'
-
-
-let opt = {
-    url: 'mongodb://username:password@127.0.0.1:27017',
-    db: 'worm',
-    cl: 'usersGfs',
-}
-
-async function test() {
-
-    //wo
-    let wo = WOrm(opt)
-
-    //on
-    wo.on('change', function(mode, data, res) {
-        console.log('change', mode)
-    })
-
-    //fn_in, fn_out
-    let fn_in = path.resolve('../', './_data', 'data(in).dat')
-    let fn_out = path.resolve('../', './_data', 'data(out).dat')
-    // console.log('fn_in', fn_in)
-    // console.log('fn_out', fn_out)
-
-    //unlinkSync
-    try {
-        fs.unlinkSync(fn_out)
-    }
-    catch (err) {}
-
-    //u8a
-    let b = await fs.readFileSync(fn_in)
-    let u8a = new Uint8Array(b)
-    // let u8a = new Uint8Array([66, 97, 115]) //Uint8Array data from nodejs or browser
-    console.log('u8a', u8a)
-
-    //delAllGfs
-    await wo.delAllGfs()
-        .then(function(msg) {
-            console.log('delAllGfs then', msg)
-        })
-        .catch(function(msg) {
-            console.log('delAllGfs catch', msg)
-        })
-
-    //insertGfs
-    let gi = await wo.insertGfs(u8a)
-    console.log('insertGfs', gi)
-
-    //selectGfs
-    let gs = await wo.selectGfs(gi.id)
-    console.log('selectGfs', gs)
-    console.log('gs[0]', gs[0], gs[0] === 0)
-    console.log('gs[1]', gs[1], gs[1] === 0)
-    console.log('gs[2]', gs[2], gs[2] === 0)
-    console.log('gs[3]', gs[3], gs[3] === 24)
-    console.log('gs[4]', gs[4], gs[4] === 102)
-    console.log('gs.length', gs.length, gs.length === 47381362)
-    fs.writeFileSync(fn_out, gs)
-
-    //delGfs
-    let gd = await wo.delGfs(gi.id)
-    console.log('delGfs', gd)
-
-}
-test()
-// u8a Uint8Array(47381362) [
-//     0,   0,   0,  24, 102, 116, 121, 112, 109, 112, 52,  50,
-//     0,   0,   0,   0, 105, 115, 111, 109, 109, 112, 52,  50,
-//     0,   2,  14,  73, 109, 111, 111, 118,   0,   0,  0, 108,
-//   109, 118, 104, 100,   0,   0,   0,   0, 214,  15, 24, 167,
-//   214,  15,  24, 167,   0,   1,  95, 144,   1, 106, 95,  88,
-//     0,   1,   0,   0,   1,   0,   0,   0,   0,   0,  0,   0,
-//     0,   0,   0,   0,   0,   1,   0,   0,   0,   0,  0,   0,
-//     0,   0,   0,   0,   0,   0,   0,   0,   0,   1,  0,   0,
-//     0,   0,   0,   0,
-//   ... 47381262 more items
-// ]
-// change delAllGfs
-// delAllGfs then { n: 0, ok: 1 }
-// change insertGfs
-// insertGfs { n: 1, ok: 1, id: {random id} }
-// selectGfs Uint8Array(47381362) [
-//     0,   0,   0,  24, 102, 116, 121, 112, 109, 112, 52,  50,
-//     0,   0,   0,   0, 105, 115, 111, 109, 109, 112, 52,  50,
-//     0,   2,  14,  73, 109, 111, 111, 118,   0,   0,  0, 108,
-//   109, 118, 104, 100,   0,   0,   0,   0, 214,  15, 24, 167,
-//   214,  15,  24, 167,   0,   1,  95, 144,   1, 106, 95,  88,
-//     0,   1,   0,   0,   1,   0,   0,   0,   0,   0,  0,   0,
-//     0,   0,   0,   0,   0,   1,   0,   0,   0,   0,  0,   0,
-//     0,   0,   0,   0,   0,   0,   0,   0,   0,   1,  0,   0,
-//     0,   0,   0,   0,
-//   ... 47381262 more items
-// ]
-// change delGfs
-// delGfs { n: 1, nDeleted: 1, ok: 1 }
-
-//node g-gfs.mjs
+import WOrm from './src/WOrmMongodb.mjs'
+//import WOrm from './dist/w-orm-mongodb.umd.js'
+
+
+//GridFS函數之參數與回傳形狀比照一般操作:
+//數據物件為{ id, u8a }, insertGfs收物件或陣列, delGfs收物件或陣列並回傳等長陣列
+let opt = {
+    url: 'mongodb://username:password@127.0.0.1:27017',
+    db: 'worm',
+    cl: 'usersGfs',
+}
+
+//genU8a, 產生內容可複現之測試數據
+function genU8a(n) {
+    let u8a = new Uint8Array(n)
+    for (let i = 0; i < n; i++) {
+        u8a[i] = i % 256
+    }
+    return u8a
+}
+
+async function test() {
+
+    //wo
+    let wo = WOrm(opt)
+
+    //on
+    wo.on('change', function(mode, data, res) {
+        console.log('change', mode)
+    })
+
+    //u8a, 亦可為瀏覽器或nodejs取得之任何Uint8Array
+    let u8a = genU8a(1000)
+
+    //delAllGfs
+    await wo.delAllGfs()
+        .then(function(msg) {
+            console.log('delAllGfs then', msg)
+        })
+        .catch(function(msg) {
+            console.log('delAllGfs catch', msg)
+        })
+
+    //insertGfs
+    let gi = await wo.insertGfs({ id: 'id-file', u8a })
+    console.log('insertGfs', gi)
+
+    //insertGfs, 已存在id者跳過且不覆寫
+    let gr = await wo.insertGfs({ id: 'id-file', u8a: genU8a(50) })
+    console.log('insertGfs existed id', gr)
+
+    //selectByPkGfs
+    let gs = await wo.selectByPkGfs('id-file')
+    console.log('selectByPkGfs id', gs.id)
+    console.log('selectByPkGfs u8a.length', gs.u8a.length)
+    console.log('selectByPkGfs u8a[0..3]', gs.u8a[0], gs.u8a[1], gs.u8a[2], gs.u8a[3])
+
+    //selectByPkGfs by id not existed
+    let gn = await wo.selectByPkGfs('id-not-existed')
+    console.log('selectByPkGfs by id not existed', gn)
+
+    //insertGfs, 一次插入多筆
+    let gm = await wo.insertGfs([
+        { id: 'id-a', u8a: genU8a(10) },
+        { id: 'id-b', u8a: genU8a(20) },
+    ])
+    console.log('insertGfs multi', gm)
+
+    //delGfs
+    let gd = await wo.delGfs({ id: 'id-file' })
+    console.log('delGfs', gd)
+
+    //delGfs by id not existed
+    let gdn = await wo.delGfs({ id: 'id-not-existed' })
+    console.log('delGfs by id not existed', gdn)
+
+    //delAllGfs
+    let gda = await wo.delAllGfs()
+    console.log('delAllGfs', gda)
+
+}
+test()
+// change delAllGfs
+// delAllGfs then { n: 0, nDeleted: 0, ok: 1 }
+// change insertGfs
+// insertGfs { n: 1, nInserted: 1, ok: 1 }
+// change insertGfs
+// insertGfs existed id { n: 1, nInserted: 0, ok: 1 }
+// selectByPkGfs id id-file
+// selectByPkGfs u8a.length 1000
+// selectByPkGfs u8a[0..3] 0 1 2 3
+// selectByPkGfs by id not existed null
+// change insertGfs
+// insertGfs multi { n: 2, nInserted: 2, ok: 1 }
+// change delGfs
+// delGfs [ { n: 1, nDeleted: 1, ok: 1 } ]
+// change delGfs
+// delGfs by id not existed [ { n: 0, nDeleted: 0, ok: 1 } ]
+// change delAllGfs
+// delAllGfs { n: 2, nDeleted: 2, ok: 1 }
+
+//node g-gfs.mjs

package/g-unique.mjs

@@ -0,0 +1,66 @@
+import WOrm from './src/WOrmMongodb.mjs'
+//import WOrm from './dist/w-orm-mongodb.umd.js'
+
+
+//本套件會於id欄位建立唯一索引,
+//令insert與save之[檢查id]與[寫入]由MongoDB於單一操作內原子完成,
+//故併發時同一id僅會有一筆數據, 且不須開啟transaction
+//註: 若既有資料表內已存在重複id, 建立索引會失敗, 須先自行清除重複數據
+let opt = {
+    url: 'mongodb://username:password@127.0.0.1:27017',
+    db: 'worm',
+    cl: 'usersUnique',
+}
+
+
+async function test() {
+
+    //wo
+    let wo = WOrm(opt)
+
+    //delAll
+    await wo.delAll()
+
+    //insert, 同批含重複id時僅首筆成功
+    let ri = await wo.insert([
+        { id: 'id-dup', name: 'dup-1' },
+        { id: 'id-dup', name: 'dup-2' },
+        { id: 'id-uniq', name: 'uniq' },
+    ])
+    console.log('insert with duplicated id', ri)
+    console.log('selectByPk(id-dup)', await wo.selectByPk('id-dup'))
+
+    //insert, 對已存在id再插入則跳過而不覆寫
+    let re = await wo.insert({ id: 'id-dup', name: 'dup-3' })
+    console.log('insert existed id', re)
+    console.log('selectByPk(id-dup)', await wo.selectByPk('id-dup'))
+
+    //insert, 併發對同一id插入10次, nInserted總和為1
+    let rc = await Promise.all(Array.from({ length: 10 }, (v, k) => {
+        return wo.insert({ id: 'id-race', k })
+    }))
+    console.log('sum of nInserted by 10 concurrent insert', rc.reduce((sum, v) => sum + v.nInserted, 0))
+    console.log('records of id-race', (await wo.select({ id: 'id-race' })).length)
+
+    //save, 併發對同一全新id儲存不同欄位, 僅一次為插入, 各欄位皆保留
+    let rs = await Promise.all(Array.from({ length: 5 }, (v, k) => {
+        return wo.save({ id: 'id-new', [`f${k}`]: k })
+    }))
+    console.log('count of nInserted===1 by 5 concurrent save', rs.filter((v) => v[0].nInserted === 1).length)
+    console.log('records of id-new', (await wo.select({ id: 'id-new' })).length)
+    console.log('selectByPk(id-new)', await wo.selectByPk('id-new'))
+
+}
+test()
+// insert with duplicated id { n: 3, nInserted: 2, ok: 1 }
+// selectByPk(id-dup) { id: 'id-dup', name: 'dup-1' }
+// insert existed id { n: 1, nInserted: 0, ok: 1 }
+// selectByPk(id-dup) { id: 'id-dup', name: 'dup-1' }
+// sum of nInserted by 10 concurrent insert 1
+// records of id-race 1
+// count of nInserted===1 by 5 concurrent save 1
+// records of id-new 1
+// selectByPk(id-new) { id: 'id-new', f0: 0, f1: 1, f2: 2, f4: 4, f3: 3 }
+// 註: 併發儲存之各欄位皆會保留, 惟欄位順序取決於各次儲存之完成順序, 故每次執行不盡相同
+
+//node g-unique.mjs

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "w-orm-mongodb",
-  "version": "1.1.37",
+  "version": "1.1.39",
   "main": "dist/w-orm-mongodb.umd.js",
   "dependencies": {
-    "mongodb": "^6.16.0",
-    "saslprep": "^1.0.3",
+    "mongodb": "^7.5.0",
     "wsemi": "^1.8.70"
   },
   "devDependencies": {

package/script.txt

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