w-orm-reladb 1.0.47 → 1.0.49

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -29,7 +29,7 @@
29
29
  <nav >
30
30
 
31
31
 
32
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WOrmReladb.html">WOrmReladb</a><ul class='methods'><li data-type='method'><a href="WOrmReladb.html#.closeSequelize">closeSequelize</a></li><li data-type='method'><a href="WOrmReladb.html#.createStorage">createStorage</a></li><li data-type='method'><a href="WOrmReladb.html#.del">del</a></li><li data-type='method'><a href="WOrmReladb.html#.delAll">delAll</a></li><li data-type='method'><a href="WOrmReladb.html#.genModelsByDB">genModelsByDB</a></li><li data-type='method'><a href="WOrmReladb.html#.genModelsByTabs">genModelsByTabs</a></li><li data-type='method'><a href="WOrmReladb.html#.genTransaction">genTransaction</a></li><li data-type='method'><a href="WOrmReladb.html#.initSequelize">initSequelize</a></li><li data-type='method'><a href="WOrmReladb.html#.insert">insert</a></li><li data-type='method'><a href="WOrmReladb.html#.save">save</a></li><li data-type='method'><a href="WOrmReladb.html#.select">select</a></li></ul></li></ul>
32
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="WOrmReladb.html">WOrmReladb</a><ul class='methods'><li data-type='method'><a href="WOrmReladb.html#.closeSequelize">closeSequelize</a></li><li data-type='method'><a href="WOrmReladb.html#.createStorage">createStorage</a></li><li data-type='method'><a href="WOrmReladb.html#.del">del</a></li><li data-type='method'><a href="WOrmReladb.html#.delAll">delAll</a></li><li data-type='method'><a href="WOrmReladb.html#.genModelsByDB">genModelsByDB</a></li><li data-type='method'><a href="WOrmReladb.html#.genModelsByTabs">genModelsByTabs</a></li><li data-type='method'><a href="WOrmReladb.html#.genTransaction">genTransaction</a></li><li data-type='method'><a href="WOrmReladb.html#.initSequelize">initSequelize</a></li><li data-type='method'><a href="WOrmReladb.html#.insert">insert</a></li><li data-type='method'><a href="WOrmReladb.html#.insertBulk">insertBulk</a></li><li data-type='method'><a href="WOrmReladb.html#.save">save</a></li><li data-type='method'><a href="WOrmReladb.html#.select">select</a></li><li data-type='method'><a href="WOrmReladb.html#.selectByPk">selectByPk</a></li></ul></li></ul>
33
33
 
34
34
  </nav>
35
35
 
@@ -46,7 +46,6 @@
46
46
  <section>
47
47
  <article>
48
48
  <pre class="prettyprint source linenums"><code>import path from 'path'
49
- import events from 'events'
50
49
  import Sequelize from 'sequelize'
51
50
  import cloneDeep from 'lodash-es/cloneDeep.js'
52
51
  import get from 'lodash-es/get.js'
@@ -54,13 +53,19 @@ import map from 'lodash-es/map.js'
54
53
  import each from 'lodash-es/each.js'
55
54
  import size from 'lodash-es/size.js'
56
55
  import split from 'lodash-es/split.js'
56
+ import keys from 'lodash-es/keys.js'
57
+ import pick from 'lodash-es/pick.js'
58
+ import omit from 'lodash-es/omit.js'
59
+ import isEqual from 'lodash-es/isEqual.js'
60
+ import evem from 'wsemi/src/evem.mjs'
57
61
  import genPm from 'wsemi/src/genPm.mjs'
58
- import genID from 'wsemi/src/genID.mjs'
62
+ import genIDSeq from 'wsemi/src/genIDSeq.mjs'
59
63
  import isarr from 'wsemi/src/isarr.mjs'
60
64
  import isearr from 'wsemi/src/isearr.mjs'
61
65
  import isobj from 'wsemi/src/isobj.mjs'
62
66
  import iseobj from 'wsemi/src/iseobj.mjs'
63
67
  import isbol from 'wsemi/src/isbol.mjs'
68
+ import isnum from 'wsemi/src/isnum.mjs'
64
69
  import isestr from 'wsemi/src/isestr.mjs'
65
70
  import arrHas from 'wsemi/src/arrHas.mjs'
66
71
  import pmSeries from 'wsemi/src/pmSeries.mjs'
@@ -91,7 +96,7 @@ let pmq = pmQueue(1)
91
96
  * @param {String} [opt.modelType='js'] 輸入資料表設定檔類型字串,可有'js'、'json',預設'js'
92
97
  * @param {Boolean} [opt.logging=false] 輸入是否輸出實際執行的sql指令布林值,預設false
93
98
  * @param {String} [opt.pk='id'] 輸入數據主鍵字串,預設'id'
94
- * @param {Boolean} [opt.autoGenPK=true] 輸入若數據pk(id)欄位沒給時則自動給予隨機uuid,型別為布林值,預設true
99
+ * @param {Boolean} [opt.autoGenPk=true] 輸入若數據pk(id)欄位沒給時則自動給予隨機uuid,型別為布林值,預設true
95
100
  * @param {Boolean} [opt.useStable=true] 輸入是否使用穩定模式,使用佇列管理同時只能進行一種操作故會犧牲效能,sqlite需開啟穩定模式才不會有非預期錯誤,型別為布林值,預設true
96
101
  * @returns {Object} 回傳操作資料庫物件,各事件功能詳見說明
97
102
  */
