@maiyunnet/kebab 9.14.0 → 9.14.1
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.
- package/doc/kebab-rag.md +291 -147
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/lib/core.js +24 -7
- package/lib/sql.d.ts +26 -0
- package/lib/sql.js +34 -1
- package/package.json +1 -1
- package/sys/ctr.d.ts +4 -0
- package/sys/mod.d.ts +32 -0
- package/sys/mod.js +37 -1
- package/sys/route.d.ts +4 -0
- package/sys/route.js +63 -0
- package/www/example/ctr/test.js +16 -0
- package/www/example/stc/chunk-FG5CKGYR.js +81 -0
- package/www/example/stc/view/hello.page.bundle.js +1 -1
- package/www/example/stc/view/hello.page.css +2 -2
- package/www/example/stc/view/react-router.page.bundle.js +1 -1
- package/www/example/stc/view/react-router.page.css +2 -2
- package/www/example/stc/view/react-router.page.js +1 -1
- package/www/example/stc/view/react-router.page.tsx +1 -1
- package/www/example/stc/view/react.page.bundle.js +3 -3
- package/www/example/stc/view/react.page.css +2 -2
- package/www/example/stc/chunk-YJ3GYATF.js +0 -81
package/doc/kebab-rag.md
CHANGED
|
@@ -1360,7 +1360,7 @@ index/variables/VER.md
|
|
|
1360
1360
|
|
|
1361
1361
|
# Variable: VER
|
|
1362
1362
|
|
|
1363
|
-
> `const` **VER**: `"9.14.
|
|
1363
|
+
> `const` **VER**: `"9.14.1"` = `'9.14.1'`
|
|
1364
1364
|
|
|
1365
1365
|
Defined in: [index.ts:10](https://github.com/maiyunnet/kebab/blob/master/index.ts#L10)
|
|
1366
1366
|
|
|
@@ -3350,7 +3350,7 @@ lib/core/functions/clone.md
|
|
|
3350
3350
|
|
|
3351
3351
|
> **clone**\<`T`\>(`obj`): `T`
|
|
3352
3352
|
|
|
3353
|
-
Defined in: [lib/core.ts:
|
|
3353
|
+
Defined in: [lib/core.ts:1189](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1189)
|
|
3354
3354
|
|
|
3355
3355
|
完整的克隆一份数组/对象
|
|
3356
3356
|
|
|
@@ -3414,7 +3414,7 @@ lib/core/functions/debug.md
|
|
|
3414
3414
|
|
|
3415
3415
|
> **debug**(`message?`, ...`optionalParams`): `void`
|
|
3416
3416
|
|
|
3417
|
-
Defined in: [lib/core.ts:
|
|
3417
|
+
Defined in: [lib/core.ts:1223](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1223)
|
|
3418
3418
|
|
|
3419
3419
|
打印调试信息,线上环境不会打印
|
|
3420
3420
|
|
|
@@ -3449,7 +3449,7 @@ lib/core/functions/display.md
|
|
|
3449
3449
|
|
|
3450
3450
|
> **display**(`message?`, ...`optionalParams`): `void`
|
|
3451
3451
|
|
|
3452
|
-
Defined in: [lib/core.ts:
|
|
3452
|
+
Defined in: [lib/core.ts:1236](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1236)
|
|
3453
3453
|
|
|
3454
3454
|
向控制台直接显示内容,一般情况下禁止使用
|
|
3455
3455
|
|
|
@@ -3484,7 +3484,7 @@ lib/core/functions/emptyObject.md
|
|
|
3484
3484
|
|
|
3485
3485
|
> **emptyObject**(`obj`, `deep?`): `void`
|
|
3486
3486
|
|
|
3487
|
-
Defined in: [lib/core.ts:
|
|
3487
|
+
Defined in: [lib/core.ts:471](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L471)
|
|
3488
3488
|
|
|
3489
3489
|
将对象的所有属性清除包括键,不会破坏引用关系,对象变量依然保证是引用状态
|
|
3490
3490
|
|
|
@@ -3519,7 +3519,7 @@ lib/core/functions/exec.md
|
|
|
3519
3519
|
|
|
3520
3520
|
> **exec**(`command`, `options?`): `Promise`\<`string` \| `false`\>
|
|
3521
3521
|
|
|
3522
|
-
Defined in: [lib/core.ts:
|
|
3522
|
+
Defined in: [lib/core.ts:533](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L533)
|
|
3523
3523
|
|
|
3524
3524
|
执行命令行
|
|
3525
3525
|
|
|
@@ -3554,7 +3554,7 @@ lib/core/functions/getLog.md
|
|
|
3554
3554
|
|
|
3555
3555
|
> **getLog**(`opt`): `Promise`\<`false` \| \{ `list`: `any`[] \| `string`[][]; `total`: `number`; \}\>
|
|
3556
3556
|
|
|
3557
|
-
Defined in: [lib/core.ts:
|
|
3557
|
+
Defined in: [lib/core.ts:1101](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1101)
|
|
3558
3558
|
|
|
3559
3559
|
获取日志内容为一个数组
|
|
3560
3560
|
|
|
@@ -3654,7 +3654,7 @@ lib/core/functions/ips.md
|
|
|
3654
3654
|
|
|
3655
3655
|
> **ips**(`ctr`): `object`
|
|
3656
3656
|
|
|
3657
|
-
Defined in: [lib/core.ts:
|
|
3657
|
+
Defined in: [lib/core.ts:384](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L384)
|
|
3658
3658
|
|
|
3659
3659
|
获取 CF 和 X 的 IP
|
|
3660
3660
|
|
|
@@ -3689,7 +3689,7 @@ lib/core/functions/loadEnv.md
|
|
|
3689
3689
|
|
|
3690
3690
|
> **loadEnv**(`dir`): `Promise`\<`void`\>
|
|
3691
3691
|
|
|
3692
|
-
Defined in: [lib/core.ts:
|
|
3692
|
+
Defined in: [lib/core.ts:1288](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1288)
|
|
3693
3693
|
|
|
3694
3694
|
加载 .env 文件到 process.env,若文件不存在则跳过
|
|
3695
3695
|
|
|
@@ -3718,7 +3718,7 @@ lib/core/functions/log.md
|
|
|
3718
3718
|
|
|
3719
3719
|
> **log**(`opt`, `msg`, `fend?`): `void`
|
|
3720
3720
|
|
|
3721
|
-
Defined in: [lib/core.ts:
|
|
3721
|
+
Defined in: [lib/core.ts:988](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L988)
|
|
3722
3722
|
|
|
3723
3723
|
写入文件日志
|
|
3724
3724
|
|
|
@@ -3759,7 +3759,7 @@ lib/core/functions/ls.md
|
|
|
3759
3759
|
|
|
3760
3760
|
> **ls**(`opt`): `Promise`\<`object`[]\>
|
|
3761
3761
|
|
|
3762
|
-
Defined in: [lib/core.ts:
|
|
3762
|
+
Defined in: [lib/core.ts:1150](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1150)
|
|
3763
3763
|
|
|
3764
3764
|
获取目录内文件/文件夹列表
|
|
3765
3765
|
|
|
@@ -3865,7 +3865,7 @@ lib/core/functions/objectSort.md
|
|
|
3865
3865
|
|
|
3866
3866
|
> **objectSort**\<`T`\>(`o`): `T`
|
|
3867
3867
|
|
|
3868
|
-
Defined in: [lib/core.ts:
|
|
3868
|
+
Defined in: [lib/core.ts:452](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L452)
|
|
3869
3869
|
|
|
3870
3870
|
将对象进行升序排列
|
|
3871
3871
|
|
|
@@ -3900,7 +3900,7 @@ lib/core/functions/passThroughAppend.md
|
|
|
3900
3900
|
|
|
3901
3901
|
> **passThroughAppend**(`passThrough`, `data`, `end?`): `Promise`\<`void`\>
|
|
3902
3902
|
|
|
3903
|
-
Defined in: [lib/core.ts:
|
|
3903
|
+
Defined in: [lib/core.ts:490](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L490)
|
|
3904
3904
|
|
|
3905
3905
|
调用前自行创建 passThrough,并且调用 pipe 绑定到应该绑定的对象,然后再调用本函数
|
|
3906
3906
|
|
|
@@ -4052,7 +4052,7 @@ lib/core/functions/realIP.md
|
|
|
4052
4052
|
|
|
4053
4053
|
> **realIP**(`ctr`, `name?`): `string`
|
|
4054
4054
|
|
|
4055
|
-
Defined in: [lib/core.ts:
|
|
4055
|
+
Defined in: [lib/core.ts:424](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L424)
|
|
4056
4056
|
|
|
4057
4057
|
获取直连 IP(安全 IP)
|
|
4058
4058
|
|
|
@@ -4085,7 +4085,7 @@ lib/core/functions/removeGlobal.md
|
|
|
4085
4085
|
|
|
4086
4086
|
> **removeGlobal**(`key`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4087
4087
|
|
|
4088
|
-
Defined in: [lib/core.ts:
|
|
4088
|
+
Defined in: [lib/core.ts:805](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L805)
|
|
4089
4089
|
|
|
4090
4090
|
移除某个跨线程/跨内网服务器全局变量
|
|
4091
4091
|
|
|
@@ -4120,7 +4120,7 @@ lib/core/functions/resolveEnvVars.md
|
|
|
4120
4120
|
|
|
4121
4121
|
> **resolveEnvVars**(`obj`): `void`
|
|
4122
4122
|
|
|
4123
|
-
Defined in: [lib/core.ts:
|
|
4123
|
+
Defined in: [lib/core.ts:1318](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1318)
|
|
4124
4124
|
|
|
4125
4125
|
将配置对象中的 ${ENV_VAR} 占位符替换为 process.env 的值
|
|
4126
4126
|
|
|
@@ -4149,7 +4149,7 @@ lib/core/functions/sendNpm.md
|
|
|
4149
4149
|
|
|
4150
4150
|
> **sendNpm**(`path`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4151
4151
|
|
|
4152
|
-
Defined in: [lib/core.ts:
|
|
4152
|
+
Defined in: [lib/core.ts:704](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L704)
|
|
4153
4153
|
|
|
4154
4154
|
向本机或局域网 RPC 发送 npm install 操作
|
|
4155
4155
|
|
|
@@ -4184,7 +4184,7 @@ lib/core/functions/sendPackage.md
|
|
|
4184
4184
|
|
|
4185
4185
|
> **sendPackage**(`content`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4186
4186
|
|
|
4187
|
-
Defined in: [lib/core.ts:
|
|
4187
|
+
Defined in: [lib/core.ts:928](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L928)
|
|
4188
4188
|
|
|
4189
4189
|
向本机或局域网 RPC 发送 package.json 更新操作
|
|
4190
4190
|
|
|
@@ -4219,7 +4219,7 @@ lib/core/functions/sendPm2.md
|
|
|
4219
4219
|
|
|
4220
4220
|
> **sendPm2**(`name`, `action?`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4221
4221
|
|
|
4222
|
-
Defined in: [lib/core.ts:
|
|
4222
|
+
Defined in: [lib/core.ts:656](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L656)
|
|
4223
4223
|
|
|
4224
4224
|
向本机或局域网 RPC 发送 PM2 操作
|
|
4225
4225
|
|
|
@@ -4260,7 +4260,7 @@ lib/core/functions/sendProject.md
|
|
|
4260
4260
|
|
|
4261
4261
|
> **sendProject**(`path`, `key`, `value`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4262
4262
|
|
|
4263
|
-
Defined in: [lib/core.ts:
|
|
4263
|
+
Defined in: [lib/core.ts:880](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L880)
|
|
4264
4264
|
|
|
4265
4265
|
向本机或局域网 RPC 发送项目配置更新操作
|
|
4266
4266
|
|
|
@@ -4307,7 +4307,7 @@ lib/core/functions/sendReload.md
|
|
|
4307
4307
|
|
|
4308
4308
|
> **sendReload**(`hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4309
4309
|
|
|
4310
|
-
Defined in: [lib/core.ts:
|
|
4310
|
+
Defined in: [lib/core.ts:553](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L553)
|
|
4311
4311
|
|
|
4312
4312
|
向主进程(或局域网同代码机子)发送广播将进行 reload 操作,等待回传
|
|
4313
4313
|
主要作用除代码热更新以外的其他情况
|
|
@@ -4335,7 +4335,7 @@ lib/core/functions/sendRestart.md
|
|
|
4335
4335
|
|
|
4336
4336
|
> **sendRestart**(`hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4337
4337
|
|
|
4338
|
-
Defined in: [lib/core.ts:
|
|
4338
|
+
Defined in: [lib/core.ts:602](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L602)
|
|
4339
4339
|
|
|
4340
4340
|
向主进程(或局域网同代码机子)发送广播将进行 restart 操作,停止监听并启动新进程,老进程在连接全部断开后自行销毁
|
|
4341
4341
|
主要用作不间断的代码热更新
|
|
@@ -4410,7 +4410,7 @@ lib/core/functions/setGlobal.md
|
|
|
4410
4410
|
|
|
4411
4411
|
> **setGlobal**(`key`, `data`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4412
4412
|
|
|
4413
|
-
Defined in: [lib/core.ts:
|
|
4413
|
+
Defined in: [lib/core.ts:755](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L755)
|
|
4414
4414
|
|
|
4415
4415
|
设置跨线程/指定的局域网主机的全局变量
|
|
4416
4416
|
|
|
@@ -4451,7 +4451,7 @@ lib/core/functions/sleep.md
|
|
|
4451
4451
|
|
|
4452
4452
|
> **sleep**(`ms`): `Promise`\<`void`\>
|
|
4453
4453
|
|
|
4454
|
-
Defined in: [lib/core.ts:
|
|
4454
|
+
Defined in: [lib/core.ts:440](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L440)
|
|
4455
4455
|
|
|
4456
4456
|
间隔一段时间
|
|
4457
4457
|
|
|
@@ -4509,7 +4509,7 @@ lib/core/functions/updateCode.md
|
|
|
4509
4509
|
|
|
4510
4510
|
> **updateCode**(`sourcePath`, `path`, `hosts?`, `config?`, `strict?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4511
4511
|
|
|
4512
|
-
Defined in: [lib/core.ts:
|
|
4512
|
+
Defined in: [lib/core.ts:820](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L820)
|
|
4513
4513
|
|
|
4514
4514
|
上传并覆盖代码文件,config.json、kebab.json、.js.map、.ts, .gitignore 不会被覆盖和新创建
|
|
4515
4515
|
|
|
@@ -4562,7 +4562,7 @@ lib/core/functions/writeEventStreamHead.md
|
|
|
4562
4562
|
|
|
4563
4563
|
> **writeEventStreamHead**(`res`): `void`
|
|
4564
4564
|
|
|
4565
|
-
Defined in: [lib/core.ts:
|
|
4565
|
+
Defined in: [lib/core.ts:1258](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1258)
|
|
4566
4566
|
|
|
4567
4567
|
## Parameters
|
|
4568
4568
|
|
|
@@ -4587,7 +4587,7 @@ lib/core/functions/writeHead.md
|
|
|
4587
4587
|
|
|
4588
4588
|
> **writeHead**(`res`, `statusCode`, `headers?`): `void`
|
|
4589
4589
|
|
|
4590
|
-
Defined in: [lib/core.ts:
|
|
4590
|
+
Defined in: [lib/core.ts:1247](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1247)
|
|
4591
4591
|
|
|
4592
4592
|
让 res 发送头部(前提是头部没有被发送才能调用本方法
|
|
4593
4593
|
|
|
@@ -4628,7 +4628,7 @@ lib/core/functions/write.md
|
|
|
4628
4628
|
|
|
4629
4629
|
> **write**(`res`, `data`): `void`
|
|
4630
4630
|
|
|
4631
|
-
Defined in: [lib/core.ts:
|
|
4631
|
+
Defined in: [lib/core.ts:1270](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1270)
|
|
4632
4632
|
|
|
4633
4633
|
向 res 发送数据
|
|
4634
4634
|
|
|
@@ -4800,7 +4800,7 @@ lib/core/interfaces/ILogOptions.md
|
|
|
4800
4800
|
|
|
4801
4801
|
# Interface: ILogOptions
|
|
4802
4802
|
|
|
4803
|
-
Defined in: [lib/core.ts:
|
|
4803
|
+
Defined in: [lib/core.ts:971](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L971)
|
|
4804
4804
|
|
|
4805
4805
|
log 设置的选项
|
|
4806
4806
|
|
|
@@ -4810,7 +4810,7 @@ log 设置的选项
|
|
|
4810
4810
|
|
|
4811
4811
|
> `optional` **cookie?**: `Record`\<`string`, `string`\>
|
|
4812
4812
|
|
|
4813
|
-
Defined in: [lib/core.ts:
|
|
4813
|
+
Defined in: [lib/core.ts:977](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L977)
|
|
4814
4814
|
|
|
4815
4815
|
***
|
|
4816
4816
|
|
|
@@ -4818,7 +4818,7 @@ Defined in: [lib/core.ts:959](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4818
4818
|
|
|
4819
4819
|
> `optional` **get?**: `Record`\<`string`, `any`\>
|
|
4820
4820
|
|
|
4821
|
-
Defined in: [lib/core.ts:
|
|
4821
|
+
Defined in: [lib/core.ts:976](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L976)
|
|
4822
4822
|
|
|
4823
4823
|
***
|
|
4824
4824
|
|
|
@@ -4826,7 +4826,7 @@ Defined in: [lib/core.ts:958](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4826
4826
|
|
|
4827
4827
|
> `optional` **headers?**: `IncomingHttpHeaders`
|
|
4828
4828
|
|
|
4829
|
-
Defined in: [lib/core.ts:
|
|
4829
|
+
Defined in: [lib/core.ts:979](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L979)
|
|
4830
4830
|
|
|
4831
4831
|
***
|
|
4832
4832
|
|
|
@@ -4834,7 +4834,7 @@ Defined in: [lib/core.ts:961](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4834
4834
|
|
|
4835
4835
|
> `optional` **hostname?**: `string`
|
|
4836
4836
|
|
|
4837
|
-
Defined in: [lib/core.ts:
|
|
4837
|
+
Defined in: [lib/core.ts:974](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L974)
|
|
4838
4838
|
|
|
4839
4839
|
***
|
|
4840
4840
|
|
|
@@ -4842,7 +4842,7 @@ Defined in: [lib/core.ts:956](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4842
4842
|
|
|
4843
4843
|
> `optional` **path?**: `string`
|
|
4844
4844
|
|
|
4845
|
-
Defined in: [lib/core.ts:
|
|
4845
|
+
Defined in: [lib/core.ts:972](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L972)
|
|
4846
4846
|
|
|
4847
4847
|
***
|
|
4848
4848
|
|
|
@@ -4850,7 +4850,7 @@ Defined in: [lib/core.ts:954](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4850
4850
|
|
|
4851
4851
|
> `optional` **req?**: `IncomingMessage` \| `Http2ServerRequest` \| `null`
|
|
4852
4852
|
|
|
4853
|
-
Defined in: [lib/core.ts:
|
|
4853
|
+
Defined in: [lib/core.ts:975](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L975)
|
|
4854
4854
|
|
|
4855
4855
|
***
|
|
4856
4856
|
|
|
@@ -4858,7 +4858,7 @@ Defined in: [lib/core.ts:957](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4858
4858
|
|
|
4859
4859
|
> `optional` **session?**: `Record`\<`string`, `any`\>
|
|
4860
4860
|
|
|
4861
|
-
Defined in: [lib/core.ts:
|
|
4861
|
+
Defined in: [lib/core.ts:978](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L978)
|
|
4862
4862
|
|
|
4863
4863
|
***
|
|
4864
4864
|
|
|
@@ -4866,7 +4866,7 @@ Defined in: [lib/core.ts:960](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4866
4866
|
|
|
4867
4867
|
> `optional` **urlFull?**: `string`
|
|
4868
4868
|
|
|
4869
|
-
Defined in: [lib/core.ts:
|
|
4869
|
+
Defined in: [lib/core.ts:973](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L973)
|
|
4870
4870
|
|
|
4871
4871
|
lib/core/type-aliases/TPm2Action.md
|
|
4872
4872
|
---
|
|
@@ -4881,7 +4881,7 @@ lib/core/type-aliases/TPm2Action.md
|
|
|
4881
4881
|
|
|
4882
4882
|
> **TPm2Action** = `"start"` \| `"stop"` \| `"restart"`
|
|
4883
4883
|
|
|
4884
|
-
Defined in: [lib/core.ts:
|
|
4884
|
+
Defined in: [lib/core.ts:648](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L648)
|
|
4885
4885
|
|
|
4886
4886
|
PM2 操作类型
|
|
4887
4887
|
|
|
@@ -4955,7 +4955,7 @@ lib/core/variables/global.md
|
|
|
4955
4955
|
|
|
4956
4956
|
> `const` **global**: `Record`\<`string`, `any`\> = `{}`
|
|
4957
4957
|
|
|
4958
|
-
Defined in: [lib/core.ts:
|
|
4958
|
+
Defined in: [lib/core.ts:747](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L747)
|
|
4959
4959
|
|
|
4960
4960
|
跨进程全局变量
|
|
4961
4961
|
|
|
@@ -5125,7 +5125,7 @@ lib/core/variables/REAL_IP_CF.md
|
|
|
5125
5125
|
|
|
5126
5126
|
> `const` **REAL\_IP\_CF**: `"cf-connecting-ip"` = `'cf-connecting-ip'`
|
|
5127
5127
|
|
|
5128
|
-
Defined in: [lib/core.ts:
|
|
5128
|
+
Defined in: [lib/core.ts:400](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L400)
|
|
5129
5129
|
|
|
5130
5130
|
使用的是 Cloudflare
|
|
5131
5131
|
|
|
@@ -5142,7 +5142,7 @@ lib/core/variables/REAL_IP_X.md
|
|
|
5142
5142
|
|
|
5143
5143
|
> `const` **REAL\_IP\_X**: `"x-forwarded-for"` = `'x-forwarded-for'`
|
|
5144
5144
|
|
|
5145
|
-
Defined in: [lib/core.ts:
|
|
5145
|
+
Defined in: [lib/core.ts:398](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L398)
|
|
5146
5146
|
|
|
5147
5147
|
使用 X-Forwarded-For 的 CDN 厂商
|
|
5148
5148
|
|
|
@@ -13963,7 +13963,7 @@ Defined in: [lib/sql.ts:42](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
13963
13963
|
|
|
13964
13964
|
> **new Sql**(`opt`): `Sql`
|
|
13965
13965
|
|
|
13966
|
-
Defined in: [lib/sql.ts:
|
|
13966
|
+
Defined in: [lib/sql.ts:72](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L72)
|
|
13967
13967
|
|
|
13968
13968
|
#### Parameters
|
|
13969
13969
|
|
|
@@ -14005,7 +14005,7 @@ Defined in: [lib/sql.ts:69](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
14005
14005
|
|
|
14006
14006
|
> **append**(`sql`): `this`
|
|
14007
14007
|
|
|
14008
|
-
Defined in: [lib/sql.ts:
|
|
14008
|
+
Defined in: [lib/sql.ts:1041](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1041)
|
|
14009
14009
|
|
|
14010
14010
|
在 sql 最后追加字符串
|
|
14011
14011
|
|
|
@@ -14025,7 +14025,7 @@ Defined in: [lib/sql.ts:1006](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
14025
14025
|
|
|
14026
14026
|
> **by**(`c`, `d?`): `this`
|
|
14027
14027
|
|
|
14028
|
-
Defined in: [lib/sql.ts:
|
|
14028
|
+
Defined in: [lib/sql.ts:793](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L793)
|
|
14029
14029
|
|
|
14030
14030
|
ORDER BY
|
|
14031
14031
|
|
|
@@ -14053,7 +14053,7 @@ ORDER BY
|
|
|
14053
14053
|
|
|
14054
14054
|
> **copy**(`f?`, `opt?`): `Sql`
|
|
14055
14055
|
|
|
14056
|
-
Defined in: [lib/sql.ts:
|
|
14056
|
+
Defined in: [lib/sql.ts:861](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L861)
|
|
14057
14057
|
|
|
14058
14058
|
创建一个本对象的一个新的 sql 对象拷贝
|
|
14059
14059
|
|
|
@@ -14081,7 +14081,7 @@ Defined in: [lib/sql.ts:830](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14081
14081
|
|
|
14082
14082
|
> **crossJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14083
14083
|
|
|
14084
|
-
Defined in: [lib/sql.ts:
|
|
14084
|
+
Defined in: [lib/sql.ts:522](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L522)
|
|
14085
14085
|
|
|
14086
14086
|
cross join 方法
|
|
14087
14087
|
|
|
@@ -14121,7 +14121,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14121
14121
|
|
|
14122
14122
|
> **delete**(`f`): `this`
|
|
14123
14123
|
|
|
14124
|
-
Defined in: [lib/sql.ts:
|
|
14124
|
+
Defined in: [lib/sql.ts:410](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L410)
|
|
14125
14125
|
|
|
14126
14126
|
'xx'
|
|
14127
14127
|
|
|
@@ -14143,7 +14143,7 @@ Defined in: [lib/sql.ts:379](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14143
14143
|
|
|
14144
14144
|
> **field**(`str`, `pre?`, `suf?`): `string`
|
|
14145
14145
|
|
|
14146
|
-
Defined in: [lib/sql.ts:
|
|
14146
|
+
Defined in: [lib/sql.ts:1052](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1052)
|
|
14147
14147
|
|
|
14148
14148
|
对字段进行包裹
|
|
14149
14149
|
|
|
@@ -14175,7 +14175,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅请在 field 表名时
|
|
|
14175
14175
|
|
|
14176
14176
|
> **format**(`sql?`, `data?`): `string`
|
|
14177
14177
|
|
|
14178
|
-
Defined in: [lib/sql.ts:
|
|
14178
|
+
Defined in: [lib/sql.ts:1031](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1031)
|
|
14179
14179
|
|
|
14180
14180
|
获取带 data 的 sql 语句
|
|
14181
14181
|
|
|
@@ -14199,7 +14199,7 @@ Defined in: [lib/sql.ts:996](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14199
14199
|
|
|
14200
14200
|
> **fullJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14201
14201
|
|
|
14202
|
-
Defined in: [lib/sql.ts:
|
|
14202
|
+
Defined in: [lib/sql.ts:511](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L511)
|
|
14203
14203
|
|
|
14204
14204
|
full join 方法
|
|
14205
14205
|
|
|
@@ -14239,7 +14239,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14239
14239
|
|
|
14240
14240
|
> **getData**(): [`DbValue`](../../../index/type-aliases/DbValue.md)[]
|
|
14241
14241
|
|
|
14242
|
-
Defined in: [lib/sql.ts:
|
|
14242
|
+
Defined in: [lib/sql.ts:1015](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1015)
|
|
14243
14243
|
|
|
14244
14244
|
获取全部 data
|
|
14245
14245
|
|
|
@@ -14253,7 +14253,7 @@ Defined in: [lib/sql.ts:980](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14253
14253
|
|
|
14254
14254
|
> **getPre**(): `string`
|
|
14255
14255
|
|
|
14256
|
-
Defined in: [lib/sql.ts:
|
|
14256
|
+
Defined in: [lib/sql.ts:1022](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1022)
|
|
14257
14257
|
|
|
14258
14258
|
获取定义的 pre
|
|
14259
14259
|
|
|
@@ -14267,7 +14267,7 @@ Defined in: [lib/sql.ts:987](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14267
14267
|
|
|
14268
14268
|
> **getSql**(): `string`
|
|
14269
14269
|
|
|
14270
|
-
Defined in: [lib/sql.ts:
|
|
14270
|
+
Defined in: [lib/sql.ts:995](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L995)
|
|
14271
14271
|
|
|
14272
14272
|
获取 sql 语句
|
|
14273
14273
|
|
|
@@ -14281,7 +14281,7 @@ Defined in: [lib/sql.ts:964](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14281
14281
|
|
|
14282
14282
|
> **group**(`c`): `this`
|
|
14283
14283
|
|
|
14284
|
-
Defined in: [lib/sql.ts:
|
|
14284
|
+
Defined in: [lib/sql.ts:817](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L817)
|
|
14285
14285
|
|
|
14286
14286
|
GROUP BY
|
|
14287
14287
|
|
|
@@ -14303,7 +14303,7 @@ GROUP BY
|
|
|
14303
14303
|
|
|
14304
14304
|
> **having**(`s?`): `this`
|
|
14305
14305
|
|
|
14306
|
-
Defined in: [lib/sql.ts:
|
|
14306
|
+
Defined in: [lib/sql.ts:529](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L529)
|
|
14307
14307
|
|
|
14308
14308
|
having 后置筛选器,用法类似 where
|
|
14309
14309
|
|
|
@@ -14319,11 +14319,56 @@ having 后置筛选器,用法类似 where
|
|
|
14319
14319
|
|
|
14320
14320
|
***
|
|
14321
14321
|
|
|
14322
|
+
### hint()
|
|
14323
|
+
|
|
14324
|
+
> **hint**(`h`): `this`
|
|
14325
|
+
|
|
14326
|
+
Defined in: [lib/sql.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L118)
|
|
14327
|
+
|
|
14328
|
+
设置 MySQL 优化器 Hint
|
|
14329
|
+
会以 Optimizer Hint 注释语法注入到 SELECT 关键字后
|
|
14330
|
+
传入 hint 内容即可,无需包裹注释符号
|
|
14331
|
+
|
|
14332
|
+
#### Parameters
|
|
14333
|
+
|
|
14334
|
+
##### h
|
|
14335
|
+
|
|
14336
|
+
`string`
|
|
14337
|
+
|
|
14338
|
+
Hint 内容
|
|
14339
|
+
|
|
14340
|
+
#### Returns
|
|
14341
|
+
|
|
14342
|
+
`this`
|
|
14343
|
+
|
|
14344
|
+
#### Example
|
|
14345
|
+
|
|
14346
|
+
```ts
|
|
14347
|
+
// --- 强制走指定索引(最常用)
|
|
14348
|
+
INDEX(`supply_date_0_0` `idx_supply_date_query`)
|
|
14349
|
+
|
|
14350
|
+
// --- 指定某表不用某索引
|
|
14351
|
+
NO_INDEX(`supply_date_0_0` `idx_old`)
|
|
14352
|
+
|
|
14353
|
+
// --- 指定 JOIN 顺序和索引
|
|
14354
|
+
JOIN_ORDER(`a` `b`) INDEX(`a` `idx_a`) INDEX(`b` `idx_b`)
|
|
14355
|
+
|
|
14356
|
+
// --- 指定 JOIN 中某表使用的索引
|
|
14357
|
+
JOIN_INDEX(`supply_date_0_0` `idx_supply_date_query`)
|
|
14358
|
+
|
|
14359
|
+
// --- 多表多索引组合
|
|
14360
|
+
INDEX(`t1` `idx_a`) JOIN_INDEX(`t2` `idx_b`)
|
|
14361
|
+
|
|
14362
|
+
// --- 官方文档: https://dev.mysql.com/doc/refman/8.0/en/optimizer-hints.html
|
|
14363
|
+
```
|
|
14364
|
+
|
|
14365
|
+
***
|
|
14366
|
+
|
|
14322
14367
|
### innerJoin()
|
|
14323
14368
|
|
|
14324
14369
|
> **innerJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14325
14370
|
|
|
14326
|
-
Defined in: [lib/sql.ts:
|
|
14371
|
+
Defined in: [lib/sql.ts:500](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L500)
|
|
14327
14372
|
|
|
14328
14373
|
inner join 方法
|
|
14329
14374
|
|
|
@@ -14363,7 +14408,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14363
14408
|
|
|
14364
14409
|
> **insert**(`table`, `ignore?`): `this`
|
|
14365
14410
|
|
|
14366
|
-
Defined in: [lib/sql.ts:
|
|
14411
|
+
Defined in: [lib/sql.ts:130](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L130)
|
|
14367
14412
|
|
|
14368
14413
|
插入数据前导
|
|
14369
14414
|
|
|
@@ -14391,7 +14436,7 @@ Defined in: [lib/sql.ts:99](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
14391
14436
|
|
|
14392
14437
|
> **join**(`f`, `s?`, `type?`, `suf?`, `pre?`): `this`
|
|
14393
14438
|
|
|
14394
|
-
Defined in: [lib/sql.ts:
|
|
14439
|
+
Defined in: [lib/sql.ts:452](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L452)
|
|
14395
14440
|
|
|
14396
14441
|
join 方法
|
|
14397
14442
|
|
|
@@ -14437,7 +14482,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14437
14482
|
|
|
14438
14483
|
> **leftJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14439
14484
|
|
|
14440
|
-
Defined in: [lib/sql.ts:
|
|
14485
|
+
Defined in: [lib/sql.ts:478](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L478)
|
|
14441
14486
|
|
|
14442
14487
|
left join 方法
|
|
14443
14488
|
|
|
@@ -14477,7 +14522,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14477
14522
|
|
|
14478
14523
|
> **limit**(`a`, `b?`): `this`
|
|
14479
14524
|
|
|
14480
|
-
Defined in: [lib/sql.ts:
|
|
14525
|
+
Defined in: [lib/sql.ts:837](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L837)
|
|
14481
14526
|
|
|
14482
14527
|
LIMIT(limit、offset, limit)
|
|
14483
14528
|
|
|
@@ -14505,7 +14550,7 @@ LIMIT(limit、offset, limit)
|
|
|
14505
14550
|
|
|
14506
14551
|
> **lock**(): `this`
|
|
14507
14552
|
|
|
14508
|
-
Defined in: [lib/sql.ts:
|
|
14553
|
+
Defined in: [lib/sql.ts:852](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L852)
|
|
14509
14554
|
|
|
14510
14555
|
追加消极锁,通常不建议使用
|
|
14511
14556
|
|
|
@@ -14519,7 +14564,7 @@ Defined in: [lib/sql.ts:821](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14519
14564
|
|
|
14520
14565
|
> **rightJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14521
14566
|
|
|
14522
|
-
Defined in: [lib/sql.ts:
|
|
14567
|
+
Defined in: [lib/sql.ts:489](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L489)
|
|
14523
14568
|
|
|
14524
14569
|
right join 方法
|
|
14525
14570
|
|
|
@@ -14559,7 +14604,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14559
14604
|
|
|
14560
14605
|
> **select**(`c`, `f`): `this`
|
|
14561
14606
|
|
|
14562
|
-
Defined in: [lib/sql.ts:
|
|
14607
|
+
Defined in: [lib/sql.ts:301](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L301)
|
|
14563
14608
|
|
|
14564
14609
|
'*', 'xx'
|
|
14565
14610
|
|
|
@@ -14587,7 +14632,7 @@ Defined in: [lib/sql.ts:270](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14587
14632
|
|
|
14588
14633
|
> **union**(`lsql`, `type?`): `this`
|
|
14589
14634
|
|
|
14590
|
-
Defined in: [lib/sql.ts:
|
|
14635
|
+
Defined in: [lib/sql.ts:422](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L422)
|
|
14591
14636
|
|
|
14592
14637
|
联查另一个 sql 对象
|
|
14593
14638
|
|
|
@@ -14615,7 +14660,7 @@ sql 对象
|
|
|
14615
14660
|
|
|
14616
14661
|
> **unionAll**(`lsql`): `this`
|
|
14617
14662
|
|
|
14618
|
-
Defined in: [lib/sql.ts:
|
|
14663
|
+
Defined in: [lib/sql.ts:440](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L440)
|
|
14619
14664
|
|
|
14620
14665
|
所有联查另一个 sql 对象
|
|
14621
14666
|
|
|
@@ -14637,7 +14682,7 @@ sql 对象
|
|
|
14637
14682
|
|
|
14638
14683
|
> **update**(`f`, `s`): `this`
|
|
14639
14684
|
|
|
14640
|
-
Defined in: [lib/sql.ts:
|
|
14685
|
+
Defined in: [lib/sql.ts:342](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L342)
|
|
14641
14686
|
|
|
14642
14687
|
UPDATE SQL 方法
|
|
14643
14688
|
|
|
@@ -14665,7 +14710,7 @@ UPDATE SQL 方法
|
|
|
14665
14710
|
|
|
14666
14711
|
> **updateByValues**(`table`, `key`, `cols`, `rows`): `this`
|
|
14667
14712
|
|
|
14668
|
-
Defined in: [lib/sql.ts:
|
|
14713
|
+
Defined in: [lib/sql.ts:246](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L246)
|
|
14669
14714
|
|
|
14670
14715
|
批量 UPDATE,以子查询作为数据源,纯更新语义(不会插入新行)
|
|
14671
14716
|
MySQL: UPDATE t INNER JOIN (SELECT col AS alias ... UNION ALL SELECT ...) AS tmp ON t.key=tmp.key SET t.c=tmp.c
|
|
@@ -14708,7 +14753,7 @@ PostgreSQL: UPDATE t SET c=tmp.c FROM (VALUES ($1,...)) AS tmp(cols) WHERE t.key
|
|
|
14708
14753
|
|
|
14709
14754
|
> **upsert**(`data`, `conflict?`): `this`
|
|
14710
14755
|
|
|
14711
|
-
Defined in: [lib/sql.ts:
|
|
14756
|
+
Defined in: [lib/sql.ts:207](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L207)
|
|
14712
14757
|
|
|
14713
14758
|
如果存在则更新不存在则插入(UPSERT)
|
|
14714
14759
|
|
|
@@ -14736,7 +14781,7 @@ Defined in: [lib/sql.ts:176](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14736
14781
|
|
|
14737
14782
|
> **values**(`cs`, `vs?`): `this`
|
|
14738
14783
|
|
|
14739
|
-
Defined in: [lib/sql.ts:
|
|
14784
|
+
Defined in: [lib/sql.ts:149](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L149)
|
|
14740
14785
|
|
|
14741
14786
|
实际插入数据的数据
|
|
14742
14787
|
|
|
@@ -14764,7 +14809,7 @@ Defined in: [lib/sql.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14764
14809
|
|
|
14765
14810
|
> **where**(`s`): `this`
|
|
14766
14811
|
|
|
14767
|
-
Defined in: [lib/sql.ts:
|
|
14812
|
+
Defined in: [lib/sql.ts:563](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L563)
|
|
14768
14813
|
|
|
14769
14814
|
筛选器
|
|
14770
14815
|
1. 'city': 'bj', 'type': '2'
|
|
@@ -14907,7 +14952,7 @@ lib/sql/functions/aoMix.md
|
|
|
14907
14952
|
|
|
14908
14953
|
> **aoMix**(`arr`): `Record`\<`string`, `string` \| `number` \| [`Json`](../../../index/type-aliases/Json.md)\>
|
|
14909
14954
|
|
|
14910
|
-
Defined in: [lib/sql.ts:
|
|
14955
|
+
Defined in: [lib/sql.ts:1437](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1437)
|
|
14911
14956
|
|
|
14912
14957
|
将数组兑换为组合的对象(Array/Object mix)
|
|
14913
14958
|
|
|
@@ -14936,7 +14981,7 @@ lib/sql/functions/column.md
|
|
|
14936
14981
|
|
|
14937
14982
|
> **column**(`field`): `object`
|
|
14938
14983
|
|
|
14939
|
-
Defined in: [lib/sql.ts:
|
|
14984
|
+
Defined in: [lib/sql.ts:1458](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1458)
|
|
14940
14985
|
|
|
14941
14986
|
创建字段对象
|
|
14942
14987
|
|
|
@@ -14975,7 +15020,7 @@ lib/sql/functions/format.md
|
|
|
14975
15020
|
|
|
14976
15021
|
> **format**(`sql`, `data`, `service?`): `string`
|
|
14977
15022
|
|
|
14978
|
-
Defined in: [lib/sql.ts:
|
|
15023
|
+
Defined in: [lib/sql.ts:1399](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1399)
|
|
14979
15024
|
|
|
14980
15025
|
返回代入后的完整 SQL 字符串,这并不安全不能直接执行,只是用来调试打印 sql 语句
|
|
14981
15026
|
|
|
@@ -15016,7 +15061,7 @@ lib/sql/functions/get.md
|
|
|
15016
15061
|
|
|
15017
15062
|
> **get**(`opt`): [`Sql`](../classes/Sql.md)
|
|
15018
15063
|
|
|
15019
|
-
Defined in: [lib/sql.ts:
|
|
15064
|
+
Defined in: [lib/sql.ts:1371](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1371)
|
|
15020
15065
|
|
|
15021
15066
|
创建 sql 对象
|
|
15022
15067
|
|
|
@@ -15069,7 +15114,7 @@ lib/sql/functions/json.md
|
|
|
15069
15114
|
|
|
15070
15115
|
> **json**\<`T`\>(`obj`): `T`
|
|
15071
15116
|
|
|
15072
|
-
Defined in: [lib/sql.ts:
|
|
15117
|
+
Defined in: [lib/sql.ts:1496](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1496)
|
|
15073
15118
|
|
|
15074
15119
|
将对象转换为 JSON 字符串并避开类型检查,用于适配 PostgreSQL 的 jsonb 字段
|
|
15075
15120
|
|
|
@@ -15104,7 +15149,7 @@ lib/sql/functions/value.md
|
|
|
15104
15149
|
|
|
15105
15150
|
> **value**(`val`): `object`
|
|
15106
15151
|
|
|
15107
|
-
Defined in: [lib/sql.ts:
|
|
15152
|
+
Defined in: [lib/sql.ts:1477](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1477)
|
|
15108
15153
|
|
|
15109
15154
|
创建字面量值对象,用于 where 条件中 v[0] 需要是值而非字段名的场景
|
|
15110
15155
|
例:[value('hello'), 'IN', column('tags')]
|
|
@@ -23136,12 +23181,24 @@ Defined in: [sys/ctr.ts:1102](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23136
23181
|
|
|
23137
23182
|
允许的文件扩展名(含点号),如 ['.jpg', '.png', '.pdf']
|
|
23138
23183
|
|
|
23184
|
+
###### maxFieldSize?
|
|
23185
|
+
|
|
23186
|
+
`number`
|
|
23187
|
+
|
|
23188
|
+
单个字段(非文件)最大字节数,默认 1 MB
|
|
23189
|
+
|
|
23139
23190
|
###### maxFileSize?
|
|
23140
23191
|
|
|
23141
23192
|
`number`
|
|
23142
23193
|
|
|
23143
23194
|
单个文件最大字节数
|
|
23144
23195
|
|
|
23196
|
+
###### timeout?
|
|
23197
|
+
|
|
23198
|
+
`number`
|
|
23199
|
+
|
|
23200
|
+
整体请求超时时间(毫秒),默认 5 分钟,设为 0 禁用超时
|
|
23201
|
+
|
|
23145
23202
|
#### Returns
|
|
23146
23203
|
|
|
23147
23204
|
`Promise`\<`boolean`\>
|
|
@@ -23984,6 +24041,12 @@ Defined in: [sys/mod.ts:116](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
23984
24041
|
|
|
23985
24042
|
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
23986
24043
|
|
|
24044
|
+
###### hint?
|
|
24045
|
+
|
|
24046
|
+
`string`
|
|
24047
|
+
|
|
24048
|
+
MySQL 优化器 Hint,如 `INDEX(\`t\` \`idx_xx\`)`,注入到 SELECT 后
|
|
24049
|
+
|
|
23987
24050
|
###### index?
|
|
23988
24051
|
|
|
23989
24052
|
`string` \| `string`[]
|
|
@@ -24158,7 +24221,7 @@ Defined in: [sys/mod.ts:68](https://github.com/maiyunnet/kebab/blob/master/sys/m
|
|
|
24158
24221
|
|
|
24159
24222
|
> `protected` **\_keyGenerator**(): `string`
|
|
24160
24223
|
|
|
24161
|
-
Defined in: [sys/mod.ts:
|
|
24224
|
+
Defined in: [sys/mod.ts:1843](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1843)
|
|
24162
24225
|
|
|
24163
24226
|
当 _key 不为空时,则依据继承此方法的方法自动生成填充 key
|
|
24164
24227
|
|
|
@@ -24182,7 +24245,7 @@ Defined in: [sys/mod.ts:1797](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24182
24245
|
|
|
24183
24246
|
> **all**(): `Promise`\<`false` \| [`Rows`](Rows.md)\<`Mod`\>\>
|
|
24184
24247
|
|
|
24185
|
-
Defined in: [sys/mod.ts:
|
|
24248
|
+
Defined in: [sys/mod.ts:1157](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1157)
|
|
24186
24249
|
|
|
24187
24250
|
##### Returns
|
|
24188
24251
|
|
|
@@ -24192,7 +24255,7 @@ Defined in: [sys/mod.ts:1139](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24192
24255
|
|
|
24193
24256
|
> **all**(`key`): `Promise`\<`false` \| `Record`\<`string`, `Mod`\>\>
|
|
24194
24257
|
|
|
24195
|
-
Defined in: [sys/mod.ts:
|
|
24258
|
+
Defined in: [sys/mod.ts:1158](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1158)
|
|
24196
24259
|
|
|
24197
24260
|
##### Parameters
|
|
24198
24261
|
|
|
@@ -24220,7 +24283,7 @@ Defined in: [sys/mod.ts:1140](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24220
24283
|
|
|
24221
24284
|
> **allArray**(): `Promise`\<`false` \| `Record`\<`string`, `any`\>[]\>
|
|
24222
24285
|
|
|
24223
|
-
Defined in: [sys/mod.ts:
|
|
24286
|
+
Defined in: [sys/mod.ts:1336](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1336)
|
|
24224
24287
|
|
|
24225
24288
|
##### Returns
|
|
24226
24289
|
|
|
@@ -24230,7 +24293,7 @@ Defined in: [sys/mod.ts:1318](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24230
24293
|
|
|
24231
24294
|
> **allArray**(`key`): `Promise`\<`false` \| `Record`\<`string`, `Record`\<`string`, `any`\>\>\>
|
|
24232
24295
|
|
|
24233
|
-
Defined in: [sys/mod.ts:
|
|
24296
|
+
Defined in: [sys/mod.ts:1337](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1337)
|
|
24234
24297
|
|
|
24235
24298
|
##### Parameters
|
|
24236
24299
|
|
|
@@ -24248,7 +24311,7 @@ Defined in: [sys/mod.ts:1319](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24248
24311
|
|
|
24249
24312
|
> **append**(`sql`): `this`
|
|
24250
24313
|
|
|
24251
|
-
Defined in: [sys/mod.ts:
|
|
24314
|
+
Defined in: [sys/mod.ts:1752](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1752)
|
|
24252
24315
|
|
|
24253
24316
|
在 sql 最后追加字符串
|
|
24254
24317
|
|
|
@@ -24268,7 +24331,7 @@ Defined in: [sys/mod.ts:1706](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24268
24331
|
|
|
24269
24332
|
> **by**(`c`, `d?`): `this`
|
|
24270
24333
|
|
|
24271
|
-
Defined in: [sys/mod.ts:
|
|
24334
|
+
Defined in: [sys/mod.ts:1708](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1708)
|
|
24272
24335
|
|
|
24273
24336
|
ORDER BY
|
|
24274
24337
|
|
|
@@ -24296,7 +24359,7 @@ ORDER BY
|
|
|
24296
24359
|
|
|
24297
24360
|
> **contain**(`contain`): `this`
|
|
24298
24361
|
|
|
24299
|
-
Defined in: [sys/mod.ts:
|
|
24362
|
+
Defined in: [sys/mod.ts:1761](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1761)
|
|
24300
24363
|
|
|
24301
24364
|
设置闭包含数据
|
|
24302
24365
|
|
|
@@ -24324,7 +24387,7 @@ Defined in: [sys/mod.ts:1715](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24324
24387
|
|
|
24325
24388
|
> **count**(): `Promise`\<`number`\>
|
|
24326
24389
|
|
|
24327
|
-
Defined in: [sys/mod.ts:
|
|
24390
|
+
Defined in: [sys/mod.ts:1544](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1544)
|
|
24328
24391
|
|
|
24329
24392
|
根据当前条件,筛选出当前条目该有的数据条数
|
|
24330
24393
|
|
|
@@ -24338,7 +24401,7 @@ Defined in: [sys/mod.ts:1526](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24338
24401
|
|
|
24339
24402
|
> **countSql**(): `string`
|
|
24340
24403
|
|
|
24341
|
-
Defined in: [sys/mod.ts:
|
|
24404
|
+
Defined in: [sys/mod.ts:1565](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1565)
|
|
24342
24405
|
|
|
24343
24406
|
获取当前条件下的 count 的 SQL 语句
|
|
24344
24407
|
|
|
@@ -24352,7 +24415,7 @@ Defined in: [sys/mod.ts:1547](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24352
24415
|
|
|
24353
24416
|
> **create**(): `Promise`\<`boolean` \| `null`\>
|
|
24354
24417
|
|
|
24355
|
-
Defined in: [sys/mod.ts:
|
|
24418
|
+
Defined in: [sys/mod.ts:839](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L839)
|
|
24356
24419
|
|
|
24357
24420
|
创建数据
|
|
24358
24421
|
|
|
@@ -24368,7 +24431,7 @@ true-成功,false-报错,null-唯一键非 _$key 键冲突
|
|
|
24368
24431
|
|
|
24369
24432
|
> **crossJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24370
24433
|
|
|
24371
|
-
Defined in: [sys/mod.ts:
|
|
24434
|
+
Defined in: [sys/mod.ts:1640](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1640)
|
|
24372
24435
|
|
|
24373
24436
|
cross join 方法
|
|
24374
24437
|
|
|
@@ -24418,7 +24481,7 @@ ON 信息
|
|
|
24418
24481
|
|
|
24419
24482
|
> **explain**(`all?`): `Promise`\<`string` \| `false`\>
|
|
24420
24483
|
|
|
24421
|
-
Defined in: [sys/mod.ts:
|
|
24484
|
+
Defined in: [sys/mod.ts:1462](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1462)
|
|
24422
24485
|
|
|
24423
24486
|
##### Parameters
|
|
24424
24487
|
|
|
@@ -24434,7 +24497,7 @@ Defined in: [sys/mod.ts:1444](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24434
24497
|
|
|
24435
24498
|
> **explain**(`all`): `Promise`\<`false` \| `Record`\<`string`, `any`\>\>
|
|
24436
24499
|
|
|
24437
|
-
Defined in: [sys/mod.ts:
|
|
24500
|
+
Defined in: [sys/mod.ts:1463](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1463)
|
|
24438
24501
|
|
|
24439
24502
|
##### Parameters
|
|
24440
24503
|
|
|
@@ -24452,7 +24515,7 @@ Defined in: [sys/mod.ts:1445](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24452
24515
|
|
|
24453
24516
|
> **filter**(`s`): `this`
|
|
24454
24517
|
|
|
24455
|
-
Defined in: [sys/mod.ts:
|
|
24518
|
+
Defined in: [sys/mod.ts:1686](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1686)
|
|
24456
24519
|
|
|
24457
24520
|
筛选器
|
|
24458
24521
|
|
|
@@ -24490,7 +24553,7 @@ Defined in: [sys/mod.ts:1640](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24490
24553
|
|
|
24491
24554
|
> **first**(`lock`, `array`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
24492
24555
|
|
|
24493
|
-
Defined in: [sys/mod.ts:
|
|
24556
|
+
Defined in: [sys/mod.ts:1046](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1046)
|
|
24494
24557
|
|
|
24495
24558
|
##### Parameters
|
|
24496
24559
|
|
|
@@ -24510,7 +24573,7 @@ Defined in: [sys/mod.ts:1028](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24510
24573
|
|
|
24511
24574
|
> **first**(`lock?`, `array?`): `Promise`\<`false` \| `Mod` & `Record`\<`string`, `any`\> \| `null`\>
|
|
24512
24575
|
|
|
24513
|
-
Defined in: [sys/mod.ts:
|
|
24576
|
+
Defined in: [sys/mod.ts:1050](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1050)
|
|
24514
24577
|
|
|
24515
24578
|
##### Parameters
|
|
24516
24579
|
|
|
@@ -24532,7 +24595,7 @@ Defined in: [sys/mod.ts:1032](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24532
24595
|
|
|
24533
24596
|
> **firstArray**(`lock?`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
24534
24597
|
|
|
24535
|
-
Defined in: [sys/mod.ts:
|
|
24598
|
+
Defined in: [sys/mod.ts:1090](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1090)
|
|
24536
24599
|
|
|
24537
24600
|
获取数据库第一个原生对象
|
|
24538
24601
|
|
|
@@ -24554,7 +24617,7 @@ Defined in: [sys/mod.ts:1072](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24554
24617
|
|
|
24555
24618
|
> **format**(`sql?`, `data?`): `string`
|
|
24556
24619
|
|
|
24557
|
-
Defined in: [sys/mod.ts:
|
|
24620
|
+
Defined in: [sys/mod.ts:1788](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1788)
|
|
24558
24621
|
|
|
24559
24622
|
获取带 data 的 sql 语句
|
|
24560
24623
|
|
|
@@ -24582,7 +24645,7 @@ sql 语句
|
|
|
24582
24645
|
|
|
24583
24646
|
> **fullJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24584
24647
|
|
|
24585
|
-
Defined in: [sys/mod.ts:
|
|
24648
|
+
Defined in: [sys/mod.ts:1628](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1628)
|
|
24586
24649
|
|
|
24587
24650
|
full join 方法
|
|
24588
24651
|
|
|
@@ -24622,7 +24685,7 @@ ON 信息
|
|
|
24622
24685
|
|
|
24623
24686
|
> **get**(`n`): `any`
|
|
24624
24687
|
|
|
24625
|
-
Defined in: [sys/mod.ts:
|
|
24688
|
+
Defined in: [sys/mod.ts:831](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L831)
|
|
24626
24689
|
|
|
24627
24690
|
获取一个字段值
|
|
24628
24691
|
|
|
@@ -24644,7 +24707,7 @@ Defined in: [sys/mod.ts:813](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24644
24707
|
|
|
24645
24708
|
> **getData**(): `any`[]
|
|
24646
24709
|
|
|
24647
|
-
Defined in: [sys/mod.ts:
|
|
24710
|
+
Defined in: [sys/mod.ts:1779](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1779)
|
|
24648
24711
|
|
|
24649
24712
|
获取全部 data
|
|
24650
24713
|
|
|
@@ -24658,7 +24721,7 @@ Defined in: [sys/mod.ts:1733](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24658
24721
|
|
|
24659
24722
|
> **getSql**(): `string`
|
|
24660
24723
|
|
|
24661
|
-
Defined in: [sys/mod.ts:
|
|
24724
|
+
Defined in: [sys/mod.ts:1772](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1772)
|
|
24662
24725
|
|
|
24663
24726
|
获取 sql 语句
|
|
24664
24727
|
|
|
@@ -24672,7 +24735,7 @@ Defined in: [sys/mod.ts:1726](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24672
24735
|
|
|
24673
24736
|
> **group**(`c`): `this`
|
|
24674
24737
|
|
|
24675
|
-
Defined in: [sys/mod.ts:
|
|
24738
|
+
Defined in: [sys/mod.ts:1717](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1717)
|
|
24676
24739
|
|
|
24677
24740
|
GROUP BY
|
|
24678
24741
|
|
|
@@ -24694,7 +24757,7 @@ GROUP BY
|
|
|
24694
24757
|
|
|
24695
24758
|
> **having**(`s`): `this`
|
|
24696
24759
|
|
|
24697
|
-
Defined in: [sys/mod.ts:
|
|
24760
|
+
Defined in: [sys/mod.ts:1677](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1677)
|
|
24698
24761
|
|
|
24699
24762
|
筛选器
|
|
24700
24763
|
|
|
@@ -24712,11 +24775,56 @@ Defined in: [sys/mod.ts:1631](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24712
24775
|
|
|
24713
24776
|
***
|
|
24714
24777
|
|
|
24778
|
+
### hint()
|
|
24779
|
+
|
|
24780
|
+
> **hint**(`h`): `this`
|
|
24781
|
+
|
|
24782
|
+
Defined in: [sys/mod.ts:1668](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1668)
|
|
24783
|
+
|
|
24784
|
+
设置 MySQL 优化器 Hint
|
|
24785
|
+
内容会以 Optimizer Hint 注释语法注入到 SELECT 关键字后
|
|
24786
|
+
必须在查询入口调用之后、执行方法之前链式调用
|
|
24787
|
+
|
|
24788
|
+
#### Parameters
|
|
24789
|
+
|
|
24790
|
+
##### h
|
|
24791
|
+
|
|
24792
|
+
`string`
|
|
24793
|
+
|
|
24794
|
+
Hint 内容
|
|
24795
|
+
|
|
24796
|
+
#### Returns
|
|
24797
|
+
|
|
24798
|
+
`this`
|
|
24799
|
+
|
|
24800
|
+
#### Example
|
|
24801
|
+
|
|
24802
|
+
```ts
|
|
24803
|
+
// 强制走指定索引(最常用)
|
|
24804
|
+
.hint("INDEX(`supply_date_0_0` `idx_supply_date_query`)")
|
|
24805
|
+
|
|
24806
|
+
// 指定某表不用某索引
|
|
24807
|
+
.hint("NO_INDEX(`supply_date_0_0` `idx_old`)")
|
|
24808
|
+
|
|
24809
|
+
// 指定 JOIN 顺序和索引
|
|
24810
|
+
.hint("JOIN_ORDER(`a` `b`) INDEX(`a` `idx_a`) INDEX(`b` `idx_b`)")
|
|
24811
|
+
|
|
24812
|
+
// 指定 JOIN 中某表使用的索引
|
|
24813
|
+
.hint("JOIN_INDEX(`supply_date_0_0` `idx_supply_date_query`)")
|
|
24814
|
+
|
|
24815
|
+
// 多表多索引组合
|
|
24816
|
+
.hint("INDEX(`t1` `idx_a`) JOIN_INDEX(`t2` `idx_b`)")
|
|
24817
|
+
|
|
24818
|
+
// 官方文档: https://dev.mysql.com/doc/refman/8.0/en/optimizer-hints.html
|
|
24819
|
+
```
|
|
24820
|
+
|
|
24821
|
+
***
|
|
24822
|
+
|
|
24715
24823
|
### innerJoin()
|
|
24716
24824
|
|
|
24717
24825
|
> **innerJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24718
24826
|
|
|
24719
|
-
Defined in: [sys/mod.ts:
|
|
24827
|
+
Defined in: [sys/mod.ts:1616](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1616)
|
|
24720
24828
|
|
|
24721
24829
|
inner join 方法
|
|
24722
24830
|
|
|
@@ -24756,7 +24864,7 @@ ON 信息
|
|
|
24756
24864
|
|
|
24757
24865
|
> **join**(`f`, `s?`, `type?`, `index?`, `pre?`): `this`
|
|
24758
24866
|
|
|
24759
|
-
Defined in: [sys/mod.ts:
|
|
24867
|
+
Defined in: [sys/mod.ts:1580](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1580)
|
|
24760
24868
|
|
|
24761
24869
|
#### Parameters
|
|
24762
24870
|
|
|
@@ -24800,7 +24908,7 @@ ON 信息
|
|
|
24800
24908
|
|
|
24801
24909
|
> **langText**(`col`, `lang`): `string`
|
|
24802
24910
|
|
|
24803
|
-
Defined in: [sys/mod.ts:
|
|
24911
|
+
Defined in: [sys/mod.ts:1823](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1823)
|
|
24804
24912
|
|
|
24805
24913
|
获取字段的可用语种文本
|
|
24806
24914
|
|
|
@@ -24828,7 +24936,7 @@ Defined in: [sys/mod.ts:1777](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24828
24936
|
|
|
24829
24937
|
> **leftJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24830
24938
|
|
|
24831
|
-
Defined in: [sys/mod.ts:
|
|
24939
|
+
Defined in: [sys/mod.ts:1592](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1592)
|
|
24832
24940
|
|
|
24833
24941
|
left join 方法
|
|
24834
24942
|
|
|
@@ -24868,7 +24976,7 @@ ON 信息
|
|
|
24868
24976
|
|
|
24869
24977
|
> **limit**(`a`, `b?`): `this`
|
|
24870
24978
|
|
|
24871
|
-
Defined in: [sys/mod.ts:
|
|
24979
|
+
Defined in: [sys/mod.ts:1730](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1730)
|
|
24872
24980
|
|
|
24873
24981
|
LIMIT
|
|
24874
24982
|
|
|
@@ -24896,7 +25004,7 @@ LIMIT
|
|
|
24896
25004
|
|
|
24897
25005
|
> **page**(`count`, `page?`): `this`
|
|
24898
25006
|
|
|
24899
|
-
Defined in: [sys/mod.ts:
|
|
25007
|
+
Defined in: [sys/mod.ts:1741](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1741)
|
|
24900
25008
|
|
|
24901
25009
|
分页
|
|
24902
25010
|
|
|
@@ -24924,7 +25032,7 @@ Defined in: [sys/mod.ts:1695](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24924
25032
|
|
|
24925
25033
|
> **refresh**(`lock?`): `Promise`\<`boolean` \| `null`\>
|
|
24926
25034
|
|
|
24927
|
-
Defined in: [sys/mod.ts:
|
|
25035
|
+
Defined in: [sys/mod.ts:959](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L959)
|
|
24928
25036
|
|
|
24929
25037
|
刷新当前模型获取最新数据
|
|
24930
25038
|
|
|
@@ -24946,7 +25054,7 @@ Defined in: [sys/mod.ts:941](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24946
25054
|
|
|
24947
25055
|
> **remove**(): `Promise`\<`boolean`\>
|
|
24948
25056
|
|
|
24949
|
-
Defined in: [sys/mod.ts:
|
|
25057
|
+
Defined in: [sys/mod.ts:1024](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1024)
|
|
24950
25058
|
|
|
24951
25059
|
移除本条目
|
|
24952
25060
|
|
|
@@ -24960,7 +25068,7 @@ Defined in: [sys/mod.ts:1006](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24960
25068
|
|
|
24961
25069
|
> **rightJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24962
25070
|
|
|
24963
|
-
Defined in: [sys/mod.ts:
|
|
25071
|
+
Defined in: [sys/mod.ts:1604](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1604)
|
|
24964
25072
|
|
|
24965
25073
|
right join 方法
|
|
24966
25074
|
|
|
@@ -25000,7 +25108,7 @@ ON 信息
|
|
|
25000
25108
|
|
|
25001
25109
|
> **save**(`where?`): `Promise`\<`boolean`\>
|
|
25002
25110
|
|
|
25003
|
-
Defined in: [sys/mod.ts:
|
|
25111
|
+
Defined in: [sys/mod.ts:991](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L991)
|
|
25004
25112
|
|
|
25005
25113
|
更新 set 的数据到数据库,有未保存数据时才保存
|
|
25006
25114
|
|
|
@@ -25038,7 +25146,7 @@ Defined in: [sys/mod.ts:973](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25038
25146
|
|
|
25039
25147
|
> **set**\<`T`, `TK`\>(`n`): `void`
|
|
25040
25148
|
|
|
25041
|
-
Defined in: [sys/mod.ts:
|
|
25149
|
+
Defined in: [sys/mod.ts:792](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L792)
|
|
25042
25150
|
|
|
25043
25151
|
##### Type Parameters
|
|
25044
25152
|
|
|
@@ -25064,7 +25172,7 @@ Defined in: [sys/mod.ts:774](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25064
25172
|
|
|
25065
25173
|
> **set**\<`T`, `TK`\>(`n`, `v`): `void`
|
|
25066
25174
|
|
|
25067
|
-
Defined in: [sys/mod.ts:
|
|
25175
|
+
Defined in: [sys/mod.ts:793](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L793)
|
|
25068
25176
|
|
|
25069
25177
|
##### Type Parameters
|
|
25070
25178
|
|
|
@@ -25096,7 +25204,7 @@ Defined in: [sys/mod.ts:775](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25096
25204
|
|
|
25097
25205
|
> **toArray**\<`TC`\>(): [`TOnlyProperties`](../type-aliases/TOnlyProperties.md)\<`InstanceType`\<`TC`\>\> & `Record`\<`string`, `any`\>
|
|
25098
25206
|
|
|
25099
|
-
Defined in: [sys/mod.ts:
|
|
25207
|
+
Defined in: [sys/mod.ts:1795](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1795)
|
|
25100
25208
|
|
|
25101
25209
|
获取值对象,获取的是新创建的数组
|
|
25102
25210
|
|
|
@@ -25116,7 +25224,7 @@ Defined in: [sys/mod.ts:1749](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25116
25224
|
|
|
25117
25225
|
> **total**(`f?`): `Promise`\<`number`\>
|
|
25118
25226
|
|
|
25119
|
-
Defined in: [sys/mod.ts:
|
|
25227
|
+
Defined in: [sys/mod.ts:1520](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1520)
|
|
25120
25228
|
|
|
25121
25229
|
获取总条数,自动抛弃 LIMIT,仅用于获取数据的情况(select)
|
|
25122
25230
|
|
|
@@ -25136,7 +25244,7 @@ Defined in: [sys/mod.ts:1502](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25136
25244
|
|
|
25137
25245
|
> **union**(`f`, `type?`): `this`
|
|
25138
25246
|
|
|
25139
|
-
Defined in: [sys/mod.ts:
|
|
25247
|
+
Defined in: [sys/mod.ts:1101](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1101)
|
|
25140
25248
|
|
|
25141
25249
|
联合查询表数据
|
|
25142
25250
|
|
|
@@ -25164,7 +25272,7 @@ Defined in: [sys/mod.ts:1083](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25164
25272
|
|
|
25165
25273
|
> **unionAll**(`f`): `this`
|
|
25166
25274
|
|
|
25167
|
-
Defined in: [sys/mod.ts:
|
|
25275
|
+
Defined in: [sys/mod.ts:1131](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1131)
|
|
25168
25276
|
|
|
25169
25277
|
所有联合查询表数据
|
|
25170
25278
|
|
|
@@ -25186,7 +25294,7 @@ Defined in: [sys/mod.ts:1113](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25186
25294
|
|
|
25187
25295
|
> **unsaved**(): `boolean`
|
|
25188
25296
|
|
|
25189
|
-
Defined in: [sys/mod.ts:
|
|
25297
|
+
Defined in: [sys/mod.ts:1814](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1814)
|
|
25190
25298
|
|
|
25191
25299
|
当前是否设置了未保存 --=
|
|
25192
25300
|
|
|
@@ -25200,7 +25308,7 @@ Defined in: [sys/mod.ts:1768](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25200
25308
|
|
|
25201
25309
|
> **updates**(): `Record`\<`string`, `any`\>
|
|
25202
25310
|
|
|
25203
|
-
Defined in: [sys/mod.ts:
|
|
25311
|
+
Defined in: [sys/mod.ts:1803](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1803)
|
|
25204
25312
|
|
|
25205
25313
|
获取当前设置要提交的数据
|
|
25206
25314
|
|
|
@@ -25214,7 +25322,7 @@ Defined in: [sys/mod.ts:1757](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25214
25322
|
|
|
25215
25323
|
> **upsert**(`conflict`): `Promise`\<`boolean`\>
|
|
25216
25324
|
|
|
25217
|
-
Defined in: [sys/mod.ts:
|
|
25325
|
+
Defined in: [sys/mod.ts:929](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L929)
|
|
25218
25326
|
|
|
25219
25327
|
插入数据,如果存在则更新(UPSERT)
|
|
25220
25328
|
|
|
@@ -25236,7 +25344,7 @@ Defined in: [sys/mod.ts:911](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25236
25344
|
|
|
25237
25345
|
> **where**(`s`): `this`
|
|
25238
25346
|
|
|
25239
|
-
Defined in: [sys/mod.ts:
|
|
25347
|
+
Defined in: [sys/mod.ts:1697](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1697)
|
|
25240
25348
|
|
|
25241
25349
|
是 filter 的别名
|
|
25242
25350
|
|
|
@@ -25258,7 +25366,7 @@ Defined in: [sys/mod.ts:1651](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25258
25366
|
|
|
25259
25367
|
> `static` **column**(`field`): `object`
|
|
25260
25368
|
|
|
25261
|
-
Defined in: [sys/mod.ts:
|
|
25369
|
+
Defined in: [sys/mod.ts:181](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L181)
|
|
25262
25370
|
|
|
25263
25371
|
创建字段对象
|
|
25264
25372
|
|
|
@@ -25290,7 +25398,7 @@ Defined in: [sys/mod.ts:175](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25290
25398
|
|
|
25291
25399
|
> `static` **find**\<`T`\>(`db`, `val`, `opt?`): `Promise`\<`false` \| `T` & `Record`\<`string`, `any`\> \| `null`\>
|
|
25292
25400
|
|
|
25293
|
-
Defined in: [sys/mod.ts:
|
|
25401
|
+
Defined in: [sys/mod.ts:607](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L607)
|
|
25294
25402
|
|
|
25295
25403
|
根据主键(或 key 字段)获取对象
|
|
25296
25404
|
|
|
@@ -25322,6 +25430,10 @@ Defined in: [sys/mod.ts:597](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25322
25430
|
|
|
25323
25431
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25324
25432
|
|
|
25433
|
+
###### hint?
|
|
25434
|
+
|
|
25435
|
+
`string`
|
|
25436
|
+
|
|
25325
25437
|
###### index?
|
|
25326
25438
|
|
|
25327
25439
|
`string` \| `string`[]
|
|
@@ -25350,7 +25462,7 @@ Defined in: [sys/mod.ts:597](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25350
25462
|
|
|
25351
25463
|
> `static` **getCreate**\<`T`\>(`db`, `opt?`): `T`
|
|
25352
25464
|
|
|
25353
|
-
Defined in: [sys/mod.ts:
|
|
25465
|
+
Defined in: [sys/mod.ts:589](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L589)
|
|
25354
25466
|
|
|
25355
25467
|
获取创建对象,通常用于新建数据库条目
|
|
25356
25468
|
|
|
@@ -25394,7 +25506,7 @@ Defined in: [sys/mod.ts:579](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25394
25506
|
|
|
25395
25507
|
> `static` **insert**(`db`, `cs`, `vs?`, `opt?`): `Promise`\<`boolean` \| `null`\>
|
|
25396
25508
|
|
|
25397
|
-
Defined in: [sys/mod.ts:
|
|
25509
|
+
Defined in: [sys/mod.ts:210](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L210)
|
|
25398
25510
|
|
|
25399
25511
|
添加一个序列(允许超过 65536 的占位符会被拆分多次执行)
|
|
25400
25512
|
|
|
@@ -25448,7 +25560,7 @@ Defined in: [sys/mod.ts:204](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25448
25560
|
|
|
25449
25561
|
> `static` **insertSql**(`db`, `cs`, `vs?`, `opt?`): `string`
|
|
25450
25562
|
|
|
25451
|
-
Defined in: [sys/mod.ts:
|
|
25563
|
+
Defined in: [sys/mod.ts:270](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L270)
|
|
25452
25564
|
|
|
25453
25565
|
获取添加一个序列的模拟 SQL
|
|
25454
25566
|
|
|
@@ -25502,7 +25614,7 @@ Defined in: [sys/mod.ts:264](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25502
25614
|
|
|
25503
25615
|
> `static` **json**\<`T`\>(`obj`): `T`
|
|
25504
25616
|
|
|
25505
|
-
Defined in: [sys/mod.ts:
|
|
25617
|
+
Defined in: [sys/mod.ts:199](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L199)
|
|
25506
25618
|
|
|
25507
25619
|
创建 JSON 字符串对象,用于 PGSQL 的 jsonb 字段
|
|
25508
25620
|
|
|
@@ -25550,7 +25662,7 @@ Defined in: [sys/mod.ts:193](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25550
25662
|
|
|
25551
25663
|
> `static` **one**(`db`, `s`, `opt`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
25552
25664
|
|
|
25553
|
-
Defined in: [sys/mod.ts:
|
|
25665
|
+
Defined in: [sys/mod.ts:636](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L636)
|
|
25554
25666
|
|
|
25555
25667
|
##### Parameters
|
|
25556
25668
|
|
|
@@ -25576,6 +25688,10 @@ Defined in: [sys/mod.ts:624](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25576
25688
|
|
|
25577
25689
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25578
25690
|
|
|
25691
|
+
###### hint?
|
|
25692
|
+
|
|
25693
|
+
`string`
|
|
25694
|
+
|
|
25579
25695
|
###### index?
|
|
25580
25696
|
|
|
25581
25697
|
`string` \| `string`[]
|
|
@@ -25600,7 +25716,7 @@ Defined in: [sys/mod.ts:624](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25600
25716
|
|
|
25601
25717
|
> `static` **one**\<`T`\>(`db`, `s`, `opt?`): `Promise`\<`false` \| `T` & `Record`\<`string`, `any`\> \| `null`\>
|
|
25602
25718
|
|
|
25603
|
-
Defined in: [sys/mod.ts:
|
|
25719
|
+
Defined in: [sys/mod.ts:650](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L650)
|
|
25604
25720
|
|
|
25605
25721
|
##### Type Parameters
|
|
25606
25722
|
|
|
@@ -25632,6 +25748,10 @@ Defined in: [sys/mod.ts:637](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25632
25748
|
|
|
25633
25749
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25634
25750
|
|
|
25751
|
+
###### hint?
|
|
25752
|
+
|
|
25753
|
+
`string`
|
|
25754
|
+
|
|
25635
25755
|
###### index?
|
|
25636
25756
|
|
|
25637
25757
|
`string` \| `string`[]
|
|
@@ -25658,7 +25778,7 @@ Defined in: [sys/mod.ts:637](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25658
25778
|
|
|
25659
25779
|
> `static` **oneArray**(`db`, `s`, `opt?`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
25660
25780
|
|
|
25661
|
-
Defined in: [sys/mod.ts:
|
|
25781
|
+
Defined in: [sys/mod.ts:731](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L731)
|
|
25662
25782
|
|
|
25663
25783
|
通过 where 条件筛选单条数据返回原生对象
|
|
25664
25784
|
|
|
@@ -25684,6 +25804,10 @@ Defined in: [sys/mod.ts:714](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25684
25804
|
|
|
25685
25805
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25686
25806
|
|
|
25807
|
+
###### hint?
|
|
25808
|
+
|
|
25809
|
+
`string`
|
|
25810
|
+
|
|
25687
25811
|
###### index?
|
|
25688
25812
|
|
|
25689
25813
|
`string` \| `string`[]
|
|
@@ -25710,7 +25834,7 @@ Defined in: [sys/mod.ts:714](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25710
25834
|
|
|
25711
25835
|
> `static` **primarys**(`db`, `where?`, `opt?`): `Promise`\<`false` \| `any`[]\>
|
|
25712
25836
|
|
|
25713
|
-
Defined in: [sys/mod.ts:
|
|
25837
|
+
Defined in: [sys/mod.ts:753](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L753)
|
|
25714
25838
|
|
|
25715
25839
|
根据 where 条件获取主键值列表
|
|
25716
25840
|
|
|
@@ -25754,7 +25878,7 @@ where 条件
|
|
|
25754
25878
|
|
|
25755
25879
|
> `static` **removeByWhere**(`db`, `where`, `opt?`): `Promise`\<`number` \| `false` \| `null`\>
|
|
25756
25880
|
|
|
25757
|
-
Defined in: [sys/mod.ts:
|
|
25881
|
+
Defined in: [sys/mod.ts:296](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L296)
|
|
25758
25882
|
|
|
25759
25883
|
根据条件移除条目
|
|
25760
25884
|
|
|
@@ -25806,7 +25930,7 @@ Defined in: [sys/mod.ts:290](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25806
25930
|
|
|
25807
25931
|
> `static` **removeByWhereSql**(`db`, `where`, `opt?`): [`Sql`](../../../lib/sql/classes/Sql.md)
|
|
25808
25932
|
|
|
25809
|
-
Defined in: [sys/mod.ts:
|
|
25933
|
+
Defined in: [sys/mod.ts:340](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L340)
|
|
25810
25934
|
|
|
25811
25935
|
根据条件移除条目(仅获取 SQL 对象)
|
|
25812
25936
|
|
|
@@ -25858,7 +25982,7 @@ Defined in: [sys/mod.ts:334](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25858
25982
|
|
|
25859
25983
|
> `static` **select**\<`T`\>(`db`, `c`, `opt?`): `T` & `Record`\<`string`, `any`\>
|
|
25860
25984
|
|
|
25861
|
-
Defined in: [sys/mod.ts:
|
|
25985
|
+
Defined in: [sys/mod.ts:526](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L526)
|
|
25862
25986
|
|
|
25863
25987
|
select 自定字段
|
|
25864
25988
|
|
|
@@ -25906,6 +26030,10 @@ select 自定字段
|
|
|
25906
26030
|
|
|
25907
26031
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25908
26032
|
|
|
26033
|
+
###### hint?
|
|
26034
|
+
|
|
26035
|
+
`string`
|
|
26036
|
+
|
|
25909
26037
|
###### index?
|
|
25910
26038
|
|
|
25911
26039
|
`string` \| `string`[]
|
|
@@ -25924,7 +26052,7 @@ select 自定字段
|
|
|
25924
26052
|
|
|
25925
26053
|
> `static` **toArrayByRecord**\<`T`\>(`obj`): `Record`\<`string`, `Record`\<`string`, `any`\>\>
|
|
25926
26054
|
|
|
25927
|
-
Defined in: [sys/mod.ts:
|
|
26055
|
+
Defined in: [sys/mod.ts:780](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L780)
|
|
25928
26056
|
|
|
25929
26057
|
将 key val 组成的数据列表转换为原生对象模式,获取的是新创建的数组
|
|
25930
26058
|
|
|
@@ -25952,7 +26080,7 @@ Defined in: [sys/mod.ts:762](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25952
26080
|
|
|
25953
26081
|
> `static` **updateByWhere**(`db`, `data`, `where`, `opt?`): `Promise`\<`number` \| `false` \| `null`\>
|
|
25954
26082
|
|
|
25955
|
-
Defined in: [sys/mod.ts:
|
|
26083
|
+
Defined in: [sys/mod.ts:373](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L373)
|
|
25956
26084
|
|
|
25957
26085
|
根据条件更新数据
|
|
25958
26086
|
|
|
@@ -26010,7 +26138,7 @@ Defined in: [sys/mod.ts:367](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26010
26138
|
|
|
26011
26139
|
> `static` **updateByWhereSql**(`db`, `data`, `where`, `opt?`): [`Sql`](../../../lib/sql/classes/Sql.md)
|
|
26012
26140
|
|
|
26013
|
-
Defined in: [sys/mod.ts:
|
|
26141
|
+
Defined in: [sys/mod.ts:419](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L419)
|
|
26014
26142
|
|
|
26015
26143
|
根据条件更新数据(仅获取 SQL 对象)
|
|
26016
26144
|
|
|
@@ -26068,7 +26196,7 @@ Defined in: [sys/mod.ts:413](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26068
26196
|
|
|
26069
26197
|
> `static` **updateList**(`db`, `data`, `key`, `opt?`): `Promise`\<`boolean` \| `null`\>
|
|
26070
26198
|
|
|
26071
|
-
Defined in: [sys/mod.ts:
|
|
26199
|
+
Defined in: [sys/mod.ts:456](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L456)
|
|
26072
26200
|
|
|
26073
26201
|
批量更新数据
|
|
26074
26202
|
|
|
@@ -26125,7 +26253,7 @@ Defined in: [sys/mod.ts:450](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26125
26253
|
|
|
26126
26254
|
> `static` **value**(`val`): `object`
|
|
26127
26255
|
|
|
26128
|
-
Defined in: [sys/mod.ts:
|
|
26256
|
+
Defined in: [sys/mod.ts:190](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L190)
|
|
26129
26257
|
|
|
26130
26258
|
创建字面量值对象,用于 where 条件中 v[0] 需要是值而非字段名的场景
|
|
26131
26259
|
|
|
@@ -26157,7 +26285,7 @@ Defined in: [sys/mod.ts:184](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26157
26285
|
|
|
26158
26286
|
> `static` **where**\<`T`\>(`db`, `s?`, `opt?`): `T` & `Record`\<`string`, `any`\>
|
|
26159
26287
|
|
|
26160
|
-
Defined in: [sys/mod.ts:
|
|
26288
|
+
Defined in: [sys/mod.ts:558](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L558)
|
|
26161
26289
|
|
|
26162
26290
|
通过 where 条件获取模型
|
|
26163
26291
|
|
|
@@ -26205,6 +26333,10 @@ Defined in: [sys/mod.ts:550](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26205
26333
|
|
|
26206
26334
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
26207
26335
|
|
|
26336
|
+
###### hint?
|
|
26337
|
+
|
|
26338
|
+
`string`
|
|
26339
|
+
|
|
26208
26340
|
###### index?
|
|
26209
26341
|
|
|
26210
26342
|
`string` \| `string`[]
|
|
@@ -26422,7 +26554,7 @@ sys/mod/interfaces/IModUnionItem.md
|
|
|
26422
26554
|
|
|
26423
26555
|
# Interface: IModUnionItem
|
|
26424
26556
|
|
|
26425
|
-
Defined in: [sys/mod.ts:
|
|
26557
|
+
Defined in: [sys/mod.ts:1857](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1857)
|
|
26426
26558
|
|
|
26427
26559
|
## Properties
|
|
26428
26560
|
|
|
@@ -26430,7 +26562,7 @@ Defined in: [sys/mod.ts:1811](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26430
26562
|
|
|
26431
26563
|
> **field**: `string`
|
|
26432
26564
|
|
|
26433
|
-
Defined in: [sys/mod.ts:
|
|
26565
|
+
Defined in: [sys/mod.ts:1858](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1858)
|
|
26434
26566
|
|
|
26435
26567
|
***
|
|
26436
26568
|
|
|
@@ -26438,7 +26570,7 @@ Defined in: [sys/mod.ts:1812](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26438
26570
|
|
|
26439
26571
|
> `optional` **where?**: `any`
|
|
26440
26572
|
|
|
26441
|
-
Defined in: [sys/mod.ts:
|
|
26573
|
+
Defined in: [sys/mod.ts:1859](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1859)
|
|
26442
26574
|
|
|
26443
26575
|
sys/mod/interfaces/IRows.md
|
|
26444
26576
|
---
|
|
@@ -26451,7 +26583,7 @@ sys/mod/interfaces/IRows.md
|
|
|
26451
26583
|
|
|
26452
26584
|
# Interface: IRows\<T\>
|
|
26453
26585
|
|
|
26454
|
-
Defined in: [sys/mod.ts:
|
|
26586
|
+
Defined in: [sys/mod.ts:1851](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1851)
|
|
26455
26587
|
|
|
26456
26588
|
## Extends
|
|
26457
26589
|
|
|
@@ -26469,7 +26601,7 @@ Defined in: [sys/mod.ts:1805](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26469
26601
|
|
|
26470
26602
|
> `readonly` **length**: `number`
|
|
26471
26603
|
|
|
26472
|
-
Defined in: [sys/mod.ts:
|
|
26604
|
+
Defined in: [sys/mod.ts:1852](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1852)
|
|
26473
26605
|
|
|
26474
26606
|
## Methods
|
|
26475
26607
|
|
|
@@ -26477,7 +26609,7 @@ Defined in: [sys/mod.ts:1806](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26477
26609
|
|
|
26478
26610
|
> **item**(`index`): `T`
|
|
26479
26611
|
|
|
26480
|
-
Defined in: [sys/mod.ts:
|
|
26612
|
+
Defined in: [sys/mod.ts:1853](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1853)
|
|
26481
26613
|
|
|
26482
26614
|
#### Parameters
|
|
26483
26615
|
|
|
@@ -26495,7 +26627,7 @@ Defined in: [sys/mod.ts:1807](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26495
26627
|
|
|
26496
26628
|
> **toArray**(): `Record`\<`string`, `any`\>[]
|
|
26497
26629
|
|
|
26498
|
-
Defined in: [sys/mod.ts:
|
|
26630
|
+
Defined in: [sys/mod.ts:1854](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1854)
|
|
26499
26631
|
|
|
26500
26632
|
#### Returns
|
|
26501
26633
|
|
|
@@ -26602,12 +26734,24 @@ Defined in: [sys/route.ts:980](https://github.com/maiyunnet/kebab/blob/master/sy
|
|
|
26602
26734
|
|
|
26603
26735
|
允许的文件扩展名(含点号),如 ['.jpg', '.png', '.pdf']
|
|
26604
26736
|
|
|
26737
|
+
#### maxFieldSize?
|
|
26738
|
+
|
|
26739
|
+
`number`
|
|
26740
|
+
|
|
26741
|
+
单个字段(非文件)最大字节数,默认 1 MB
|
|
26742
|
+
|
|
26605
26743
|
#### maxFileSize?
|
|
26606
26744
|
|
|
26607
26745
|
`number`
|
|
26608
26746
|
|
|
26609
26747
|
单个文件最大字节数
|
|
26610
26748
|
|
|
26749
|
+
#### timeout?
|
|
26750
|
+
|
|
26751
|
+
`number`
|
|
26752
|
+
|
|
26753
|
+
整体请求超时时间(毫秒),默认 5 分钟,设为 0 禁用超时
|
|
26754
|
+
|
|
26611
26755
|
## Returns
|
|
26612
26756
|
|
|
26613
26757
|
`Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>
|