litedbmodel 2.2.3 → 2.2.5
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/dist/index.cjs +6 -41
- package/dist/scp/index.cjs +7 -42
- package/dist/scp/index.d.ts +1 -1
- package/dist/scp/index.d.ts.map +1 -1
- package/dist/scp/index.js.map +1 -1
- package/dist/scp/index.mjs +7 -42
- package/dist/scp/makesql/index.d.ts +1 -1
- package/dist/scp/makesql/index.d.ts.map +1 -1
- package/dist/scp/makesql/index.js.map +1 -1
- package/dist/scp/makesql/tx.d.ts +20 -24
- package/dist/scp/makesql/tx.d.ts.map +1 -1
- package/dist/scp/makesql/tx.js +24 -53
- package/dist/scp/makesql/tx.js.map +1 -1
- package/dist/scp/makesql/writeouttype.d.ts +5 -7
- package/dist/scp/makesql/writeouttype.d.ts.map +1 -1
- package/dist/scp/makesql/writeouttype.js +13 -19
- package/dist/scp/makesql/writeouttype.js.map +1 -1
- package/dist/scp/write-bundle.js +1 -1
- package/dist/scp/write-bundle.js.map +1 -1
- package/docs/BENCHMARK.md +26 -22
- package/docs/COMPARISON.md +8 -4
- package/docs/api/README.md +1 -1
- package/docs/api/classes/Conditions.md +10 -10
- package/docs/api/classes/DBHandler.md +17 -17
- package/docs/api/classes/DBModel.md +111 -104
- package/docs/api/classes/LimitExceededError.md +8 -8
- package/docs/api/classes/Middleware.md +18 -18
- package/docs/api/classes/SqlRaw.md +6 -6
- package/docs/api/classes/SqlRef.md +7 -7
- package/docs/api/classes/Values.md +6 -6
- package/docs/api/classes/WriteInReadOnlyContextError.md +5 -5
- package/docs/api/classes/WriteOutsideTransactionError.md +5 -5
- package/docs/api/functions/belongsTo.md +2 -2
- package/docs/api/functions/closeAllPools.md +2 -2
- package/docs/api/functions/condsToRecord.md +2 -2
- package/docs/api/functions/createMiddleware.md +2 -2
- package/docs/api/functions/createPostgresDriver.md +2 -2
- package/docs/api/functions/createSqliteDriver.md +2 -2
- package/docs/api/functions/dbCast.md +3 -3
- package/docs/api/functions/dbCastIn.md +2 -2
- package/docs/api/functions/dbDynamic.md +3 -3
- package/docs/api/functions/dbFalse.md +2 -2
- package/docs/api/functions/dbImmediate.md +2 -2
- package/docs/api/functions/dbIn.md +2 -2
- package/docs/api/functions/dbNotNull.md +2 -2
- package/docs/api/functions/dbNow.md +2 -2
- package/docs/api/functions/dbNull.md +2 -2
- package/docs/api/functions/dbRaw.md +2 -2
- package/docs/api/functions/dbTrue.md +2 -2
- package/docs/api/functions/dbUuid.md +3 -3
- package/docs/api/functions/dbUuidIn.md +2 -2
- package/docs/api/functions/formatLocalDate.md +25 -0
- package/docs/api/functions/formatUTCDate.md +25 -0
- package/docs/api/functions/getDBConfig.md +2 -2
- package/docs/api/functions/getDBHandler.md +2 -2
- package/docs/api/functions/getTransactionConnection.md +2 -2
- package/docs/api/functions/getTransactionContext.md +2 -2
- package/docs/api/functions/hasMany.md +2 -2
- package/docs/api/functions/hasOne.md +2 -2
- package/docs/api/functions/initDBHandler.md +2 -2
- package/docs/api/functions/isAnySqlFragment.md +2 -2
- package/docs/api/functions/isConnectionError.md +26 -0
- package/docs/api/functions/isSqlCondition.md +2 -2
- package/docs/api/functions/isSqlFragment.md +2 -2
- package/docs/api/functions/isSqlRaw.md +2 -2
- package/docs/api/functions/isSqlRef.md +2 -2
- package/docs/api/functions/isSqlTypedFragment.md +2 -2
- package/docs/api/functions/model.md +6 -42
- package/docs/api/functions/parentRef.md +2 -2
- package/docs/api/functions/sql.md +7 -7
- package/docs/api/globals.md +57 -22
- package/docs/api/interfaces/Column.md +31 -31
- package/docs/api/interfaces/ColumnOptions.md +5 -4
- package/docs/api/interfaces/CreatedMiddlewareClass.md +7 -7
- package/docs/api/interfaces/DBConfig.md +13 -11
- package/docs/api/interfaces/DBConfigOptions.md +8 -8
- package/docs/api/interfaces/DeleteOptions.md +4 -4
- package/docs/api/interfaces/InsertOptions.md +8 -8
- package/docs/api/interfaces/LimitConfig.md +4 -4
- package/docs/api/interfaces/MiddlewareConfig.md +15 -15
- package/docs/api/interfaces/ModelOptions.md +8 -7
- package/docs/api/interfaces/PkeyResult.md +4 -4
- package/docs/api/interfaces/SelectOptions.md +17 -16
- package/docs/api/interfaces/SqlCondition.md +6 -6
- package/docs/api/interfaces/SqlFragment.md +5 -5
- package/docs/api/interfaces/SqlTypedFragment.md +7 -7
- package/docs/api/interfaces/TransactionOptions.md +7 -7
- package/docs/api/interfaces/UpdateManyOptions.md +4 -4
- package/docs/api/interfaces/UpdateOptions.md +4 -4
- package/docs/benchmark-chart.svg +225 -249
- package/package.json +8 -4
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: LimitExceededError
|
|
8
8
|
|
|
9
|
-
Defined in: types.ts:
|
|
9
|
+
Defined in: [types.ts:369](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L369)
|
|
10
10
|
|
|
11
11
|
Error thrown when a query exceeds the configured limit.
|
|
12
12
|
|
|
@@ -27,7 +27,7 @@ new LimitExceededError(
|
|
|
27
27
|
relationName?: string): LimitExceededError;
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
Defined in: types.ts:
|
|
30
|
+
Defined in: [types.ts:370](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L370)
|
|
31
31
|
|
|
32
32
|
#### Parameters
|
|
33
33
|
|
|
@@ -53,8 +53,8 @@ Error.constructor
|
|
|
53
53
|
|
|
54
54
|
| Property | Modifier | Type | Description | Defined in |
|
|
55
55
|
| ------ | ------ | ------ | ------ | ------ |
|
|
56
|
-
| <a id="limit"></a> `limit` | `readonly` | `number` | - | types.ts:
|
|
57
|
-
| <a id="actualcount"></a> `actualCount` | `readonly` | `number` | Number of records returned. For find() with findHardLimit, this is limit+1 (actual total may be higher). For relation loading, this is the exact count. | types.ts:
|
|
58
|
-
| <a id="context"></a> `context` | `readonly` | `"find"` \| `"relation"` | - | types.ts:
|
|
59
|
-
| <a id="modelname"></a> `modelName?` | `readonly` | `string` | - | types.ts:
|
|
60
|
-
| <a id="relationname"></a> `relationName?` | `readonly` | `string` | - | types.ts:
|
|
56
|
+
| <a id="limit"></a> `limit` | `readonly` | `number` | - | [types.ts:371](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L371) |
|
|
57
|
+
| <a id="actualcount"></a> `actualCount` | `readonly` | `number` | Number of records returned. For find() with findHardLimit, this is limit+1 (actual total may be higher). For relation loading, this is the exact count. | [types.ts:376](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L376) |
|
|
58
|
+
| <a id="context"></a> `context` | `readonly` | `"find"` \| `"relation"` | - | [types.ts:377](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L377) |
|
|
59
|
+
| <a id="modelname"></a> `modelName?` | `readonly` | `string` | - | [types.ts:378](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L378) |
|
|
60
|
+
| <a id="relationname"></a> `relationName?` | `readonly` | `string` | - | [types.ts:379](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L379) |
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Abstract Class: Middleware
|
|
8
8
|
|
|
9
|
-
Defined in: Middleware.ts:134
|
|
9
|
+
Defined in: [Middleware.ts:134](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L134)
|
|
10
10
|
|
|
11
11
|
Base class for middlewares.
|
|
12
12
|
|
|
@@ -61,7 +61,7 @@ new Middleware(): Middleware;
|
|
|
61
61
|
static getCurrentContext<T>(this: () => T): T;
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
Defined in: Middleware.ts:151
|
|
64
|
+
Defined in: [Middleware.ts:151](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L151)
|
|
65
65
|
|
|
66
66
|
Get current request's instance.
|
|
67
67
|
Creates a new instance on first access within a request.
|
|
@@ -90,7 +90,7 @@ Creates a new instance on first access within a request.
|
|
|
90
90
|
static run<T, R>(this: () => T, fn: () => R): R;
|
|
91
91
|
```
|
|
92
92
|
|
|
93
|
-
Defined in: Middleware.ts:165
|
|
93
|
+
Defined in: [Middleware.ts:165](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L165)
|
|
94
94
|
|
|
95
95
|
Run a function with a fresh middleware context.
|
|
96
96
|
Useful for explicit context boundaries (e.g., in tests).
|
|
@@ -121,7 +121,7 @@ Useful for explicit context boundaries (e.g., in tests).
|
|
|
121
121
|
static hasContext(): boolean;
|
|
122
122
|
```
|
|
123
123
|
|
|
124
|
-
Defined in: Middleware.ts:174
|
|
124
|
+
Defined in: [Middleware.ts:174](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L174)
|
|
125
125
|
|
|
126
126
|
Check if currently in a context
|
|
127
127
|
|
|
@@ -137,7 +137,7 @@ Check if currently in a context
|
|
|
137
137
|
static clearContext(): void;
|
|
138
138
|
```
|
|
139
139
|
|
|
140
|
-
Defined in: Middleware.ts:181
|
|
140
|
+
Defined in: [Middleware.ts:181](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L181)
|
|
141
141
|
|
|
142
142
|
Clear current context (for testing)
|
|
143
143
|
|
|
@@ -153,7 +153,7 @@ Clear current context (for testing)
|
|
|
153
153
|
optional init(): void;
|
|
154
154
|
```
|
|
155
155
|
|
|
156
|
-
Defined in: Middleware.ts:193
|
|
156
|
+
Defined in: [Middleware.ts:193](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L193)
|
|
157
157
|
|
|
158
158
|
Called when instance is created
|
|
159
159
|
|
|
@@ -174,7 +174,7 @@ optional find<T>(
|
|
|
174
174
|
options?: SelectOptions): Promise<InstanceType<T>[]>;
|
|
175
175
|
```
|
|
176
176
|
|
|
177
|
-
Defined in: Middleware.ts:196
|
|
177
|
+
Defined in: [Middleware.ts:196](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L196)
|
|
178
178
|
|
|
179
179
|
Intercept find()
|
|
180
180
|
|
|
@@ -211,7 +211,7 @@ optional findOne<T>(
|
|
|
211
211
|
options?: SelectOptions): Promise<InstanceType<T> | null>;
|
|
212
212
|
```
|
|
213
213
|
|
|
214
|
-
Defined in: Middleware.ts:205
|
|
214
|
+
Defined in: [Middleware.ts:205](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L205)
|
|
215
215
|
|
|
216
216
|
Intercept findOne()
|
|
217
217
|
|
|
@@ -248,7 +248,7 @@ optional findById<T>(
|
|
|
248
248
|
options?: SelectOptions): Promise<InstanceType<T>[]>;
|
|
249
249
|
```
|
|
250
250
|
|
|
251
|
-
Defined in: Middleware.ts:214
|
|
251
|
+
Defined in: [Middleware.ts:214](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L214)
|
|
252
252
|
|
|
253
253
|
Intercept findById()
|
|
254
254
|
|
|
@@ -284,7 +284,7 @@ optional count<T>(
|
|
|
284
284
|
conditions: Conds): Promise<number>;
|
|
285
285
|
```
|
|
286
286
|
|
|
287
|
-
Defined in: Middleware.ts:223
|
|
287
|
+
Defined in: [Middleware.ts:223](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L223)
|
|
288
288
|
|
|
289
289
|
Intercept count()
|
|
290
290
|
|
|
@@ -320,7 +320,7 @@ optional create<T>(
|
|
|
320
320
|
options?: InsertOptions<unknown>): Promise<PkeyResult | null>;
|
|
321
321
|
```
|
|
322
322
|
|
|
323
|
-
Defined in: Middleware.ts:231
|
|
323
|
+
Defined in: [Middleware.ts:231](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L231)
|
|
324
324
|
|
|
325
325
|
Intercept create()
|
|
326
326
|
|
|
@@ -357,7 +357,7 @@ optional createMany<T>(
|
|
|
357
357
|
options?: InsertOptions<unknown>): Promise<PkeyResult | null>;
|
|
358
358
|
```
|
|
359
359
|
|
|
360
|
-
Defined in: Middleware.ts:240
|
|
360
|
+
Defined in: [Middleware.ts:240](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L240)
|
|
361
361
|
|
|
362
362
|
Intercept createMany()
|
|
363
363
|
|
|
@@ -395,7 +395,7 @@ optional update<T>(
|
|
|
395
395
|
options?: UpdateOptions): Promise<PkeyResult | null>;
|
|
396
396
|
```
|
|
397
397
|
|
|
398
|
-
Defined in: Middleware.ts:249
|
|
398
|
+
Defined in: [Middleware.ts:249](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L249)
|
|
399
399
|
|
|
400
400
|
Intercept update()
|
|
401
401
|
|
|
@@ -433,7 +433,7 @@ optional updateMany<T>(
|
|
|
433
433
|
options?: UpdateManyOptions): Promise<PkeyResult | null>;
|
|
434
434
|
```
|
|
435
435
|
|
|
436
|
-
Defined in: Middleware.ts:259
|
|
436
|
+
Defined in: [Middleware.ts:259](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L259)
|
|
437
437
|
|
|
438
438
|
Intercept updateMany()
|
|
439
439
|
|
|
@@ -470,7 +470,7 @@ optional delete<T>(
|
|
|
470
470
|
options?: DeleteOptions): Promise<PkeyResult | null>;
|
|
471
471
|
```
|
|
472
472
|
|
|
473
|
-
Defined in: Middleware.ts:268
|
|
473
|
+
Defined in: [Middleware.ts:268](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L268)
|
|
474
474
|
|
|
475
475
|
Intercept delete()
|
|
476
476
|
|
|
@@ -506,7 +506,7 @@ optional execute(
|
|
|
506
506
|
params?: unknown[]): Promise<ExecuteResult>;
|
|
507
507
|
```
|
|
508
508
|
|
|
509
|
-
Defined in: Middleware.ts:277
|
|
509
|
+
Defined in: [Middleware.ts:277](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L277)
|
|
510
510
|
|
|
511
511
|
Intercept execute()
|
|
512
512
|
|
|
@@ -536,7 +536,7 @@ optional query<T>(
|
|
|
536
536
|
params?: unknown[]): Promise<InstanceType<T>[]>;
|
|
537
537
|
```
|
|
538
538
|
|
|
539
|
-
Defined in: Middleware.ts:285
|
|
539
|
+
Defined in: [Middleware.ts:285](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L285)
|
|
540
540
|
|
|
541
541
|
Intercept query()
|
|
542
542
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: SqlRaw
|
|
8
8
|
|
|
9
|
-
Defined in: SqlFragment.ts:59
|
|
9
|
+
Defined in: [SqlFragment.ts:59](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L59)
|
|
10
10
|
|
|
11
11
|
Raw SQL string that bypasses parameterization.
|
|
12
12
|
Created via `sql.raw()`. Only usable inside `sql` tagged templates.
|
|
@@ -19,7 +19,7 @@ Created via `sql.raw()`. Only usable inside `sql` tagged templates.
|
|
|
19
19
|
new SqlRaw(value: string): SqlRaw;
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
Defined in: SqlFragment.ts:61
|
|
22
|
+
Defined in: [SqlFragment.ts:61](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L61)
|
|
23
23
|
|
|
24
24
|
#### Parameters
|
|
25
25
|
|
|
@@ -35,8 +35,8 @@ Defined in: SqlFragment.ts:61
|
|
|
35
35
|
|
|
36
36
|
| Property | Modifier | Type | Defined in |
|
|
37
37
|
| ------ | ------ | ------ | ------ |
|
|
38
|
-
| <a id="_tag"></a> `_tag` | `readonly` | `"SqlRaw"` | SqlFragment.ts:60 |
|
|
39
|
-
| <a id="value"></a> `value` | `readonly` | `string` | SqlFragment.ts:61 |
|
|
38
|
+
| <a id="_tag"></a> `_tag` | `readonly` | `"SqlRaw"` | [SqlFragment.ts:60](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L60) |
|
|
39
|
+
| <a id="value"></a> `value` | `readonly` | `string` | [SqlFragment.ts:61](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L61) |
|
|
40
40
|
|
|
41
41
|
## Methods
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ Defined in: SqlFragment.ts:61
|
|
|
46
46
|
toString(): string;
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
Defined in: SqlFragment.ts:62
|
|
49
|
+
Defined in: [SqlFragment.ts:62](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L62)
|
|
50
50
|
|
|
51
51
|
#### Returns
|
|
52
52
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: SqlRef
|
|
8
8
|
|
|
9
|
-
Defined in: SqlFragment.ts:71
|
|
9
|
+
Defined in: [SqlFragment.ts:71](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L71)
|
|
10
10
|
|
|
11
11
|
Table-qualified column reference (e.g., `users.id`).
|
|
12
12
|
Created via `sql.ref()`. Only usable inside `sql` tagged templates.
|
|
@@ -22,7 +22,7 @@ new SqlRef(column: {
|
|
|
22
22
|
}): SqlRef;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: SqlFragment.ts:76
|
|
25
|
+
Defined in: [SqlFragment.ts:76](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L76)
|
|
26
26
|
|
|
27
27
|
#### Parameters
|
|
28
28
|
|
|
@@ -40,9 +40,9 @@ Defined in: SqlFragment.ts:76
|
|
|
40
40
|
|
|
41
41
|
| Property | Modifier | Type | Defined in |
|
|
42
42
|
| ------ | ------ | ------ | ------ |
|
|
43
|
-
| <a id="_tag"></a> `_tag` | `readonly` | `"SqlRef"` | SqlFragment.ts:72 |
|
|
44
|
-
| <a id="tablename"></a> `tableName` | `readonly` | `string` | SqlFragment.ts:73 |
|
|
45
|
-
| <a id="columnname"></a> `columnName` | `readonly` | `string` | SqlFragment.ts:74 |
|
|
43
|
+
| <a id="_tag"></a> `_tag` | `readonly` | `"SqlRef"` | [SqlFragment.ts:72](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L72) |
|
|
44
|
+
| <a id="tablename"></a> `tableName` | `readonly` | `string` | [SqlFragment.ts:73](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L73) |
|
|
45
|
+
| <a id="columnname"></a> `columnName` | `readonly` | `string` | [SqlFragment.ts:74](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L74) |
|
|
46
46
|
|
|
47
47
|
## Methods
|
|
48
48
|
|
|
@@ -52,7 +52,7 @@ Defined in: SqlFragment.ts:76
|
|
|
52
52
|
toString(): string;
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
Defined in: SqlFragment.ts:81
|
|
55
|
+
Defined in: [SqlFragment.ts:81](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L81)
|
|
56
56
|
|
|
57
57
|
#### Returns
|
|
58
58
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: Values\<Model\>
|
|
8
8
|
|
|
9
|
-
Defined in: Column.ts:566
|
|
9
|
+
Defined in: [Column.ts:566](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L566)
|
|
10
10
|
|
|
11
11
|
Type-safe builder for update/create value pairs.
|
|
12
12
|
Use array literals for static values, builder for dynamic construction.
|
|
@@ -48,7 +48,7 @@ await User.create(values.build());
|
|
|
48
48
|
new Values<Model>(initial?: readonly readonly [Column<any, Model>, unknown][]): Values<Model>;
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
Defined in: Column.ts:572
|
|
51
|
+
Defined in: [Column.ts:572](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L572)
|
|
52
52
|
|
|
53
53
|
Create a Values builder, optionally with initial pairs.
|
|
54
54
|
|
|
@@ -72,7 +72,7 @@ Create a Values builder, optionally with initial pairs.
|
|
|
72
72
|
get length(): number;
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
Defined in: Column.ts:596
|
|
75
|
+
Defined in: [Column.ts:596](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L596)
|
|
76
76
|
|
|
77
77
|
Get the number of pairs.
|
|
78
78
|
|
|
@@ -88,7 +88,7 @@ Get the number of pairs.
|
|
|
88
88
|
add<V>(column: Column<V, Model>, value: V | null | undefined): this;
|
|
89
89
|
```
|
|
90
90
|
|
|
91
|
-
Defined in: Column.ts:581
|
|
91
|
+
Defined in: [Column.ts:581](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L581)
|
|
92
92
|
|
|
93
93
|
Add a type-safe column-value pair.
|
|
94
94
|
|
|
@@ -117,7 +117,7 @@ Add a type-safe column-value pair.
|
|
|
117
117
|
build(): readonly readonly [Column<any, any>, unknown][];
|
|
118
118
|
```
|
|
119
119
|
|
|
120
|
-
Defined in: Column.ts:589
|
|
120
|
+
Defined in: [Column.ts:589](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L589)
|
|
121
121
|
|
|
122
122
|
Build the final array for use with update/create.
|
|
123
123
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: WriteInReadOnlyContextError
|
|
8
8
|
|
|
9
|
-
Defined in: types.ts:
|
|
9
|
+
Defined in: [types.ts:419](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L419)
|
|
10
10
|
|
|
11
11
|
Error thrown when attempting write operations inside withWriter() context.
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Error thrown when attempting write operations inside withWriter() context.
|
|
|
22
22
|
new WriteInReadOnlyContextError(operation: string, modelName?: string): WriteInReadOnlyContextError;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: types.ts:
|
|
25
|
+
Defined in: [types.ts:420](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L420)
|
|
26
26
|
|
|
27
27
|
#### Parameters
|
|
28
28
|
|
|
@@ -45,5 +45,5 @@ Error.constructor
|
|
|
45
45
|
|
|
46
46
|
| Property | Modifier | Type | Defined in |
|
|
47
47
|
| ------ | ------ | ------ | ------ |
|
|
48
|
-
| <a id="operation"></a> `operation` | `readonly` | `string` | types.ts:
|
|
49
|
-
| <a id="modelname"></a> `modelName?` | `readonly` | `string` | types.ts:
|
|
48
|
+
| <a id="operation"></a> `operation` | `readonly` | `string` | [types.ts:421](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L421) |
|
|
49
|
+
| <a id="modelname"></a> `modelName?` | `readonly` | `string` | [types.ts:422](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L422) |
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: WriteOutsideTransactionError
|
|
8
8
|
|
|
9
|
-
Defined in: types.ts:
|
|
9
|
+
Defined in: [types.ts:401](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L401)
|
|
10
10
|
|
|
11
11
|
Error thrown when attempting write operations outside a transaction.
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Error thrown when attempting write operations outside a transaction.
|
|
|
22
22
|
new WriteOutsideTransactionError(operation: string, modelName?: string): WriteOutsideTransactionError;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: types.ts:
|
|
25
|
+
Defined in: [types.ts:402](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L402)
|
|
26
26
|
|
|
27
27
|
#### Parameters
|
|
28
28
|
|
|
@@ -45,5 +45,5 @@ Error.constructor
|
|
|
45
45
|
|
|
46
46
|
| Property | Modifier | Type | Defined in |
|
|
47
47
|
| ------ | ------ | ------ | ------ |
|
|
48
|
-
| <a id="operation"></a> `operation` | `readonly` | `string` | types.ts:
|
|
49
|
-
| <a id="modelname"></a> `modelName?` | `readonly` | `string` | types.ts:
|
|
48
|
+
| <a id="operation"></a> `operation` | `readonly` | `string` | [types.ts:403](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L403) |
|
|
49
|
+
| <a id="modelname"></a> `modelName?` | `readonly` | `string` | [types.ts:404](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L404) |
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function belongsTo(keys: KeysFactory, options?: RelationDecoratorOptions): PropertyDecorator;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: decorators.ts:
|
|
13
|
+
Defined in: [decorators.ts:909](https://github.com/foo-ogawa/litedbmodel/blob/main/src/decorators.ts#L909)
|
|
14
14
|
|
|
15
15
|
BelongsTo relation decorator (N:1).
|
|
16
16
|
Defines a many-to-one relationship where this model belongs to a parent record.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function closeAllPools(): Promise<void>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: DBHandler.ts:
|
|
13
|
+
Defined in: [DBHandler.ts:345](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L345)
|
|
14
14
|
|
|
15
15
|
Close all connection pools
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function condsToRecord(conditions: Conds): Record<string, unknown>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: Column.ts:1006
|
|
13
|
+
Defined in: [Column.ts:1006](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L1006)
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function createMiddleware<S>(config: MiddlewareConfig<S>): CreatedMiddlewareClass<S>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: Middleware.ts:
|
|
13
|
+
Defined in: [Middleware.ts:497](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Middleware.ts#L497)
|
|
14
14
|
|
|
15
15
|
Create a middleware class from a configuration object.
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function createPostgresDriver(options: DBDriverOptions): PostgresDriver;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: drivers/postgres.ts:
|
|
13
|
+
Defined in: [drivers/postgres.ts:341](https://github.com/foo-ogawa/litedbmodel/blob/main/src/drivers/postgres.ts#L341)
|
|
14
14
|
|
|
15
15
|
Create a PostgreSQL driver instance
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function createSqliteDriver(options: DBDriverOptions): SqliteDriver;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: drivers/sqlite.ts:
|
|
13
|
+
Defined in: [drivers/sqlite.ts:263](https://github.com/foo-ogawa/litedbmodel/blob/main/src/drivers/sqlite.ts#L263)
|
|
14
14
|
|
|
15
15
|
Create a SQLite driver instance
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,10 +10,10 @@
|
|
|
10
10
|
function dbCast(
|
|
11
11
|
value: unknown,
|
|
12
12
|
sqlType: string,
|
|
13
|
-
operator
|
|
13
|
+
operator?: string): DBCast;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: DBValues.ts:503
|
|
16
|
+
Defined in: [DBValues.ts:503](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBValues.ts#L503)
|
|
17
17
|
|
|
18
18
|
Create a type-cast value
|
|
19
19
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function dbCastIn(values: unknown[], sqlType: string): DBCastArray;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: DBValues.ts:529
|
|
13
|
+
Defined in: [DBValues.ts:529](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBValues.ts#L529)
|
|
14
14
|
|
|
15
15
|
Create a type-cast array for IN clause
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -7,10 +7,10 @@
|
|
|
7
7
|
# Function: dbDynamic()
|
|
8
8
|
|
|
9
9
|
```ts
|
|
10
|
-
function dbDynamic(func: string, values
|
|
10
|
+
function dbDynamic(func: string, values?: unknown[]): DBDynamicValue;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: DBValues.ts:380
|
|
13
|
+
Defined in: [DBValues.ts:380](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBValues.ts#L380)
|
|
14
14
|
|
|
15
15
|
Create a dynamic value (function call with parameters)
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function dbFalse(): DBBoolValue;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: DBValues.ts:359
|
|
13
|
+
Defined in: [DBValues.ts:359](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBValues.ts#L359)
|
|
14
14
|
|
|
15
15
|
Create a boolean FALSE value
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function dbImmediate(value: string): DBImmediateValue;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: DBValues.ts:394
|
|
13
|
+
Defined in: [DBValues.ts:394](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBValues.ts#L394)
|
|
14
14
|
|
|
15
15
|
Create an immediate value (literal, no binding)
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function dbIn(values: unknown[]): DBArrayValue;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: DBValues.ts:373
|
|
13
|
+
Defined in: [DBValues.ts:373](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBValues.ts#L373)
|
|
14
14
|
|
|
15
15
|
Create an array value for IN clause
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function dbNotNull(): DBNotNullValue;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: DBValues.ts:345
|
|
13
|
+
Defined in: [DBValues.ts:345](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBValues.ts#L345)
|
|
14
14
|
|
|
15
15
|
Create a NOT NULL value
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function dbNow(): DBImmediateValue;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: DBValues.ts:366
|
|
13
|
+
Defined in: [DBValues.ts:366](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBValues.ts#L366)
|
|
14
14
|
|
|
15
15
|
Create a NOW() value
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function dbNull(): DBNullValue;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: DBValues.ts:338
|
|
13
|
+
Defined in: [DBValues.ts:338](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBValues.ts#L338)
|
|
14
14
|
|
|
15
15
|
Create a NULL value
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function dbRaw(sql: string): DBRawValue;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: DBValues.ts:387
|
|
13
|
+
Defined in: [DBValues.ts:387](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBValues.ts#L387)
|
|
14
14
|
|
|
15
15
|
Create a raw SQL expression
|
|
16
16
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.5**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
function dbTrue(): DBBoolValue;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: DBValues.ts:352
|
|
13
|
+
Defined in: [DBValues.ts:352](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBValues.ts#L352)
|
|
14
14
|
|
|
15
15
|
Create a boolean TRUE value
|
|
16
16
|
|