@@ -121,8 +126,8 @@ function WOrmReladb(opt = {}) {
121
126
  if (!isestr(opt.pk)) {
122
127
  opt.pk = 'id'
123
128
  }
124
- if (!isbol(opt.autoGenPK)) {
125
- opt.autoGenPK = true
129
+ if (!isbol(opt.autoGenPk)) {
130
+ opt.autoGenPk = true
126
131
  }
127
132
  if (!isbol(opt.useStable)) {
128
133
  opt.useStable = true
@@ -140,8 +145,18 @@ function WOrmReladb(opt = {}) {
140
145
  let Op = Sequelize.Op
141
146
 
142
147
 
143
- //ee
144
- let ee = new events.EventEmitter()
148
+ //ee, 採wsemi之evem(即eventemitter3), 其於'error'無監聽者時僅回傳false而不拋出,
149
+ //故本套件之操作行為不因呼叫端有無註冊監聽而改變; Node內建之EventEmitter具該拋出語義, 不可用
150
+ let ee = evem()
151
+
152
+
153
+ //opt.url解析失敗一律拋出, 因其屬呼叫端未履行契約, 且解析失敗後各函數皆無從運作,
154
+ //建構為同步而無從以Promise.reject回報, 拋出即為reject之同步對應;
155
+ //若僅console.log而回傳未綁定各函數之ee, 錯誤不經任何管道抵達呼叫端, 呼叫端僅得到
156
+ //[w.select is not a function]之無關訊息, 與本規格[錯誤不得靜默]之通則相違
157
+ let throwUrlErr = (msg) => {
158
+ throw new Error(`${msg}, opt.url[${opt.url}]`)
159
+ }
145
160
 
146
161
 
147
162
  //dialect
@@ -149,12 +164,10 @@ function WOrmReladb(opt = {}) {
149
164
  ss = split(opt.url, '://')
150
165
  dialect = get(ss, 0, null)
151
166
  if (!dialect) {
152
- console.log('no dialect in opt.url')
153
- return ee
167
+ throwUrlErr('no dialect in opt.url')
154
168
  }
155
169
  if (!arrHas(dialect, ['mssql', 'sqlite', 'mysql', 'mariadb', 'postgres'])) {
156
- console.log('invalid dialect in opt.url')
157
- return ee
170
+ throwUrlErr('invalid dialect in opt.url')
158
171
  }
159
172
  u = get(ss, 1, '') //另存給後面使用
160
173
 
@@ -167,19 +180,16 @@ function WOrmReladb(opt = {}) {
167
180
  ss = get(ss, 0, '')
168
181
  ss = split(ss, ':')
169
182
  if (size(ss) !== 2) {
170
- console.log('invalid username or password in opt.url')
171
- return ee
183
+ throwUrlErr('invalid username or password in opt.url')
172
184
  }
173
185
  username = get(ss, 0, '')
174
186
  password = get(ss, 1, '')
175
187
  if (dialect !== 'sqlite' || (dialect === 'sqlite' &amp;&amp; opt.useEncryption)) {
176
188
  if (username === '') {
177
- console.log('invalid username in opt.url')
178
- return ee
189
+ throwUrlErr('invalid username in opt.url')
179
190
  }
180
191
  if (password === '') {
181
- console.log('invalid password in opt.url')
182
- return ee
192
+ throwUrlErr('invalid password in opt.url')
183
193
  }
184
194
  }
185
195
 
@@ -188,21 +198,218 @@ function WOrmReladb(opt = {}) {
188
198
  let host
189
199
  let port
190
200
  ss = split(u, ':')
191
- // if (size(ss) !== 2) {
192
- // console.log('invalid host or port in opt.url')
193
- // return ee
194
- // }
195
201
  host = get(ss, 0, null)
196
202
  port = get(ss, 1, null)
197
203
  if (dialect !== 'sqlite') {
198
204
  if (!host) {
199
- console.log('invalid host in opt.url')
200
- return ee
205
+ throwUrlErr('invalid host in opt.url')
201
206
  }
202
207
  if (!port) {
203
- console.log('invalid port in opt.url')
204
- return ee
208
+ throwUrlErr('invalid port in opt.url')
209
+ }
210
+ }
211
+
212
+
213
+ /**
214
+ * 取錯誤訊息字串,供逐筆結果之err欄位與error事件使用
215
+ *
216
+ * @ignore
217
+ * @param {Error|String} err 輸入錯誤物件或字串
218
+ * @returns {String} 回傳錯誤訊息字串
219
+ */
220
+ function getErrMsg(err) {
221
+
222
+ //message
223
+ let message = get(err, 'message')
224
+ if (isestr(message)) {
225
+ return message
226
+ }
227
+
228
+ return String(err)
229
+ }
230
+
231
+
232
+ /**
233
+ * 發出change事件,訂閱函數拋錯不得影響本次操作之結果,故另包try並自行吞掉
234
+ *
235
+ * @ignore
236
+ * @param {String} mode 輸入操作別字串
237
+ * @param {Object|Array|null} data 輸入本次操作之數據
238
+ * @param {Object|Array} res 輸入本次操作之結果
239
+ * @returns {undefined} 無回傳值
240
+ */
241
+ function emitChange(mode, data, res) {
242
+ try {
243
+ ee.emit('change', mode, data, res)
244
+ }
245
+ catch (err) {
246
+ console.log(err)
247
+ }
248
+ }
249
+
250
+
251
+ /**
252
+ * 發出error事件,操作發生錯誤時發出,錯誤訊息一律轉為字串
253
+ * 註: 事件僅為附加通知,所送出之資訊必另有正規管道——整批性錯誤經Promise.reject,逐筆失敗經該筆之err欄位
254
+ * 註: 訂閱函數拋錯不得影響本次操作之結果,故另包try並自行吞掉
255
+ * 註: 正常結果不得發出本事件,如insert全數已存在、save合併後內容相同、del主鍵未命中、selectByPk查無數據
256
+ *
257
+ * @ignore
258
+ * @param {String} mode 輸入操作別字串
259
+ * @param {Object|Array|null} data 輸入本次操作之數據
260
+ * @param {Error|String} err 輸入錯誤物件或字串
261
+ * @returns {undefined} 無回傳值
262
+ */
263
+ function emitError(mode, data, err) {
264
+ try {
265
+ ee.emit('error', mode, data, getErrMsg(err))
205
266
  }
267
+ catch (errEmit) {
268
+ console.log(errEmit)
269
+ }
270
+ }
271
+
272
+
273
+ /**
274
+ * 判定主鍵值是否有效
275
+ * 註: select以外之五函數對主鍵之認定一律以本函數為準,令selectByPk之[命中]與insert、save、del內對既有數據之認定一致
276
+ *
277
+ * @ignore
278
+ * @param {*} v 輸入主鍵值
279
+ * @returns {Boolean} 回傳主鍵值是否有效布林值
280
+ */
281
+ function isEffPk(v) {
282
+
283
+ //非空字串
284
+ if (isestr(v)) {
285
+ return true
286
+ }
287
+
288
+ //數值, 含0, 供整數型主鍵使用
289
+ if (isnum(v)) {
290
+ return true
291
+ }
292
+
293
+ return false
294
+ }
295
+
296
+
297
+ /**
298
+ * 判定是否為主鍵重複之錯誤
299
+ * 註: sequelize於mssql、sqlite、mysql、mariadb、postgres皆將唯一鍵衝突轉為UniqueConstraintError,故此判定與dialect無關
300
+ *
301
+ * @ignore
302
+ * @param {Error} err 輸入錯誤物件
303
+ * @returns {Boolean} 回傳是否為主鍵重複錯誤布林值
304
+ */
305
+ function isDupPkError(err) {
306
+ return err instanceof Sequelize.UniqueConstraintError
307
+ }
308
+
309
+
310
+ /**
311
+ * 檢查呼叫端所給之實例是否已關閉,已關閉者拋出令各函數於入口快速失敗
312
+ * 註: 實例已關閉為終態,後續操作必然失敗,屬影響全部數據之整批性錯誤,
313
+ * 故不得降為逐筆ok為0而整批resolve,亦不得以正常空結果(null、未命中、空陣列)回應——
314
+ * 後者使[已關閉]與[查無資料]同形,去重類呼叫端將把每筆判為未存在而靜默fail-open
315
+ * 註: closeSequelize於關閉後將sequelize設為null,故據此判定即為精確訊號,
316
+ * 不須倚賴驅動層之錯誤訊息比對(連線管理器關閉後所拋者為原生Error而非sequelize之錯誤類別)
317
+ * 註: 內部自行初始化者(instance為null)每次呼叫各自開關連線,不受本檢查影響
318
+ *
319
+ * @ignore
320
+ * @param {Object|null} instance 輸入呼叫端所給之實例物件
321
+ * @returns {undefined} 無回傳值
322
+ */
323
+ function procClosed(instance) {
324
+
325
+ //check
326
+ if (instance === null) {
327
+ return
328
+ }
329
+
330
+ //check
331
+ if (sequelize === null) {
332
+ throw new Error(`instance is closed, need to use init() to get a new instance`)
333
+ }
334
+
335
+ }
336
+
337
+
338
+ /**
339
+ * 判定錯誤是否影響後續所有筆數而應視為整批性錯誤
340
+ * 註: 依T4之判別原則,錯誤只影響該筆資料者為逐筆失敗,影響後續所有筆數者為整批性錯誤;
341
+ * 連線層錯誤屬後者,故於逐筆函數內攔得時須往外拋而不得降為該筆ok為0
342
+ * 註: 連線管理器關閉後所拋者為原生Error而非sequelize之ConnectionError,故另以訊息辨識
343
+ *
344
+ * @ignore
345
+ * @param {Error} err 輸入錯誤物件
346
+ * @returns {Boolean} 回傳是否為整批性錯誤布林值
347
+ */
348
+ function isBatchLevelError(err) {
349
+
350
+ //check, sequelize之連線層錯誤家族
351
+ if (err instanceof Sequelize.ConnectionError) {
352
+ return true
353
+ }
354
+
355
+ //msg
356
+ let msg = getErrMsg(err)
357
+
358
+ //check
359
+ if (msg.indexOf('connection manager was closed') >= 0) {
360
+ return true
361
+ }
362
+ if (msg.indexOf('SQLITE_MISUSE') >= 0) {
363
+ return true
364
+ }
365
+
366
+ return false
367
+ }
368
+
369
+
370
+ /**
371
+ * 檢查並補齊單筆數據之主鍵
372
+ * autoGenPk為true時未帶有效主鍵者自動產生,為false時往外拋
373
+ * 註: 未帶有效主鍵屬呼叫端未履行契約而非某一筆資料本身之問題,故為整批性錯誤而不降級為該筆ok為0,
374
+ * 若降級為逐筆結果,呼叫端易於整批resolve之下漏看,使[忘了給主鍵]靜默變成[少寫了幾筆]
375
+ * 註: 本函數須於任何寫入之前一次對全部數據完成,令拋錯時同批之有效筆數亦不會被寫入
376
+ * 註: 自動產生之主鍵值為字串,故補值前檢查主鍵欄位確為字串類型,不符者以明確訊息拋出,
377
+ * 而非任由資料庫回報型別錯誤; 本套件之model定義於手上得知主鍵型別,故不適用T6之[套件無從得知主鍵型別]例外
378
+ *
379
+ * @ignore
380
+ * @param {Object} md 輸入資料表model物件
381
+ * @param {Object} v 輸入數據物件
382
+ * @param {Number} k 輸入數據於陣列內之索引
383
+ * @returns {Object} 回傳補齊主鍵之數據物件
384
+ */
385
+ function procPk(md, v, k) {
386
+
387
+ //check
388
+ if (isEffPk(get(v, opt.pk))) {
389
+ return v
390
+ }
391
+
392
+ //check, autoGenPk為false時主鍵須由呼叫端自備
393
+ if (!opt.autoGenPk) {
394
+ throw new Error(`invalid data[${k}].${opt.pk}, autoGenPk is false`)
395
+ }
396
+
397
+ //at
398
+ let at = get(md, `rawAttributes.${opt.pk}`)
399
+ if (!iseobj(at)) {
400
+ throw new Error(`can not find pk column [${opt.pk}] in model [${opt.cl}]`)
401
+ }
402
+
403
+ //check, 自動產生之主鍵值為字串, 主鍵欄位須為字串類型方能容納
404
+ let tp = get(at, 'type.key', '')
405
+ if (!arrHas(tp, ['STRING', 'TEXT', 'CHAR', 'UUID', 'CITEXT'])) {
406
+ throw new Error(`autoGenPk is true but pk column [${opt.pk}] in model [${opt.cl}] is [${tp}], auto generated pk is a string, need to set autoGenPk to false and supply pk by caller`)
407
+ }
408
+
409
+ //genIDSeq, 為UUIDv7格式而具單調遞增性, 主鍵接近順序遞增可減少索引頁面分裂
410
+ v[opt.pk] = genIDSeq()
411
+
412
+ return v
206
413
  }
207
414
 
208
415
 
@@ -398,23 +605,27 @@ function WOrmReladb(opt = {}) {
398
605
  }
399
606
  }
400
607
 
608
+ //isErr, res
609
+ let isErr = false
610
+ let res = null
611
+
401
612
  //si
402
613
  let si = instance
403
614
  if (instance === null) {
404
615
  si = await initSequelize()
405
616
  }
406
- // else {
407
- // console.log('select use instance', instance)
408
- // }
409
617
 
410
- //rs
411
- let rs = null
412
- if (!si.err) {
618
+ try {
619
+
620
+ //check, 連線或匯入models失敗影響本次操作之全部數據, 屬整批性錯誤
621
+ if (si.err) {
622
+ throw si.err
623
+ }
413
624
 
414
625
  //md
415
626
  let md = si.mds[opt.cl]
416
627
 
417
- //setting
628
+ //setting, raw令回傳純數據物件而不含資料庫內部欄位
418
629
  let setting = {
419
630
  where: useFind,
420
631
  raw: true,
@@ -423,37 +634,178 @@ function WOrmReladb(opt = {}) {
423
634
  setting.transaction = transaction
424
635
  }
425
636
 
426
- //findAll
427
- rs = await md.findAll(setting)
637
+ //findAll, 恆回傳陣列, 無符合數據為空陣列
638
+ res = await md.findAll(setting)
639
+ if (!isarr(res)) {
640
+ res = []
641
+ }
428
642
 
429
643
  }
430
- else {
431
- ee.emit('error', si.err)
644
+ catch (err) {
645
+ isErr = true
646
+ res = err
432
647
  }
648
+ finally {
649
+
650
+ //closeSequelize
651
+ if (instance === null) { //內部自動初始化得close
652
+ await closeSequelize('select')
653
+ }
433
654
 
434
- //closeSequelize
435
- if (instance === null) { //內部自動初始化得close
436
- await closeSequelize('select')
437
655
  }
438
656
 
439
- return rs
657
+ //check
658
+ if (isErr) {
659
+ emitError('select', null, res)
660
+ return Promise.reject(res)
661
+ }
662
+
663
+ return res
440
664
  }
441
665
 
442
666
 
443
667
  /**
444
- * 插入數據,插入同樣數據會自動產生不同_id,故insert前需自行判斷有無重複
668
+ * 由主鍵查詢單筆數據,因由資料庫依主鍵索引取值且僅回傳單筆,不需如select提取全部符合數據再處理,故數據量大時效能較佳
669
+ *
670
+ * 註: 主鍵欄位取自opt.pk,預設為id,支援由呼叫端指定
671
+ * 註: 主鍵未命中或主鍵值無效皆回傳null而不reject,[命中]之判定基準與insert、save、del內對既有數據之認定一致
672
+ * 註: 本函數不得有副作用,故不創建資料表
673
+ *
674
+ * @memberOf WOrmReladb
675
+ * @param {String|Number} pk 輸入主鍵值,即數據內opt.pk欄位之值
676
+ * @param {Object} [option={}] 輸入設定物件,預設為{}
677
+ * @param {Object} [option.instance=null] 輸入實例instance物件,預設為null
678
+ * @param {Object} [option.transaction=null] 輸入交易(transaction)物件,預設為null
679
+ * @returns {Promise} 回傳Promise,resolve回傳數據物件,若無此主鍵或主鍵值無效則回傳null,reject回傳錯誤訊息
680
+ */
681
+ async function selectByPk(pk, option = {}) {
682
+
683
+ //instance
684
+ let instance = get(option, 'instance', null)
685
+
686
+ //transaction
687
+ let transaction = get(option, 'transaction', null)
688
+
689
+ //check, 實例已關閉之判定須先於[主鍵值無效回null], 否則兩者同形而使[已關閉]被誤讀為[查無資料]
690
+ try {
691
+ procClosed(instance)
692
+ }
693
+ catch (err) {
694
+ emitError('selectByPk', null, err)
695
+ return Promise.reject(err)
696
+ }
697
+
698
+ //check, 未給有效主鍵值視為查無數據, 不送查詢以免無效值被轉為null而誤中其他數據
699
+ if (!isEffPk(pk)) {
700
+ return null
701
+ }
702
+
703
+ //check
704
+ if (opt.useEncryption &amp;&amp; dialect === 'sqlite') {
705
+ if (transaction !== null) {
706
+ console.log('@journeyapps/sqlcipher can not support transaction.')
707
+ }
708
+ }
709
+
710
+ //isErr, res
711
+ let isErr = false
712
+ let res = null
713
+
714
+ //si
715
+ let si = instance
716
+ if (instance === null) {
717
+ si = await initSequelize()
718
+ }
719
+
720
+ try {
721
+
722
+ //check, 實例已關閉屬整批性錯誤, 於入口快速失敗
723
+ procClosed(instance)
724
+
725
+ //check
726
+ if (si.err) {
727
+ throw si.err
728
+ }
729
+
730
+ //md
731
+ let md = si.mds[opt.cl]
732
+
733
+ //setting
734
+ let setting = {
735
+ where: { [opt.pk]: pk },
736
+ raw: true,
737
+ }
738
+ if (transaction !== null) {
739
+ setting.transaction = transaction
740
+ }
741
+
742
+ //findOne
743
+ let v = await md.findOne(setting)
744
+
745
+ //check, 判定基準與insert、save、del內對既有數據之認定一致
746
+ if (iseobj(v)) {
747
+ res = v
748
+ }
749
+ else {
750
+ //不存在主鍵, 回傳null
751
+ res = null
752
+ }
753
+
754
+ }
755
+ catch (err) {
756
+ isErr = true
757
+ res = err
758
+ }
759
+ finally {
760
+
761
+ //closeSequelize
762
+ if (instance === null) { //內部自動初始化得close
763
+ await closeSequelize('selectByPk')
764
+ }
765
+
766
+ }
767
+
768
+ //check
769
+ if (isErr) {
770
+ emitError('selectByPk', null, res)
771
+ return Promise.reject(res)
772
+ }
773
+
774
+ return res
775
+ }
776
+
777
+
778
+ /**
779
+ * 插入數據,僅於主鍵不存在時寫入,已存在者跳過且不覆寫
780
+ *
781
+ * 由資料庫於主鍵之唯一約束上原子完成[檢查主鍵不存在]與[寫入],併發時同一主鍵僅有一次成功
782
+ *
783
+ * 註: n為輸入筆數即本次嘗試插入之基準,nInserted為實際插入筆數,全數已存在而nInserted為0屬正常結果
784
+ * 註: 同批含重複主鍵時僅首筆計入nInserted,其餘視為已存在
785
+ * 註: opt.autoGenPk為true(預設)時未帶有效主鍵者自動產生,為false時未帶有效主鍵即reject且同批皆不寫入
786
+ * 註: option.returnList開啟時改回與輸入等長且保序之逐筆結果陣列[{n,nInserted,ok}],
787
+ * 聚合計數只答得出[有幾筆是新的]而答不出[是哪幾筆],而後者正是去重之產出物;
788
+ * 逐筆元素之n與ok恆為1,資訊由nInserted承載,不變式為
789
+ * 陣列長度等於輸入筆數且filter(v => v.nInserted === 1).length等於聚合模式之nInserted
445
790
  *
446
791
  * @memberOf WOrmReladb
447
792
  * @param {Object|Array} data 輸入數據物件或陣列
448
793
  * @param {Object} [option={}] 輸入設定物件,預設為{}
449
794
  * @param {Object} [option.instance=null] 輸入實例instance物件,預設為null
450
795
  * @param {Object} [option.transaction=null] 輸入交易(transaction)物件,預設為null
451
- * @returns {Promise} 回傳Promise,resolve回傳插入結果,reject回傳錯誤訊息
796
+ * @param {Boolean} [option.returnList=false] 輸入是否改回逐筆結果陣列布林值,預設false
797
+ * @returns {Promise} 回傳Promise,resolve回傳插入結果{n,nInserted,ok},或於returnList開啟時回傳[{n,nInserted,ok}],reject回傳錯誤訊息
452
798
  */
453
799
  async function insert(data, option = {}) {
454
800
 
801
+ //returnList, 回傳形式之切換為靜態, 僅由本選項之取值決定, 不因數據內容或執行結果而變
802
+ let returnList = get(option, 'returnList', false) === true
803
+
455
804
  //check
456
805
  if (!iseobj(data) &amp;&amp; !isearr(data)) {
806
+ if (returnList) {
807
+ return []
808
+ }
457
809
  return {
458
810
  n: 0,
459
811
  nInserted: 0,
@@ -477,19 +829,25 @@ function WOrmReladb(opt = {}) {
477
829
  //cloneDeep
478
830
  data = cloneDeep(data)
479
831
 
480
- //pm
481
- let pm = genPm()
832
+ //isErr, res
833
+ let isErr = false
834
+ let res = null
482
835
 
483
836
  //si
484
837
  let si = instance
485
838
  if (instance === null) {
486
839
  si = await initSequelize()
487
840
  }
488
- // else {
489
- // console.log('insert use instance', instance)
490
- // }
491
841
 
492
- if (!si.err) {
842
+ try {
843
+
844
+ //check, 實例已關閉屬整批性錯誤, 於入口快速失敗
845
+ procClosed(instance)
846
+
847
+ //check
848
+ if (si.err) {
849
+ throw si.err
850
+ }
493
851
 
494
852
  //md
495
853
  let md = si.mds[opt.cl]
@@ -499,18 +857,13 @@ function WOrmReladb(opt = {}) {
499
857
  data = [data]
500
858
  }
501
859
 
502
- //n
503
- let n = size(data)
860
+ //procPk, 須於任何寫入之前一次完成, 令autoGenPk為false而拋錯時同批之有效筆數亦不會被寫入
861
+ data = map(data, (v, k) => {
862
+ return procPk(md, v, k)
863
+ })
504
864
 
505
- //check
506
- if (opt.autoGenPK) {
507
- data = map(data, function(v) {
508
- if (!v[opt.pk]) {
509
- v[opt.pk] = genID()
510
- }
511
- return v
512
- })
513
- }
865
+ //nAll, n之基準為輸入筆數
866
+ let nAll = size(data)
514
867
 
515
868
  //setting
516
869
  let setting = { }
@@ -518,53 +871,112 @@ function WOrmReladb(opt = {}) {
518
871
  setting.transaction = transaction
519
872
  }
520
873
 
521
- //bulkCreate
522
- await md.bulkCreate(data, setting)
523
- .then((res) => {
524
- res = { n, nInserted: n, ok: 1 }
525
- pm.resolve(res)
526
- ee.emit('change', 'insert', data, res)
527
- })
528
- .catch(({ original }) => {
529
- ee.emit('error', original)
530
- pm.reject({ n: 0, ok: 0 })
874
+ //create, 逐筆插入以取得精確之nInserted
875
+ //註: 不採bulkCreate配合ignoreDuplicates, 因mssql未宣告該能力而選項會被靜默忽略仍撞唯一約束,
876
+ //且bulkCreate無從回報實際插入筆數; 單筆INSERT本即由主鍵之唯一約束原子完成檢查與寫入
877
+ //註: bIns即逐筆判定, 與輸入等長且保序, 供returnList直接包裝而不須另行推導
878
+ let bInss = await pmSeries(data, async(v) => {
879
+
880
+ //bIns, 撞既有主鍵者視為已存在而跳過, 其餘錯誤影響全部數據須往外拋
881
+ let bIns = await md.create(v, setting)
882
+ .then(() => {
883
+ return true
884
+ })
885
+ .catch((err) => {
886
+ if (isDupPkError(err)) {
887
+ return false
888
+ }
889
+ throw err
890
+ })
891
+
892
+ return bIns
893
+ })
894
+
895
+ if (returnList) {
896
+
897
+ //res, 與輸入等長且保序之逐筆結果; 各筆之n恆為1(該筆主鍵或為命中既有或經插入而產生),
898
+ //ok恆為1(insert之任何錯誤皆屬整批性錯誤而reject), 資訊由nInserted承載
899
+ res = map(bInss, (bIns) => {
900
+ return {
901
+ n: 1,
902
+ nInserted: bIns ? 1 : 0,
903
+ ok: 1,
904
+ }
531
905
  })
532
906
 
907
+ }
908
+ else {
909
+
910
+ //res, 全數已存在而nInserted為0屬正常結果, 不視為錯誤
911
+ res = {
912
+ n: nAll,
913
+ nInserted: size(bInss.filter((v) => v === true)),
914
+ ok: 1,
915
+ }
916
+
917
+ }
918
+
533
919
  }
534
- else {
535
- pm.reject(si.err)
920
+ catch (err) {
921
+ isErr = true
922
+ res = err
536
923
  }
924
+ finally {
925
+
926
+ //closeSequelize
927
+ if (instance === null) { //內部自動初始化得close
928
+ await closeSequelize('insert')
929
+ }
537
930
 
538
- //closeSequelize
539
- if (instance === null) { //內部自動初始化得close
540
- await closeSequelize('insert')
541
931
  }
542
932
 
543
- return pm
933
+ //check
934
+ if (isErr) {
935
+ emitError('insert', data, res)
936
+ return Promise.reject(res)
937
+ }
938
+
939
+ //emit, 須於結果定案後發出
940
+ emitChange('insert', data, res)
941
+
942
+ return res
544
943
  }
545
944
 
546
945
 
547
946
  /**
548
- * 儲存數據
947
+ * 批次插入數據,全批視為一個單位:全部插入成功,或一筆都不寫入
948
+ *
949
+ * 本函數非insert之加速版,兩者衝突政策不同:insert於主鍵已存在時跳過該筆且整批ok為1,
950
+ * 本函數則整批reject且不寫入任何一筆,同批含重複主鍵者亦視為衝突。
951
+ * 確無衝突時兩者之可觀察結果完全相同,差異僅於有衝突時顯現。
952
+ *
953
+ * 註: n為輸入筆數即本次嘗試插入之基準;nInserted於成功時恆等於n,雖無額外資訊仍保留,
954
+ * 令呼叫端得與insert共用同一段結果處理程式碼
955
+ * 註: 不提供逐筆結果,故不出現ok為0與err;需要逐筆處置者改用insert
956
+ * 註: opt.autoGenPk為true(預設)時未帶有效主鍵者自動產生,為false時未帶有效主鍵即reject且同批皆不寫入
957
+ * 註: [全有全無]為獨立於T7之額外要求——T7僅保證每筆之[檢查主鍵不存在]與[寫入]為原子,不保證整批。
958
+ * mssql因綁定參數數量上限會由驅動層自動拆為多語句送出,實測1000筆之批次於末筆撞主鍵時已有946筆落盤,
959
+ * 故一律以交易包覆並於失敗時回滾;呼叫端已給transaction時改以巢狀交易(SAVEPOINT)包覆,
960
+ * 令回滾範圍限於本次呼叫而不影響呼叫端交易內先前之寫入
549
961
  *
550
962
  * @memberOf WOrmReladb
551
963
  * @param {Object|Array} data 輸入數據物件或陣列
552
964
  * @param {Object} [option={}] 輸入設定物件,預設為{}
553
965
  * @param {Object} [option.instance=null] 輸入實例instance物件,預設為null
554
966
  * @param {Object} [option.transaction=null] 輸入交易(transaction)物件,預設為null
555
- * @param {boolean} [option.autoInsert=true] 輸入是否於儲存時發現原本無數據,則自動改以插入處理,預設為true
556
- * @returns {Promise} 回傳Promise,resolve回傳儲存結果,reject回傳錯誤訊息
967
+ * @returns {Promise} 回傳Promise,resolve回傳插入結果{n,nInserted,ok},reject回傳錯誤訊息
557
968
  */
558
- async function save(data, option = {}) {
969
+ async function insertBulk(data, option = {}) {
559
970
 
560
971
  //check
561
972
  if (!iseobj(data) &amp;&amp; !isearr(data)) {
562
- return []
973
+ return {
974
+ n: 0,
975
+ nInserted: 0,
976
+ ok: 1,
977
+ }
563
978
  }
564
979
 
565
- //cloneDeep
566
- data = cloneDeep(data)
567
-
568
980
  //instance
569
981
  let instance = get(option, 'instance', null)
570
982
 
@@ -578,22 +990,28 @@ function WOrmReladb(opt = {}) {
578
990
  }
579
991
  }
580
992
 
581
- //autoInsert
582
- let autoInsert = get(option, 'autoInsert', true)
993
+ //cloneDeep
994
+ data = cloneDeep(data)
583
995
 
584
- //pm
585
- let pm = genPm()
996
+ //isErr, res
997
+ let isErr = false
998
+ let res = null
586
999
 
587
1000
  //si
588
1001
  let si = instance
589
1002
  if (instance === null) {
590
1003
  si = await initSequelize()
591
1004
  }
592
- // else {
593
- // console.log('save use instance', instance)
594
- // }
595
1005
 
596
- if (!si.err) {
1006
+ try {
1007
+
1008
+ //check, 實例已關閉屬整批性錯誤, 於入口快速失敗
1009
+ procClosed(instance)
1010
+
1011
+ //check
1012
+ if (si.err) {
1013
+ throw si.err
1014
+ }
597
1015
 
598
1016
  //md
599
1017
  let md = si.mds[opt.cl]
@@ -603,157 +1021,387 @@ function WOrmReladb(opt = {}) {
603
1021
  data = [data]
604
1022
  }
605
1023
 
606
- //check
607
- if (opt.autoGenPK) {
608
- data = map(data, function(v) {
609
- if (!v[opt.pk]) {
610
- v[opt.pk] = genID()
611
- }
612
- return v
613
- })
614
- }
1024
+ //procPk, 須於任何寫入之前一次完成, 令autoGenPk為false而拋錯時同批皆不會被寫入
1025
+ data = map(data, (v, k) => {
1026
+ return procPk(md, v, k)
1027
+ })
615
1028
 
616
- // //tr
617
- // let t = null
618
- // let tr = {}
619
- // if (atomic) {
620
- // t = await sequelize.transaction() //使用Unmanaged transaction (then-callback)
621
- // tr = {
622
- // transaction: t
623
- // }
624
- // }
1029
+ //nAll, n之基準為輸入筆數
1030
+ let nAll = size(data)
625
1031
 
626
- //pmSeries
627
- await pmSeries(data, async function(v) {
628
- let pmm = genPm()
1032
+ //useTx, sqlcipher不支援transaction, 該情形下改倚賴sqlite單一語句之原子性
1033
+ let useTx = !(opt.useEncryption &amp;&amp; dialect === 'sqlite')
629
1034
 
630
- //err
631
- let err = null
1035
+ //t, 呼叫端未給交易時自開; 已給時以巢狀交易(SAVEPOINT)包覆令回滾範圍限於本次呼叫
1036
+ let t = null
1037
+ if (useTx) {
1038
+ t = (transaction !== null)
1039
+ ? await md.sequelize.transaction({ transaction })
1040
+ : await md.sequelize.transaction()
1041
+ }
632
1042
 
633
- //r
634
- let r
635
- if (v[opt.pk]) {
636
- //有id
1043
+ //setting
1044
+ let setting = {}
1045
+ if (t !== null) {
1046
+ setting.transaction = t
1047
+ }
1048
+ else if (transaction !== null) {
1049
+ setting.transaction = transaction
1050
+ }
637
1051
 
638
- //setting
639
- let setting = {
640
- where: { [opt.pk]: v[opt.pk] },
641
- raw: true,
642
- }
643
- if (transaction !== null) {
644
- setting.transaction = transaction
645
- }
1052
+ try {
646
1053
 
647
- //findOne
648
- r = await md.findOne(setting)
649
- .catch((error) => {
650
- ee.emit('error', error)
651
- err = error
652
- })
1054
+ //bulkCreate, 未加任何跳過選項, 故任一筆撞主鍵即整句失敗, 同批重複主鍵亦於此被偵測為衝突
1055
+ await md.bulkCreate(data, setting)
653
1056
 
1057
+ if (t !== null) {
1058
+ await t.commit()
654
1059
  }
655
- else {
656
- //沒有id
657
- err = `${opt.pk} is invalid`
1060
+
1061
+ }
1062
+ catch (err) {
1063
+ if (t !== null) {
1064
+ await t.rollback().catch(() => {})
658
1065
  }
1066
+ throw err
1067
+ }
1068
+
1069
+ //res, 全有全無故成功時nInserted恆等於n
1070
+ res = {
1071
+ n: nAll,
1072
+ nInserted: nAll,
1073
+ ok: 1,
1074
+ }
659
1075
 
660
- if (r) {
661
- //有找到資料
1076
+ }
1077
+ catch (err) {
1078
+ isErr = true
1079
+ res = err
1080
+ }
1081
+ finally {
662
1082
 
663
- //setting
664
- let setting = {
665
- where: { [opt.pk]: v[opt.pk] },
666
- }
667
- if (transaction !== null) {
668
- setting.transaction = transaction
669
- }
1083
+ //closeSequelize
1084
+ if (instance === null) { //內部自動初始化得close
1085
+ await closeSequelize('insertBulk')
1086
+ }
1087
+
1088
+ }
670
1089
 
671
- let rr = await md.update(v, setting)
672
- .catch((error) => {
673
- ee.emit('error', error)
674
- err = error
675
- })
1090
+ //check
1091
+ if (isErr) {
1092
+ emitError('insertBulk', data, res)
1093
+ return Promise.reject(res)
1094
+ }
676
1095
 
677
- if (rr) {
678
- //console.log('update 有更新資料', rr)
679
- pmm.resolve({ n: 1, nModified: 1, ok: 1 })
680
- }
681
- else {
682
- //console.log('update 沒有更新資料', err)
683
- pmm.resolve({ n: 1, nModified: 0, ok: 0 })
684
- }
1096
+ //emit, 須於結果定案後發出
1097
+ emitChange('insertBulk', data, res)
685
1098
 
686
- }
687
- else {
688
- //沒有找到資料
1099
+ return res
1100
+ }
689
1101
 
690
- //autoInsert
691
- if (autoInsert) {
692
1102
 
693
- //setting
694
- let setting = { }
695
- if (transaction !== null) {
696
- setting.transaction = transaction
697
- }
1103
+ /**
1104
+ * 儲存單筆數據
1105
+ *
1106
+ * 採條件寫入配合衝突偵測與重試: 每次寫入本身為單一條件式原子語句——插入由主鍵之唯一約束判定、
1107
+ * 更新由WHERE主鍵之比對判定,皆非由預讀值決定其成敗;預讀僅用於選擇發出哪一條語句,
1108
+ * 選錯不會產生錯誤結果,只會被偵測並重試(插入撞既有主鍵、更新未命中任何列),故縱使預讀值已過期,
1109
+ * 最終結果仍與該次操作單獨執行時相同。
1110
+ * 註: 不採sequelize之upsert,因sqlite無從於單一語句內回報本次係插入或更新(其created恆為null),
1111
+ * 而insert與save之規格要求nInserted精確,兩者於sqlite互斥,故改採本形式
1112
+ * 註: [內容相同]之判定基準為將待寫入物件合併進現值後與現值相同,相同則不寫入而nModified為0,
1113
+ * 合併取淺層以與後端整欄取代之寫入行為一致,令nModified忠實反映資料庫端是否真的寫入
1114
+ *
1115
+ * @ignore
1116
+ * @param {Object} md 輸入資料表model物件
1117
+ * @param {Object} v 輸入數據物件
1118
+ * @param {Boolean} autoInsert 輸入是否於查無數據時自動改以插入處理布林值
1119
+ * @param {Object|null} transaction 輸入交易(transaction)物件
1120
+ * @param {Array} ks 輸入model之欄位名陣列
1121
+ * @returns {Promise} 回傳Promise,resolve回傳本筆儲存結果,本筆失敗時亦resolve並以ok為0回報
1122
+ */
1123
+ async function saveOne(md, v, autoInsert, transaction, ks) {
1124
+
1125
+ //nTry, 預測錯誤時重試, 給予有限次數令其收斂
1126
+ let nTry = 3
1127
+
1128
+ //rest
1129
+ let rest = null
1130
+
1131
+ //inserted, 供結果定案後發出insert事件用
1132
+ let inserted = false
1133
+
1134
+ //pkv
1135
+ let pkv = get(v, opt.pk)
1136
+
1137
+ //setting
1138
+ let settingRead = {
1139
+ where: { [opt.pk]: pkv },
1140
+ raw: true,
1141
+ }
1142
+ let settingUpd = {
1143
+ where: { [opt.pk]: pkv },
1144
+ }
1145
+ let settingIns = {}
1146
+ if (transaction !== null) {
1147
+ settingRead.transaction = transaction
1148
+ settingUpd.transaction = transaction
1149
+ settingIns.transaction = transaction
1150
+ }
698
1151
 
699
- //create
700
- let rr = await md.create(v, setting)
701
- .catch((error) => {
702
- ee.emit('error', error)
703
- err = error
704
- })
1152
+ for (let i = 0; i &lt; nTry; i++) {
705
1153
 
706
- if (rr) {
707
- //console.log('create 有插入資料', rr)
708
- pmm.resolve({ n: 1, nInserted: 1, ok: 1 })
1154
+ try {
1155
+
1156
+ //預讀, 供判斷內容是否相同之快速路徑, 其結果不用於決定寫入內容
1157
+ let _v = await md.findOne(settingRead)
1158
+
1159
+ if (iseobj(_v)) {
1160
+ //主鍵存在
1161
+
1162
+ //_vt, vt, 以待寫入物件之非主鍵欄位淺層覆蓋現值後與現值比對
1163
+ let _vt = omit(_v, opt.pk)
1164
+ let vt = {
1165
+ ..._vt,
1166
+ ...pick(omit(v, opt.pk), ks),
1167
+ }
1168
+
1169
+ //check, 內容相同者不寫入
1170
+ if (isEqual(vt, _vt)) {
1171
+ rest = {
1172
+ n: 1,
1173
+ nInserted: 0,
1174
+ nModified: 0,
1175
+ ok: 1,
709
1176
  }
710
- else {
711
- //console.log('create 沒有插入資料', err)
712
- pmm.resolve({ n: 1, nInserted: 0, ok: 0 })
1177
+ break
1178
+ }
1179
+
1180
+ //update, 單一UPDATE語句由WHERE主鍵原子完成查找與更新
1181
+ let rr = await md.update(v, settingUpd)
1182
+ let nAff = get(rr, 0, 0)
1183
+
1184
+ if (nAff > 0) {
1185
+ rest = {
1186
+ n: 1,
1187
+ nInserted: 0,
1188
+ nModified: 1,
1189
+ ok: 1,
713
1190
  }
1191
+ break
1192
+ }
1193
+
1194
+ //該列已被他方刪除, 重試改走插入
1195
+ continue
1196
+ }
714
1197
 
1198
+ //主鍵不存在且未開啟autoInsert則不寫入以免無中生有
1199
+ if (!autoInsert) {
1200
+ rest = {
1201
+ n: 0,
1202
+ nInserted: 0,
1203
+ nModified: 0,
1204
+ ok: 1,
715
1205
  }
716
- else {
717
- //console.log('findOne 沒有找到資料也不自動插入', err)
718
- pmm.resolve({ n: 0, nModified: 0, ok: 1 })
1206
+ break
1207
+ }
1208
+
1209
+ //create, 單一INSERT語句由主鍵之唯一約束原子完成檢查與寫入
1210
+ let bIns = await md.create(v, settingIns)
1211
+ .then(() => {
1212
+ return true
1213
+ })
1214
+ .catch((err) => {
1215
+ if (isDupPkError(err)) {
1216
+ return false
1217
+ }
1218
+ throw err
1219
+ })
1220
+
1221
+ if (bIns) {
1222
+ rest = {
1223
+ n: 1,
1224
+ nInserted: 1,
1225
+ nModified: 0,
1226
+ ok: 1,
719
1227
  }
1228
+ inserted = true
1229
+ break
1230
+ }
1231
+
1232
+ //他方已插入同一主鍵, 重試改走更新
1233
+ continue
1234
+ }
1235
+ catch (err) {
720
1236
 
1237
+ //check, 連線層錯誤影響後續所有筆數, 依T4屬整批性錯誤, 往外拋而不降為本筆ok為0
1238
+ if (isBatchLevelError(err)) {
1239
+ throw err
721
1240
  }
722
1241
 
723
- pmm._err = err //避免eslint錯誤訊息
724
- return pmm
1242
+ //其餘錯誤視為本筆失敗, 不中斷整批, 由呼叫端以ok與err判讀
1243
+ rest = {
1244
+ n: 1,
1245
+ nInserted: 0,
1246
+ nModified: 0,
1247
+ ok: 0,
1248
+ err: getErrMsg(err),
1249
+ }
1250
+ break
1251
+ }
1252
+
1253
+ }
1254
+
1255
+ //check, 重試耗盡仍未定案
1256
+ if (rest === null) {
1257
+ rest = {
1258
+ n: 1,
1259
+ nInserted: 0,
1260
+ nModified: 0,
1261
+ ok: 0,
1262
+ err: `can not save data by ${opt.pk}[${pkv}] in ${nTry} tries`,
1263
+ }
1264
+ }
1265
+
1266
+ //emit, 須於本筆結果定案後發出, 避免訂閱函數拋錯影響本筆結果
1267
+ if (inserted) {
1268
+ emitChange('insert', [v], rest)
1269
+ }
1270
+ if (rest.ok === 0) {
1271
+ emitError('save', [v], rest.err)
1272
+ }
1273
+
1274
+ return rest
1275
+ }
1276
+
1277
+
1278
+ /**
1279
+ * 儲存數據,以主鍵為準更新既有數據,未給之欄位保留;主鍵不存在且option.autoInsert為true(預設)時改為插入
1280
+ *
1281
+ * 註: 回傳陣列恆與輸入等長,輸入單一物件亦回傳長度1之陣列
1282
+ * 註: n為主鍵命中筆數,值為0或1,命中(不論內容有無變更)或經插入而產生皆為1;nInserted與nModified恆同時出現
1283
+ * 註: [內容相同]之判定基準為將待寫入物件合併進現值後與現值相同,非待寫入物件與現值全等,
1284
+ * 故只給部份欄位且該些欄位值皆與現值相同時,合併結果等於現值,nModified為0
1285
+ * 註: 本筆失敗不中斷整批,該筆以ok為0並附err回報
1286
+ * 註: opt.autoGenPk為true(預設)時未帶有效主鍵者自動產生,為false時未帶有效主鍵即reject且同批皆不寫入
1287
+ *
1288
+ * @memberOf WOrmReladb
1289
+ * @param {Object|Array} data 輸入數據物件或陣列
1290
+ * @param {Object} [option={}] 輸入設定物件,預設為{}
1291
+ * @param {Object} [option.instance=null] 輸入實例instance物件,預設為null
1292
+ * @param {Object} [option.transaction=null] 輸入交易(transaction)物件,預設為null
1293
+ * @param {boolean} [option.autoInsert=true] 輸入是否於儲存時發現原本無數據,則自動改以插入處理,預設為true
1294
+ * @returns {Promise} 回傳Promise,resolve回傳與輸入等長之儲存結果陣列[{n,nInserted,nModified,ok}],reject回傳錯誤訊息
1295
+ */
1296
+ async function save(data, option = {}) {
1297
+
1298
+ //check
1299
+ if (!iseobj(data) &amp;&amp; !isearr(data)) {
1300
+ return []
1301
+ }
1302
+
1303
+ //cloneDeep
1304
+ data = cloneDeep(data)
1305
+
1306
+ //instance
1307
+ let instance = get(option, 'instance', null)
1308
+
1309
+ //transaction
1310
+ let transaction = get(option, 'transaction', null)
1311
+
1312
+ //check
1313
+ if (opt.useEncryption &amp;&amp; dialect === 'sqlite') {
1314
+ if (transaction !== null) {
1315
+ console.log('@journeyapps/sqlcipher can not support transaction.')
1316
+ }
1317
+ }
1318
+
1319
+ //autoInsert
1320
+ let autoInsert = get(option, 'autoInsert', true)
1321
+
1322
+ //isErr, res
1323
+ let isErr = false
1324
+ let res = null
1325
+
1326
+ //si
1327
+ let si = instance
1328
+ if (instance === null) {
1329
+ si = await initSequelize()
1330
+ }
1331
+
1332
+ try {
1333
+
1334
+ //check, 實例已關閉屬整批性錯誤, 於入口快速失敗
1335
+ procClosed(instance)
1336
+
1337
+ //check
1338
+ if (si.err) {
1339
+ throw si.err
1340
+ }
1341
+
1342
+ //md
1343
+ let md = si.mds[opt.cl]
1344
+
1345
+ //check
1346
+ if (!isarr(data)) {
1347
+ data = [data]
1348
+ }
1349
+
1350
+ //procPk, 須於任何寫入之前一次完成, 令autoGenPk為false而拋錯時同批之有效筆數亦不會被寫入
1351
+ data = map(data, (v, k) => {
1352
+ return procPk(md, v, k)
1353
+ })
1354
+
1355
+ //ks, model之欄位名, 供合併後比對時濾除非欄位之鍵
1356
+ let ks = keys(get(md, 'rawAttributes', {}))
1357
+
1358
+ //pmSeries
1359
+ res = await pmSeries(data, async(v) => {
1360
+ return saveOne(md, v, autoInsert, transaction, ks)
725
1361
  })
726
- .then((res) => {
727
- pm.resolve(res)
728
- ee.emit('change', 'save', data, res)
729
- })
730
- .catch((error) => {
731
- pm.reject(error)
732
- })
733
1362
 
734
1363
  }
735
- else {
736
- pm.reject(si.err)
1364
+ catch (err) {
1365
+ isErr = true
1366
+ res = err
737
1367
  }
1368
+ finally {
1369
+
1370
+ //closeSequelize
1371
+ if (instance === null) { //內部自動初始化得close
1372
+ await closeSequelize('save')
1373
+ }
738
1374
 
739
- //closeSequelize
740
- if (instance === null) { //內部自動初始化得close
741
- await closeSequelize('save')
742
1375
  }
743
1376
 
744
- return pm
1377
+ //check
1378
+ if (isErr) {
1379
+ emitError('save', data, res)
1380
+ return Promise.reject(res)
1381
+ }
1382
+
1383
+ //emit, 須於結果定案後發出
1384
+ emitChange('save', data, res)
1385
+
1386
+ return res
745
1387
  }
746
1388
 
747
1389
 
748
1390
  /**
749
1391
  * 刪除數據
750
1392
  *
1393
+ * 註: 回傳陣列恆與輸入等長,各筆之n與nDeleted皆為主鍵命中筆數,值為0或1,未命中為0且屬正常結果
1394
+ * 註: 判斷某筆是否真的被刪除一律以nDeleted為準
1395
+ * 註: 未帶有效主鍵者為該筆之輸入問題,回ok為0與err且不送查詢條件(以免無效值被轉為null而誤中其他數據),
1396
+ * 不中斷其餘筆數,以此與[主鍵未命中]之ok為1區辨
1397
+ * 註: 本函數不受opt.autoGenPk影響,於任一設定下皆不補值
1398
+ *
751
1399
  * @memberOf WOrmReladb
752
1400
  * @param {Object|Array} data 輸入數據物件或陣列,會查找各數據的opt.pk值,有存在者就刪除
753
1401
  * @param {Object} [option={}] 輸入設定物件,預設為{}
754
1402
  * @param {Object} [option.instance=null] 輸入實例instance物件,預設為null
755
1403
  * @param {Object} [option.transaction=null] 輸入交易(transaction)物件,預設為null
756
- * @returns {Promise} 回傳Promise,resolve回傳刪除結果,reject回傳錯誤訊息
1404
+ * @returns {Promise} 回傳Promise,resolve回傳與輸入等長之刪除結果陣列[{n,nDeleted,ok}],reject回傳錯誤訊息
757
1405
  */
758
1406
  async function del(data, option = {}) {
759
1407
 
@@ -778,19 +1426,25 @@ function WOrmReladb(opt = {}) {
778
1426
  }
779
1427
  }
780
1428
 
781
- //pm
782
- let pm = genPm()
1429
+ //isErr, res
1430
+ let isErr = false
1431
+ let res = null
783
1432
 
784
1433
  //si
785
1434
  let si = instance
786
1435
  if (instance === null) {
787
1436
  si = await initSequelize()
788
1437
  }
789
- // else {
790
- // console.log('del use instance', instance)
791
- // }
792
1438
 
793
- if (!si.err) {
1439
+ try {
1440
+
1441
+ //check, 實例已關閉屬整批性錯誤, 於入口快速失敗
1442
+ procClosed(instance)
1443
+
1444
+ //check
1445
+ if (si.err) {
1446
+ throw si.err
1447
+ }
794
1448
 
795
1449
  //md
796
1450
  let md = si.mds[opt.cl]
@@ -801,106 +1455,116 @@ function WOrmReladb(opt = {}) {
801
1455
  }
802
1456
 
803
1457
  //pmSeries
804
- await pmSeries(data, async function(v) {
805
- let pmm = genPm()
1458
+ res = await pmSeries(data, async(v) => {
806
1459
 
807
- //err
808
- let err = null
1460
+ //rest
1461
+ let rest = null
809
1462
 
810
- //r
811
- let r
812
- if (v[opt.pk]) {
813
- //有id
1463
+ //pkv
1464
+ let pkv = get(v, opt.pk)
814
1465
 
815
- //setting
816
- let setting = {
817
- where: { [opt.pk]: v[opt.pk] },
818
- raw: true,
819
- }
820
- if (transaction !== null) {
821
- setting.transaction = transaction
1466
+ //check, 未帶有效主鍵者不補值亦不送查詢, 直接視為該筆無法處理
1467
+ if (!isEffPk(pkv)) {
1468
+
1469
+ //rest
1470
+ rest = {
1471
+ n: 0,
1472
+ nDeleted: 0,
1473
+ ok: 0,
1474
+ err: `invalid ${opt.pk}[${pkv}]`,
822
1475
  }
823
1476
 
824
- //findOne
825
- r = await md.findOne(setting)
826
- .catch((error) => {
827
- ee.emit('error', error)
828
- err = error
829
- })
1477
+ //emit
1478
+ emitError('del', [v], rest.err)
830
1479
 
1480
+ return rest
831
1481
  }
832
- else {
833
- //沒有id
834
- err = `${opt.pk} is invalid`
1482
+
1483
+ //setting
1484
+ let setting = {
1485
+ where: { [opt.pk]: pkv },
1486
+ }
1487
+ if (transaction !== null) {
1488
+ setting.transaction = transaction //destroy的說明寫不需transaction但實際需要 (2020/10/07)
835
1489
  }
836
1490
 
837
- if (r) {
838
- //有找到資料
1491
+ //destroy, 單一DELETE語句即可取得命中筆數, 不另行findOne以免多一次往返且與刪除間存在競態
1492
+ await md.destroy(setting)
1493
+ .then((r) => {
839
1494
 
840
- //setting
841
- let setting = {
842
- where: { [opt.pk]: v[opt.pk] },
843
- }
844
- if (transaction !== null) {
845
- setting.transaction = transaction //destroy的說明寫不需transaction但實際需要 (2020/10/07)
846
- }
1495
+ //nDel, n與nDeleted皆為主鍵命中筆數, 未命中為0且屬正常結果
1496
+ let nDel = isnum(r) ? r : 0
847
1497
 
848
- //destroy
849
- let rr = await md.destroy(setting)
850
- .catch((error) => {
851
- ee.emit('error', error)
852
- err = error
853
- })
1498
+ //rest
1499
+ rest = {
1500
+ n: nDel,
1501
+ nDeleted: nDel,
1502
+ ok: 1,
1503
+ }
854
1504
 
855
- if (rr) {
856
- //console.log('destroy 有刪除資料', rr)
857
- pmm.resolve({ n: 1, nDeleted: 1, ok: 1 })
858
- }
859
- else {
860
- //console.log('destroy 沒有刪除資料', err)
861
- pmm.resolve({ n: 1, nDeleted: 0, ok: 0 })
862
- }
1505
+ })
1506
+ .catch((err) => {
863
1507
 
864
- }
865
- else {
866
- //console.log('findOne 沒有找到資料', err)
867
- pmm.resolve({ n: 0, nDeleted: 0, ok: 1 })
868
- }
1508
+ //check, 連線層錯誤影響後續所有筆數, 依T4屬整批性錯誤, 往外拋而不降為本筆ok為0
1509
+ if (isBatchLevelError(err)) {
1510
+ throw err
1511
+ }
1512
+
1513
+ //rest, 本筆失敗不中斷整批
1514
+ rest = {
1515
+ n: 1,
1516
+ nDeleted: 0,
1517
+ ok: 0,
1518
+ err: getErrMsg(err),
1519
+ }
1520
+
1521
+ //emit
1522
+ emitError('del', [v], rest.err)
869
1523
 
870
- pmm._err = err //避免eslint錯誤訊息
871
- return pmm
1524
+ })
1525
+
1526
+ return rest
872
1527
  })
873
- .then((res) => {
874
- pm.resolve(res)
875
- ee.emit('change', 'del', data, res)
876
- })
877
- .catch((res) => {
878
- pm.reject(res)
879
- })
880
1528
 
881
1529
  }
882
- else {
883
- pm.reject(si.err)
1530
+ catch (err) {
1531
+ isErr = true
1532
+ res = err
884
1533
  }
1534
+ finally {
1535
+
1536
+ //closeSequelize
1537
+ if (instance === null) { //內部自動初始化得close
1538
+ await closeSequelize('del')
1539
+ }
885
1540
 
886
- //closeSequelize
887
- if (instance === null) { //內部自動初始化得close
888
- await closeSequelize('del')
889
1541
  }
890
1542
 
891
- return pm
1543
+ //check
1544
+ if (isErr) {
1545
+ emitError('del', data, res)
1546
+ return Promise.reject(res)
1547
+ }
1548
+
1549
+ //emit, 須於結果定案後發出
1550
+ emitChange('del', data, res)
1551
+
1552
+ return res
892
1553
  }
893
1554
 
894
1555
 
895
1556
  /**
896
- * 刪除數據,需與del分開,避免未傳數據導致直接刪除全表
1557
+ * 依條件刪除多筆數據,需與del分開,避免未傳數據導致直接刪除全表
1558
+ *
1559
+ * 註: n與nDeleted皆為實際刪除筆數,兩者恆相等,n不得取全表筆數
1560
+ * 註: find未給或為空物件時刪除全部數據;條件無命中時回{n:0,nDeleted:0,ok:1},不視為錯誤
897
1561
  *
898
1562
  * @memberOf WOrmReladb
899
1563
  * @param {Object} [find={}] 輸入刪除條件物件,不給予find則代表刪除全部數據
900
1564
  * @param {Object} [option={}] 輸入設定物件,預設為{}
901
1565
  * @param {Object} [option.instance=null] 輸入實例instance物件,預設為null
902
1566
  * @param {Object} [option.transaction=null] 輸入交易(transaction)物件,預設為null
903
- * @returns {Promise} 回傳Promise,resolve回傳刪除結果,reject回傳錯誤訊息
1567
+ * @returns {Promise} 回傳Promise,resolve回傳刪除結果{n,nDeleted,ok},reject回傳錯誤訊息
904
1568
  */
905
1569
  async function delAll(find = {}, option = {}) {
906
1570
 
@@ -923,19 +1587,25 @@ function WOrmReladb(opt = {}) {
923
1587
  }
924
1588
  }
925
1589
 
926
- //pm
927
- let pm = genPm()
1590
+ //isErr, res
1591
+ let isErr = false
1592
+ let res = null
928
1593
 
929
1594
  //si
930
1595
  let si = instance
931
1596
  if (instance === null) {
932
1597
  si = await initSequelize()
933
1598
  }
934
- // else {
935
- // console.log('delAll use instance', instance)
936
- // }
937
1599
 
938
- if (!si.err) {
1600
+ try {
1601
+
1602
+ //check, 實例已關閉屬整批性錯誤, 於入口快速失敗
1603
+ procClosed(instance)
1604
+
1605
+ //check
1606
+ if (si.err) {
1607
+ throw si.err
1608
+ }
939
1609
 
940
1610
  //md
941
1611
  let md = si.mds[opt.cl]
@@ -948,29 +1618,41 @@ function WOrmReladb(opt = {}) {
948
1618
  setting.transaction = transaction //destroy的說明寫不需transaction但實際需要 (2020/10/07)
949
1619
  }
950
1620
 
951
- //destroy
952
- await md.destroy(setting)
953
- .then((res) => {
954
- res = { n: res, nDeleted: res, ok: 1 }
955
- pm.resolve(res)
956
- ee.emit('change', 'delAll', null, res)
957
- })
958
- .catch((error) => {
959
- ee.emit('error', error)
960
- pm.reject({ n: 0, ok: 0 })
961
- })
1621
+ //destroy, n與nDeleted皆為實際刪除筆數, 條件無命中時為0且屬正常結果
1622
+ let r = await md.destroy(setting)
1623
+ let nDel = isnum(r) ? r : 0
1624
+
1625
+ //res
1626
+ res = {
1627
+ n: nDel,
1628
+ nDeleted: nDel,
1629
+ ok: 1,
1630
+ }
962
1631
 
963
1632
  }
964
- else {
965
- pm.reject(si.err)
1633
+ catch (err) {
1634
+ isErr = true
1635
+ res = err
966
1636
  }
1637
+ finally {
1638
+
1639
+ //closeSequelize
1640
+ if (instance === null) { //內部自動初始化得close
1641
+ await closeSequelize('delAll')
1642
+ }
967
1643
 
968
- //closeSequelize
969
- if (instance === null) { //內部自動初始化得close
970
- await closeSequelize('delAll')
971
1644
  }
972
1645
 
973
- return pm
1646
+ //check
1647
+ if (isErr) {
1648
+ emitError('delAll', null, res)
1649
+ return Promise.reject(res)
1650
+ }
1651
+
1652
+ //emit, 須於結果定案後發出
1653
+ emitChange('delAll', null, res)
1654
+
1655
+ return res
974
1656
  }
975
1657
 
976
1658
 
@@ -1092,9 +1774,15 @@ function WOrmReladb(opt = {}) {
1092
1774
  ee.select = function() {
1093
1775
  return pmq(select, ...arguments)
1094
1776
  }
1777
+ ee.selectByPk = function() {
1778
+ return pmq(selectByPk, ...arguments)
1779
+ }
1095
1780
  ee.insert = function() {
1096
1781
  return pmq(insert, ...arguments)
1097
1782
  }
1783
+ ee.insertBulk = function() {
1784
+ return pmq(insertBulk, ...arguments)
1785
+ }
1098
1786
  ee.save = function() {
1099
1787
  return pmq(save, ...arguments)
1100
1788
  }
@@ -1107,7 +1795,9 @@ function WOrmReladb(opt = {}) {
1107
1795
  }
1108
1796
  else {
1109
1797
  ee.select = select
1798
+ ee.selectByPk = selectByPk
1110
1799
  ee.insert = insert
1800
+ ee.insertBulk = insertBulk
1111
1801
  ee.save = save
1112
1802
  ee.del = del
1113
1803
  ee.delAll = delAll
@@ -1132,7 +1822,7 @@ export default WOrmReladb
1132
1822
  <br class="clear">
1133
1823
 
1134
1824
  <footer>
1135
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Sat Aug 08 2026 15:03:07 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1825
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Mon Aug 17 2026 19:12:32 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1136
1826
  </footer>
1137
1827
 
1138
1828
  <script>prettyPrint();</script>