litedbmodel 2.2.3 → 2.2.4
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.4**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: Conditions\<Model\>
|
|
8
8
|
|
|
9
|
-
Defined in: Column.ts:628
|
|
9
|
+
Defined in: [Column.ts:628](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L628)
|
|
10
10
|
|
|
11
11
|
Type-safe builder for query conditions.
|
|
12
12
|
Use array literals for static conditions, builder for dynamic construction.
|
|
@@ -47,7 +47,7 @@ if (query.active) where.add(User.is_active, true);
|
|
|
47
47
|
new Conditions<Model>(initial?: Conds): Conditions<Model>;
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Defined in: Column.ts:634
|
|
50
|
+
Defined in: [Column.ts:634](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L634)
|
|
51
51
|
|
|
52
52
|
Create a Conditions builder, optionally with initial conditions.
|
|
53
53
|
|
|
@@ -71,7 +71,7 @@ Create a Conditions builder, optionally with initial conditions.
|
|
|
71
71
|
get length(): number;
|
|
72
72
|
```
|
|
73
73
|
|
|
74
|
-
Defined in: Column.ts:700
|
|
74
|
+
Defined in: [Column.ts:700](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L700)
|
|
75
75
|
|
|
76
76
|
Get the number of conditions.
|
|
77
77
|
|
|
@@ -87,7 +87,7 @@ Get the number of conditions.
|
|
|
87
87
|
add<V>(column: Column<V, Model>, value: V | null | undefined): this;
|
|
88
88
|
```
|
|
89
89
|
|
|
90
|
-
Defined in: Column.ts:643
|
|
90
|
+
Defined in: [Column.ts:643](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L643)
|
|
91
91
|
|
|
92
92
|
Add a type-safe column equality condition.
|
|
93
93
|
|
|
@@ -116,7 +116,7 @@ Add a type-safe column equality condition.
|
|
|
116
116
|
addRaw(condition: string, value?: unknown): this;
|
|
117
117
|
```
|
|
118
118
|
|
|
119
|
-
Defined in: Column.ts:651
|
|
119
|
+
Defined in: [Column.ts:651](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L651)
|
|
120
120
|
|
|
121
121
|
Add a raw condition with template literal (e.g., `${User.age} > ?`).
|
|
122
122
|
|
|
@@ -141,7 +141,7 @@ Add a raw condition with template literal (e.g., `${User.age} > ?`).
|
|
|
141
141
|
addSql<V>(fragment: SqlTypedFragment<V, Model>, value: V): this;
|
|
142
142
|
```
|
|
143
143
|
|
|
144
|
-
Defined in: Column.ts:670
|
|
144
|
+
Defined in: [Column.ts:670](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L670)
|
|
145
145
|
|
|
146
146
|
Add a type-safe sql-tagged condition.
|
|
147
147
|
|
|
@@ -176,7 +176,7 @@ where.addSql(sql`${User.deleted_at} IS NULL`);
|
|
|
176
176
|
addSql(fragment: SqlTypedFragment<any, Model>): this;
|
|
177
177
|
```
|
|
178
178
|
|
|
179
|
-
Defined in: Column.ts:671
|
|
179
|
+
Defined in: [Column.ts:671](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L671)
|
|
180
180
|
|
|
181
181
|
Add a type-safe sql-tagged condition.
|
|
182
182
|
|
|
@@ -206,7 +206,7 @@ where.addSql(sql`${User.deleted_at} IS NULL`);
|
|
|
206
206
|
or(...condGroups: readonly Conds[]): this;
|
|
207
207
|
```
|
|
208
208
|
|
|
209
|
-
Defined in: Column.ts:685
|
|
209
|
+
Defined in: [Column.ts:685](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L685)
|
|
210
210
|
|
|
211
211
|
Add an OR condition group.
|
|
212
212
|
|
|
@@ -228,7 +228,7 @@ Add an OR condition group.
|
|
|
228
228
|
build(): Conds;
|
|
229
229
|
```
|
|
230
230
|
|
|
231
|
-
Defined in: Column.ts:693
|
|
231
|
+
Defined in: [Column.ts:693](https://github.com/foo-ogawa/litedbmodel/blob/main/src/Column.ts#L693)
|
|
232
232
|
|
|
233
233
|
Build the final array for use with find/count/delete.
|
|
234
234
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**litedbmodel
|
|
1
|
+
[**litedbmodel v2.2.4**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: DBHandler
|
|
8
8
|
|
|
9
|
-
Defined in: DBHandler.ts:
|
|
9
|
+
Defined in: [DBHandler.ts:179](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L179)
|
|
10
10
|
|
|
11
11
|
Database handler - wraps a driver and provides a unified interface.
|
|
12
12
|
|
|
@@ -30,7 +30,7 @@ const result = await handler.execute('SELECT * FROM users WHERE id = $1', [1]);
|
|
|
30
30
|
new DBHandler(config: DBConfig, options?: DBHandlerOptions): DBHandler;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: DBHandler.ts:
|
|
33
|
+
Defined in: [DBHandler.ts:185](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L185)
|
|
34
34
|
|
|
35
35
|
#### Parameters
|
|
36
36
|
|
|
@@ -51,7 +51,7 @@ Defined in: DBHandler.ts:180
|
|
|
51
51
|
getDriverType(): "postgres" | "mysql" | "sqlite";
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
Defined in: DBHandler.ts:
|
|
54
|
+
Defined in: [DBHandler.ts:203](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L203)
|
|
55
55
|
|
|
56
56
|
Get the driver type
|
|
57
57
|
|
|
@@ -67,7 +67,7 @@ Get the driver type
|
|
|
67
67
|
getDriver(): DBDriver;
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
Defined in: DBHandler.ts:
|
|
70
|
+
Defined in: [DBHandler.ts:210](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L210)
|
|
71
71
|
|
|
72
72
|
Get the underlying driver
|
|
73
73
|
|
|
@@ -80,10 +80,10 @@ Get the underlying driver
|
|
|
80
80
|
### execute()
|
|
81
81
|
|
|
82
82
|
```ts
|
|
83
|
-
execute(sql: string, params
|
|
83
|
+
execute(sql: string, params?: unknown[]): Promise<QueryResult>;
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
Defined in: DBHandler.ts:
|
|
86
|
+
Defined in: [DBHandler.ts:217](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L217)
|
|
87
87
|
|
|
88
88
|
Execute a SQL query
|
|
89
89
|
|
|
@@ -103,10 +103,10 @@ Execute a SQL query
|
|
|
103
103
|
### executeWrite()
|
|
104
104
|
|
|
105
105
|
```ts
|
|
106
|
-
executeWrite(sql: string, params
|
|
106
|
+
executeWrite(sql: string, params?: unknown[]): Promise<QueryResult>;
|
|
107
107
|
```
|
|
108
108
|
|
|
109
|
-
Defined in: DBHandler.ts:
|
|
109
|
+
Defined in: [DBHandler.ts:227](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L227)
|
|
110
110
|
|
|
111
111
|
Execute a write query (INSERT/UPDATE/DELETE)
|
|
112
112
|
|
|
@@ -126,10 +126,10 @@ Execute a write query (INSERT/UPDATE/DELETE)
|
|
|
126
126
|
### executeOnWriter()
|
|
127
127
|
|
|
128
128
|
```ts
|
|
129
|
-
executeOnWriter(sql: string, params
|
|
129
|
+
executeOnWriter(sql: string, params?: unknown[]): Promise<QueryResult>;
|
|
130
130
|
```
|
|
131
131
|
|
|
132
|
-
Defined in: DBHandler.ts:
|
|
132
|
+
Defined in: [DBHandler.ts:237](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L237)
|
|
133
133
|
|
|
134
134
|
Execute a query on writer pool (for withWriter context)
|
|
135
135
|
|
|
@@ -152,7 +152,7 @@ Execute a query on writer pool (for withWriter context)
|
|
|
152
152
|
hasWriterPool(): boolean;
|
|
153
153
|
```
|
|
154
154
|
|
|
155
|
-
Defined in: DBHandler.ts:
|
|
155
|
+
Defined in: [DBHandler.ts:247](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L247)
|
|
156
156
|
|
|
157
157
|
Check if writer pool is configured
|
|
158
158
|
|
|
@@ -168,7 +168,7 @@ Check if writer pool is configured
|
|
|
168
168
|
getConnection(): Promise<DBConnection>;
|
|
169
169
|
```
|
|
170
170
|
|
|
171
|
-
Defined in: DBHandler.ts:
|
|
171
|
+
Defined in: [DBHandler.ts:254](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L254)
|
|
172
172
|
|
|
173
173
|
Get a connection from the pool (for transactions)
|
|
174
174
|
|
|
@@ -184,7 +184,7 @@ Get a connection from the pool (for transactions)
|
|
|
184
184
|
withConnection(connection: DBConnection): DBHandler;
|
|
185
185
|
```
|
|
186
186
|
|
|
187
|
-
Defined in: DBHandler.ts:
|
|
187
|
+
Defined in: [DBHandler.ts:261](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L261)
|
|
188
188
|
|
|
189
189
|
Create handler with specific connection (for transaction)
|
|
190
190
|
|
|
@@ -206,7 +206,7 @@ Create handler with specific connection (for transaction)
|
|
|
206
206
|
close(): Promise<void>;
|
|
207
207
|
```
|
|
208
208
|
|
|
209
|
-
Defined in: DBHandler.ts:
|
|
209
|
+
Defined in: [DBHandler.ts:273](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L273)
|
|
210
210
|
|
|
211
211
|
Close all connections
|
|
212
212
|
|
|
@@ -222,7 +222,7 @@ Close all connections
|
|
|
222
222
|
setLogger(logger: Logger): void;
|
|
223
223
|
```
|
|
224
224
|
|
|
225
|
-
Defined in: DBHandler.ts:
|
|
225
|
+
Defined in: [DBHandler.ts:280](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L280)
|
|
226
226
|
|
|
227
227
|
Set logger
|
|
228
228
|
|
|
@@ -244,7 +244,7 @@ Set logger
|
|
|
244
244
|
getPool(): unknown;
|
|
245
245
|
```
|
|
246
246
|
|
|
247
|
-
Defined in: DBHandler.ts:
|
|
247
|
+
Defined in: [DBHandler.ts:289](https://github.com/foo-ogawa/litedbmodel/blob/main/src/DBHandler.ts#L289)
|
|
248
248
|
|
|
249
249
|
Get the underlying PostgreSQL pool (for backward compatibility)
|
|
250
250
|
|