kysely 0.11.2 → 0.12.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/README.md +1 -1
- package/dist/cjs/dialect/dialect-adapter-base.d.ts +36 -0
- package/dist/cjs/dialect/mysql/mysql-adapter.d.ts +36 -0
- package/dist/cjs/dialect/mysql/mysql-dialect.d.ts +16 -0
- package/dist/cjs/dialect/mysql/mysql-driver.d.ts +29 -0
- package/dist/cjs/dialect/mysql/mysql-introspector.d.ts +3 -0
- package/dist/cjs/dialect/mysql/mysql-query-compiler.d.ts +0 -2
- package/dist/cjs/dialect/mysql/mysql-query-compiler.js +0 -6
- package/dist/cjs/dialect/postgres/postgres-adapter.d.ts +36 -0
- package/dist/cjs/dialect/postgres/postgres-dialect.d.ts +16 -0
- package/dist/cjs/dialect/postgres/postgres-driver.d.ts +29 -0
- package/dist/cjs/dialect/postgres/postgres-introspector.d.ts +3 -0
- package/dist/cjs/dialect/postgres/postgres-query-compiler.d.ts +3 -0
- package/dist/cjs/dialect/postgres/postgres-query-compiler.js +9 -1
- package/dist/cjs/dialect/sqlite/sqlite-adapter.d.ts +36 -0
- package/dist/cjs/dialect/sqlite/sqlite-adapter.js +6 -2
- package/dist/cjs/dialect/sqlite/sqlite-dialect.d.ts +16 -0
- package/dist/cjs/dialect/sqlite/sqlite-driver.d.ts +29 -0
- package/dist/cjs/dialect/sqlite/sqlite-introspector.d.ts +3 -0
- package/dist/cjs/dialect/sqlite/sqlite-query-compiler.d.ts +2 -2
- package/dist/cjs/dialect/sqlite/sqlite-query-compiler.js +6 -6
- package/dist/cjs/driver/default-connection-provider.d.ts +4 -0
- package/dist/cjs/driver/runtime-driver.d.ts +29 -0
- package/dist/cjs/driver/runtime-driver.js +1 -1
- package/dist/cjs/driver/single-connection-provider.d.ts +4 -0
- package/dist/cjs/dynamic/dynamic-reference-builder.d.ts +1 -0
- package/dist/cjs/dynamic/dynamic-reference-builder.js +9 -1
- package/dist/cjs/dynamic/dynamic.d.ts +6 -7
- package/dist/cjs/dynamic/dynamic.js +6 -7
- package/dist/cjs/index.d.ts +14 -3
- package/dist/cjs/index.js +12 -1
- package/dist/cjs/kysely.d.ts +39 -15
- package/dist/cjs/kysely.js +32 -9
- package/dist/cjs/migration/migration.d.ts +2 -2
- package/dist/cjs/operation-node/create-table-node.d.ts +6 -2
- package/dist/cjs/operation-node/create-table-node.js +6 -6
- package/dist/cjs/operation-node/create-view-node.d.ts +1 -0
- package/dist/cjs/operation-node/insert-query-node.d.ts +4 -4
- package/dist/cjs/operation-node/operation-node-transformer.d.ts +2 -0
- package/dist/cjs/operation-node/operation-node-transformer.js +11 -1
- package/dist/cjs/operation-node/operation-node-visitor.d.ts +2 -0
- package/dist/cjs/operation-node/operation-node-visitor.js +1 -0
- package/dist/cjs/operation-node/operation-node.d.ts +1 -1
- package/dist/cjs/operation-node/query-node.d.ts +0 -2
- package/dist/cjs/operation-node/query-node.js +0 -10
- package/dist/cjs/operation-node/values-node.d.ts +15 -0
- package/dist/cjs/operation-node/values-node.js +18 -0
- package/dist/cjs/package.json +1 -3
- package/dist/cjs/parser/complex-expression-parser.d.ts +9 -0
- package/dist/cjs/parser/complex-expression-parser.js +25 -0
- package/dist/cjs/parser/filter-parser.d.ts +13 -4
- package/dist/cjs/parser/filter-parser.js +21 -24
- package/dist/cjs/parser/insert-values-parser.d.ts +7 -10
- package/dist/cjs/parser/insert-values-parser.js +31 -39
- package/dist/cjs/parser/order-by-parser.d.ts +1 -1
- package/dist/cjs/parser/parse-context.d.ts +22 -8
- package/dist/cjs/parser/parse-context.js +10 -10
- package/dist/cjs/parser/reference-parser.d.ts +8 -7
- package/dist/cjs/parser/reference-parser.js +8 -17
- package/dist/cjs/parser/returning-parser.d.ts +1 -5
- package/dist/cjs/parser/select-parser.d.ts +12 -14
- package/dist/cjs/parser/select-parser.js +5 -9
- package/dist/cjs/parser/table-parser.d.ts +9 -11
- package/dist/cjs/parser/table-parser.js +2 -8
- package/dist/cjs/parser/union-parser.d.ts +2 -2
- package/dist/cjs/parser/union-parser.js +1 -6
- package/dist/cjs/parser/update-set-parser.d.ts +2 -8
- package/dist/cjs/parser/update-set-parser.js +6 -26
- package/dist/cjs/parser/value-parser.d.ts +9 -6
- package/dist/cjs/parser/value-parser.js +7 -30
- package/dist/cjs/parser/with-parser.d.ts +6 -3
- package/dist/cjs/plugin/camel-case/camel-case-plugin.d.ts +34 -0
- package/dist/cjs/plugin/immediate-value.ts/immediate-value-plugin.d.ts +34 -0
- package/dist/cjs/plugin/immediate-value.ts/immediate-value-plugin.js +2 -2
- package/dist/cjs/plugin/with-schema/with-schema-plugin.d.ts +34 -0
- package/dist/cjs/query-builder/delete-query-builder.d.ts +647 -0
- package/dist/cjs/query-builder/delete-query-builder.js +185 -0
- package/dist/cjs/query-builder/expression-builder.d.ts +8 -6
- package/dist/cjs/query-builder/expression-builder.js +3 -3
- package/dist/cjs/query-builder/function-builder.d.ts +2 -1
- package/dist/cjs/query-builder/function-builder.js +2 -1
- package/dist/cjs/query-builder/having-interface.d.ts +49 -0
- package/dist/cjs/query-builder/having-interface.js +2 -0
- package/dist/cjs/query-builder/insert-query-builder.d.ts +504 -0
- package/dist/cjs/query-builder/insert-query-builder.js +256 -0
- package/dist/cjs/query-builder/insert-result.d.ts +3 -2
- package/dist/cjs/query-builder/insert-result.js +3 -2
- package/dist/cjs/query-builder/join-builder.d.ts +19 -20
- package/dist/cjs/query-builder/join-builder.js +12 -12
- package/dist/cjs/query-builder/join-interface.d.ts +130 -0
- package/dist/cjs/query-builder/join-interface.js +2 -0
- package/dist/cjs/query-builder/no-result-error.d.ts +9 -0
- package/dist/cjs/query-builder/no-result-error.js +14 -0
- package/dist/cjs/query-builder/returning-interface.d.ts +73 -0
- package/dist/cjs/query-builder/returning-interface.js +2 -0
- package/dist/cjs/query-builder/{query-builder.d.ts → select-query-builder.d.ts} +145 -634
- package/dist/cjs/query-builder/select-query-builder.js +571 -0
- package/dist/cjs/query-builder/update-query-builder.d.ts +735 -0
- package/dist/cjs/query-builder/update-query-builder.js +279 -0
- package/dist/cjs/query-builder/where-interface.d.ts +378 -0
- package/dist/cjs/query-builder/where-interface.js +2 -0
- package/dist/cjs/query-compiler/default-query-compiler.d.ts +2 -0
- package/dist/cjs/query-compiler/default-query-compiler.js +22 -5
- package/dist/cjs/query-creator.d.ts +42 -40
- package/dist/cjs/query-creator.js +33 -28
- package/dist/cjs/query-executor/query-executor.d.ts +1 -1
- package/dist/cjs/query-executor/query-executor.js +1 -1
- package/dist/cjs/raw-builder/raw-builder.d.ts +2 -0
- package/dist/cjs/raw-builder/raw-builder.js +6 -0
- package/dist/cjs/schema/alter-table-builder.d.ts +218 -2
- package/dist/cjs/schema/column-definition-builder.d.ts +135 -20
- package/dist/cjs/schema/create-index-builder.d.ts +2 -1
- package/dist/cjs/schema/create-index-builder.js +2 -1
- package/dist/cjs/schema/create-table-builder.d.ts +26 -9
- package/dist/cjs/schema/create-table-builder.js +42 -9
- package/dist/cjs/schema/create-view-builder.d.ts +17 -3
- package/dist/cjs/schema/create-view-builder.js +25 -16
- package/dist/cjs/schema/schema.d.ts +18 -11
- package/dist/cjs/schema/schema.js +18 -11
- package/dist/cjs/util/log.d.ts +11 -8
- package/dist/cjs/util/log.js +25 -12
- package/dist/cjs/util/type-utils.d.ts +7 -7
- package/dist/esm/dialect/dialect-adapter-base.d.ts +36 -0
- package/dist/esm/dialect/mysql/mysql-adapter.d.ts +36 -0
- package/dist/esm/dialect/mysql/mysql-dialect.d.ts +16 -0
- package/dist/esm/dialect/mysql/mysql-driver.d.ts +29 -0
- package/dist/esm/dialect/mysql/mysql-introspector.d.ts +3 -0
- package/dist/esm/dialect/mysql/mysql-query-compiler.d.ts +0 -2
- package/dist/esm/dialect/mysql/mysql-query-compiler.js +0 -6
- package/dist/esm/dialect/postgres/postgres-adapter.d.ts +36 -0
- package/dist/esm/dialect/postgres/postgres-dialect.d.ts +16 -0
- package/dist/esm/dialect/postgres/postgres-driver.d.ts +29 -0
- package/dist/esm/dialect/postgres/postgres-introspector.d.ts +3 -0
- package/dist/esm/dialect/postgres/postgres-query-compiler.d.ts +3 -0
- package/dist/esm/dialect/postgres/postgres-query-compiler.js +9 -1
- package/dist/esm/dialect/sqlite/sqlite-adapter.d.ts +36 -0
- package/dist/esm/dialect/sqlite/sqlite-adapter.js +6 -2
- package/dist/esm/dialect/sqlite/sqlite-dialect.d.ts +16 -0
- package/dist/esm/dialect/sqlite/sqlite-driver.d.ts +29 -0
- package/dist/esm/dialect/sqlite/sqlite-introspector.d.ts +3 -0
- package/dist/esm/dialect/sqlite/sqlite-query-compiler.d.ts +2 -2
- package/dist/esm/dialect/sqlite/sqlite-query-compiler.js +6 -6
- package/dist/esm/driver/default-connection-provider.d.ts +4 -0
- package/dist/esm/driver/runtime-driver.d.ts +29 -0
- package/dist/esm/driver/runtime-driver.js +1 -1
- package/dist/esm/driver/single-connection-provider.d.ts +4 -0
- package/dist/esm/dynamic/dynamic-reference-builder.d.ts +1 -0
- package/dist/esm/dynamic/dynamic-reference-builder.js +7 -0
- package/dist/esm/dynamic/dynamic.d.ts +6 -7
- package/dist/esm/dynamic/dynamic.js +6 -7
- package/dist/esm/index.d.ts +14 -3
- package/dist/esm/index.js +12 -1
- package/dist/esm/kysely.d.ts +39 -15
- package/dist/esm/kysely.js +32 -9
- package/dist/esm/migration/migration.d.ts +2 -2
- package/dist/esm/operation-node/create-table-node.d.ts +6 -2
- package/dist/esm/operation-node/create-table-node.js +6 -6
- package/dist/esm/operation-node/create-view-node.d.ts +1 -0
- package/dist/esm/operation-node/insert-query-node.d.ts +4 -4
- package/dist/esm/operation-node/operation-node-transformer.d.ts +2 -0
- package/dist/esm/operation-node/operation-node-transformer.js +11 -1
- package/dist/esm/operation-node/operation-node-visitor.d.ts +2 -0
- package/dist/esm/operation-node/operation-node-visitor.js +1 -0
- package/dist/esm/operation-node/operation-node.d.ts +1 -1
- package/dist/esm/operation-node/query-node.d.ts +0 -2
- package/dist/esm/operation-node/query-node.js +0 -10
- package/dist/esm/operation-node/values-node.d.ts +15 -0
- package/dist/esm/operation-node/values-node.js +15 -0
- package/dist/esm/package.json +1 -3
- package/dist/esm/parser/complex-expression-parser.d.ts +9 -0
- package/dist/esm/parser/complex-expression-parser.js +20 -0
- package/dist/esm/parser/filter-parser.d.ts +13 -4
- package/dist/esm/parser/filter-parser.js +21 -24
- package/dist/esm/parser/insert-values-parser.d.ts +7 -10
- package/dist/esm/parser/insert-values-parser.js +31 -38
- package/dist/esm/parser/order-by-parser.d.ts +1 -1
- package/dist/esm/parser/parse-context.d.ts +22 -8
- package/dist/esm/parser/parse-context.js +10 -10
- package/dist/esm/parser/reference-parser.d.ts +8 -7
- package/dist/esm/parser/reference-parser.js +9 -18
- package/dist/esm/parser/returning-parser.d.ts +1 -5
- package/dist/esm/parser/select-parser.d.ts +12 -14
- package/dist/esm/parser/select-parser.js +6 -10
- package/dist/esm/parser/table-parser.d.ts +9 -11
- package/dist/esm/parser/table-parser.js +3 -9
- package/dist/esm/parser/union-parser.d.ts +2 -2
- package/dist/esm/parser/union-parser.js +1 -6
- package/dist/esm/parser/update-set-parser.d.ts +2 -8
- package/dist/esm/parser/update-set-parser.js +5 -24
- package/dist/esm/parser/value-parser.d.ts +9 -6
- package/dist/esm/parser/value-parser.js +8 -31
- package/dist/esm/parser/with-parser.d.ts +6 -3
- package/dist/esm/plugin/camel-case/camel-case-plugin.d.ts +34 -0
- package/dist/esm/plugin/immediate-value.ts/immediate-value-plugin.d.ts +34 -0
- package/dist/esm/plugin/immediate-value.ts/immediate-value-plugin.js +2 -2
- package/dist/esm/plugin/with-schema/with-schema-plugin.d.ts +34 -0
- package/dist/esm/query-builder/delete-query-builder.d.ts +647 -0
- package/dist/esm/query-builder/delete-query-builder.js +181 -0
- package/dist/esm/query-builder/expression-builder.d.ts +8 -6
- package/dist/esm/query-builder/expression-builder.js +3 -3
- package/dist/esm/query-builder/function-builder.d.ts +2 -1
- package/dist/esm/query-builder/function-builder.js +2 -1
- package/dist/esm/query-builder/having-interface.d.ts +49 -0
- package/dist/esm/query-builder/having-interface.js +1 -0
- package/dist/esm/query-builder/insert-query-builder.d.ts +504 -0
- package/dist/esm/query-builder/insert-query-builder.js +252 -0
- package/dist/esm/query-builder/insert-result.d.ts +3 -2
- package/dist/esm/query-builder/insert-result.js +3 -2
- package/dist/esm/query-builder/join-builder.d.ts +19 -20
- package/dist/esm/query-builder/join-builder.js +12 -12
- package/dist/esm/query-builder/join-interface.d.ts +130 -0
- package/dist/esm/query-builder/join-interface.js +1 -0
- package/dist/esm/query-builder/no-result-error.d.ts +9 -0
- package/dist/esm/query-builder/no-result-error.js +10 -0
- package/dist/esm/query-builder/returning-interface.d.ts +73 -0
- package/dist/esm/query-builder/returning-interface.js +1 -0
- package/dist/esm/query-builder/{query-builder.d.ts → select-query-builder.d.ts} +145 -634
- package/dist/esm/query-builder/select-query-builder.js +566 -0
- package/dist/esm/query-builder/update-query-builder.d.ts +735 -0
- package/dist/esm/query-builder/update-query-builder.js +275 -0
- package/dist/esm/query-builder/where-interface.d.ts +378 -0
- package/dist/esm/query-builder/where-interface.js +1 -0
- package/dist/esm/query-compiler/default-query-compiler.d.ts +2 -0
- package/dist/esm/query-compiler/default-query-compiler.js +22 -5
- package/dist/esm/query-creator.d.ts +42 -40
- package/dist/esm/query-creator.js +33 -28
- package/dist/esm/query-executor/query-executor.d.ts +1 -1
- package/dist/esm/query-executor/query-executor.js +1 -1
- package/dist/esm/raw-builder/raw-builder.d.ts +2 -0
- package/dist/esm/raw-builder/raw-builder.js +6 -0
- package/dist/esm/schema/alter-table-builder.d.ts +218 -2
- package/dist/esm/schema/column-definition-builder.d.ts +135 -20
- package/dist/esm/schema/create-index-builder.d.ts +2 -1
- package/dist/esm/schema/create-index-builder.js +2 -1
- package/dist/esm/schema/create-table-builder.d.ts +26 -9
- package/dist/esm/schema/create-table-builder.js +43 -10
- package/dist/esm/schema/create-view-builder.d.ts +17 -3
- package/dist/esm/schema/create-view-builder.js +25 -16
- package/dist/esm/schema/schema.d.ts +18 -11
- package/dist/esm/schema/schema.js +18 -11
- package/dist/esm/util/log.d.ts +11 -8
- package/dist/esm/util/log.js +25 -12
- package/dist/esm/util/type-utils.d.ts +7 -7
- package/package.json +9 -7
- package/dist/cjs/query-builder/query-builder.js +0 -1067
- package/dist/esm/query-builder/query-builder.js +0 -1061
package/dist/esm/kysely.d.ts
CHANGED
|
@@ -10,14 +10,15 @@ import { DatabaseIntrospector } from './introspection/database-introspector.js';
|
|
|
10
10
|
import { Driver, IsolationLevel } from './driver/driver.js';
|
|
11
11
|
import { ParseContext } from './parser/parse-context.js';
|
|
12
12
|
import { FunctionBuilder } from './query-builder/function-builder.js';
|
|
13
|
-
import {
|
|
13
|
+
import { LogConfig } from './util/log.js';
|
|
14
14
|
/**
|
|
15
15
|
* The main Kysely class.
|
|
16
16
|
*
|
|
17
17
|
* You should create one instance of `Kysely` per database using the {@link Kysely}
|
|
18
18
|
* constructor. Each `Kysely` instance maintains it's own connection pool.
|
|
19
19
|
*
|
|
20
|
-
*
|
|
20
|
+
* ### Examples
|
|
21
|
+
*
|
|
21
22
|
* This example assumes your database has tables `person` and `pet`:
|
|
22
23
|
*
|
|
23
24
|
* ```ts
|
|
@@ -31,7 +32,7 @@ import { LogLevel } from './util/log.js';
|
|
|
31
32
|
* id: number
|
|
32
33
|
* owner_id: number
|
|
33
34
|
* name: string
|
|
34
|
-
* species 'cat' |
|
|
35
|
+
* species 'cat' | 'dog'
|
|
35
36
|
* }
|
|
36
37
|
*
|
|
37
38
|
* interface Database {
|
|
@@ -78,10 +79,11 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
|
|
|
78
79
|
* A value to be used in place of columns that are generated in the database
|
|
79
80
|
* when inserting rows.
|
|
80
81
|
*
|
|
81
|
-
*
|
|
82
|
+
* ### Examples
|
|
83
|
+
*
|
|
82
84
|
* In this example the `Person` table has non-null properties `id` and `created_at`
|
|
83
85
|
* which are both automatically genereted by the database. Since their types are
|
|
84
|
-
* `number` and `string` respectively instead of `number |
|
|
86
|
+
* `number` and `string` respectively instead of `number | null` and `string | null`
|
|
85
87
|
* the `values` method requires you to give a value for them. the `generated`
|
|
86
88
|
* placeholder can be used in these cases.
|
|
87
89
|
*
|
|
@@ -136,12 +138,13 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
|
|
|
136
138
|
* transaction. If the function throws, the transaction is rolled back. Otherwise
|
|
137
139
|
* the transaction is committed.
|
|
138
140
|
*
|
|
139
|
-
* The callback function passed to the {@link TransactionBuilder.execute |
|
|
141
|
+
* The callback function passed to the {@link TransactionBuilder.execute | execute}
|
|
140
142
|
* method gets the transaction object as its only argument. The transaction is
|
|
141
143
|
* of type {@link Transaction} which inherits {@link Kysely}. Any query
|
|
142
144
|
* started through the transaction object is executed inside the transaction.
|
|
143
145
|
*
|
|
144
|
-
*
|
|
146
|
+
* ### Examples
|
|
147
|
+
*
|
|
145
148
|
* ```ts
|
|
146
149
|
* const catto = await db.transaction().execute(async (trx) => {
|
|
147
150
|
* const jennifer = await trx.insertInto('person')
|
|
@@ -167,8 +170,7 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
|
|
|
167
170
|
* })
|
|
168
171
|
* ```
|
|
169
172
|
*
|
|
170
|
-
*
|
|
171
|
-
* Setting the isolation level.
|
|
173
|
+
* Setting the isolation level:
|
|
172
174
|
*
|
|
173
175
|
* ```ts
|
|
174
176
|
* await db
|
|
@@ -183,7 +185,8 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
|
|
|
183
185
|
/**
|
|
184
186
|
* Provides a kysely instance bound to a single database connection.
|
|
185
187
|
*
|
|
186
|
-
*
|
|
188
|
+
* ### Examples
|
|
189
|
+
*
|
|
187
190
|
* ```ts
|
|
188
191
|
* await db
|
|
189
192
|
* .connection()
|
|
@@ -218,10 +221,15 @@ export declare class Kysely<DB> extends QueryCreator<DB> {
|
|
|
218
221
|
get isTransaction(): boolean;
|
|
219
222
|
}
|
|
220
223
|
export declare class Transaction<DB> extends Kysely<DB> {
|
|
224
|
+
#private;
|
|
225
|
+
constructor(props: KyselyProps);
|
|
221
226
|
get isTransaction(): true;
|
|
222
227
|
get migration(): MigrationModule;
|
|
223
228
|
transaction(): TransactionBuilder<DB>;
|
|
229
|
+
connection(): ConnectionBuilder<DB>;
|
|
224
230
|
destroy(): Promise<void>;
|
|
231
|
+
withPlugin(plugin: KyselyPlugin): Transaction<DB>;
|
|
232
|
+
withoutPlugins(): Transaction<DB>;
|
|
225
233
|
}
|
|
226
234
|
export interface KyselyProps {
|
|
227
235
|
readonly config: KyselyConfig;
|
|
@@ -235,17 +243,33 @@ export interface KyselyConfig {
|
|
|
235
243
|
readonly dialect: Dialect;
|
|
236
244
|
readonly plugins?: KyselyPlugin[];
|
|
237
245
|
/**
|
|
238
|
-
* A list of log levels to log.
|
|
246
|
+
* A list of log levels to log or a custom logger function.
|
|
239
247
|
*
|
|
240
248
|
* Currently there's only two levels: `query` and `error`.
|
|
241
249
|
* This will be expanded based on user feedback later.
|
|
242
250
|
*
|
|
243
|
-
*
|
|
251
|
+
* ### Examples
|
|
244
252
|
*
|
|
245
|
-
*
|
|
246
|
-
*
|
|
253
|
+
* ```ts
|
|
254
|
+
* const db = new Kysely<Database>({
|
|
255
|
+
* dialect: new PostgresDialect(postgresConfig),
|
|
256
|
+
* log: ['query', 'error']
|
|
257
|
+
* })
|
|
258
|
+
* ```
|
|
259
|
+
*
|
|
260
|
+
* ```ts
|
|
261
|
+
* const db = new Kysely<Database>({
|
|
262
|
+
* dialect: new PostgresDialect(postgresConfig),
|
|
263
|
+
* log(event): void {
|
|
264
|
+
* if (event.level === 'query') {
|
|
265
|
+
* console.log(event.query.sql)
|
|
266
|
+
* console.log(event.query.parameters)
|
|
267
|
+
* }
|
|
268
|
+
* }
|
|
269
|
+
* })
|
|
270
|
+
* ```
|
|
247
271
|
*/
|
|
248
|
-
readonly log?:
|
|
272
|
+
readonly log?: LogConfig;
|
|
249
273
|
}
|
|
250
274
|
export declare class ConnectionBuilder<DB> {
|
|
251
275
|
#private;
|
package/dist/esm/kysely.js
CHANGED
|
@@ -19,7 +19,8 @@ import { Log } from './util/log.js';
|
|
|
19
19
|
* You should create one instance of `Kysely` per database using the {@link Kysely}
|
|
20
20
|
* constructor. Each `Kysely` instance maintains it's own connection pool.
|
|
21
21
|
*
|
|
22
|
-
*
|
|
22
|
+
* ### Examples
|
|
23
|
+
*
|
|
23
24
|
* This example assumes your database has tables `person` and `pet`:
|
|
24
25
|
*
|
|
25
26
|
* ```ts
|
|
@@ -33,7 +34,7 @@ import { Log } from './util/log.js';
|
|
|
33
34
|
* id: number
|
|
34
35
|
* owner_id: number
|
|
35
36
|
* name: string
|
|
36
|
-
* species 'cat' |
|
|
37
|
+
* species 'cat' | 'dog'
|
|
37
38
|
* }
|
|
38
39
|
*
|
|
39
40
|
* interface Database {
|
|
@@ -111,10 +112,11 @@ export class Kysely extends QueryCreator {
|
|
|
111
112
|
* A value to be used in place of columns that are generated in the database
|
|
112
113
|
* when inserting rows.
|
|
113
114
|
*
|
|
114
|
-
*
|
|
115
|
+
* ### Examples
|
|
116
|
+
*
|
|
115
117
|
* In this example the `Person` table has non-null properties `id` and `created_at`
|
|
116
118
|
* which are both automatically genereted by the database. Since their types are
|
|
117
|
-
* `number` and `string` respectively instead of `number |
|
|
119
|
+
* `number` and `string` respectively instead of `number | null` and `string | null`
|
|
118
120
|
* the `values` method requires you to give a value for them. the `generated`
|
|
119
121
|
* placeholder can be used in these cases.
|
|
120
122
|
*
|
|
@@ -173,12 +175,13 @@ export class Kysely extends QueryCreator {
|
|
|
173
175
|
* transaction. If the function throws, the transaction is rolled back. Otherwise
|
|
174
176
|
* the transaction is committed.
|
|
175
177
|
*
|
|
176
|
-
* The callback function passed to the {@link TransactionBuilder.execute |
|
|
178
|
+
* The callback function passed to the {@link TransactionBuilder.execute | execute}
|
|
177
179
|
* method gets the transaction object as its only argument. The transaction is
|
|
178
180
|
* of type {@link Transaction} which inherits {@link Kysely}. Any query
|
|
179
181
|
* started through the transaction object is executed inside the transaction.
|
|
180
182
|
*
|
|
181
|
-
*
|
|
183
|
+
* ### Examples
|
|
184
|
+
*
|
|
182
185
|
* ```ts
|
|
183
186
|
* const catto = await db.transaction().execute(async (trx) => {
|
|
184
187
|
* const jennifer = await trx.insertInto('person')
|
|
@@ -204,8 +207,7 @@ export class Kysely extends QueryCreator {
|
|
|
204
207
|
* })
|
|
205
208
|
* ```
|
|
206
209
|
*
|
|
207
|
-
*
|
|
208
|
-
* Setting the isolation level.
|
|
210
|
+
* Setting the isolation level:
|
|
209
211
|
*
|
|
210
212
|
* ```ts
|
|
211
213
|
* await db
|
|
@@ -222,7 +224,8 @@ export class Kysely extends QueryCreator {
|
|
|
222
224
|
/**
|
|
223
225
|
* Provides a kysely instance bound to a single database connection.
|
|
224
226
|
*
|
|
225
|
-
*
|
|
227
|
+
* ### Examples
|
|
228
|
+
*
|
|
226
229
|
* ```ts
|
|
227
230
|
* await db
|
|
228
231
|
* .connection()
|
|
@@ -273,6 +276,11 @@ export class Kysely extends QueryCreator {
|
|
|
273
276
|
}
|
|
274
277
|
}
|
|
275
278
|
export class Transaction extends Kysely {
|
|
279
|
+
#props;
|
|
280
|
+
constructor(props) {
|
|
281
|
+
super(props);
|
|
282
|
+
this.#props = props;
|
|
283
|
+
}
|
|
276
284
|
// The return type is `true` instead of `boolean` to make Kysely<DB>
|
|
277
285
|
// unassignable to Transaction<DB> while allowing assignment the
|
|
278
286
|
// other way around.
|
|
@@ -285,9 +293,24 @@ export class Transaction extends Kysely {
|
|
|
285
293
|
transaction() {
|
|
286
294
|
throw new Error('calling the transaction method for a Transaction is not supported');
|
|
287
295
|
}
|
|
296
|
+
connection() {
|
|
297
|
+
throw new Error('calling the connection method for a Transaction is not supported');
|
|
298
|
+
}
|
|
288
299
|
async destroy() {
|
|
289
300
|
throw new Error('calling the destroy method for a Transaction is not supported');
|
|
290
301
|
}
|
|
302
|
+
withPlugin(plugin) {
|
|
303
|
+
return new Transaction({
|
|
304
|
+
...this.#props,
|
|
305
|
+
executor: this.#props.executor.withPlugin(plugin),
|
|
306
|
+
});
|
|
307
|
+
}
|
|
308
|
+
withoutPlugins() {
|
|
309
|
+
return new Transaction({
|
|
310
|
+
...this.#props,
|
|
311
|
+
executor: this.#props.executor.withoutPlugins(),
|
|
312
|
+
});
|
|
313
|
+
}
|
|
291
314
|
}
|
|
292
315
|
export function isKyselyProps(obj) {
|
|
293
316
|
return (isObject(obj) &&
|
|
@@ -18,7 +18,8 @@ export declare class MigrationModule {
|
|
|
18
18
|
* list of executed migrations doesn't match the list of possible migrations, and error
|
|
19
19
|
* is thrown.
|
|
20
20
|
*
|
|
21
|
-
*
|
|
21
|
+
* ### Examples
|
|
22
|
+
*
|
|
22
23
|
* ```ts
|
|
23
24
|
* await db.migration.migrateToLatest(
|
|
24
25
|
* path.join(__dirname, 'migrations')
|
|
@@ -30,7 +31,6 @@ export declare class MigrationModule {
|
|
|
30
31
|
* the migrations is determined based on the alphabetical order of the keys in the record.
|
|
31
32
|
* This can be useful if you are using a bundler like webpack or esbuild.
|
|
32
33
|
*
|
|
33
|
-
* @example
|
|
34
34
|
* ```ts
|
|
35
35
|
* await db.migration.migrateToLatest({
|
|
36
36
|
* migration1: {
|
|
@@ -2,12 +2,16 @@ import { OperationNode } from './operation-node.js';
|
|
|
2
2
|
import { TableNode } from './table-node.js';
|
|
3
3
|
import { ConstraintNode } from './constraint-node.js';
|
|
4
4
|
import { ColumnDefinitionNode } from './column-definition-node.js';
|
|
5
|
+
export declare type OnCommitAction = 'preserve rows' | 'delete rows' | 'drop';
|
|
6
|
+
export declare type CreateTableNodeParams = Omit<CreateTableNode, 'kind' | 'table' | 'columns' | 'constraints'>;
|
|
5
7
|
export interface CreateTableNode extends OperationNode {
|
|
6
8
|
readonly kind: 'CreateTableNode';
|
|
7
9
|
readonly table: TableNode;
|
|
8
10
|
readonly columns: ReadonlyArray<ColumnDefinitionNode>;
|
|
9
|
-
readonly ifNotExists?: boolean;
|
|
10
11
|
readonly constraints?: ReadonlyArray<ConstraintNode>;
|
|
12
|
+
readonly temporary?: boolean;
|
|
13
|
+
readonly ifNotExists?: boolean;
|
|
14
|
+
readonly onCommit?: OnCommitAction;
|
|
11
15
|
}
|
|
12
16
|
/**
|
|
13
17
|
* @internal
|
|
@@ -16,6 +20,6 @@ export declare const CreateTableNode: Readonly<{
|
|
|
16
20
|
is(node: OperationNode): node is CreateTableNode;
|
|
17
21
|
create(table: TableNode): CreateTableNode;
|
|
18
22
|
cloneWithColumn(createTable: CreateTableNode, column: ColumnDefinitionNode): CreateTableNode;
|
|
19
|
-
cloneWithIfNotExists(createTable: CreateTableNode, ifNotExists: boolean): CreateTableNode;
|
|
20
23
|
cloneWithConstraint(createTable: CreateTableNode, constraint: ConstraintNode): CreateTableNode;
|
|
24
|
+
cloneWith(createTable: CreateTableNode, params: CreateTableNodeParams): CreateTableNode;
|
|
21
25
|
}>;
|
|
@@ -19,12 +19,6 @@ export const CreateTableNode = freeze({
|
|
|
19
19
|
columns: freeze([...createTable.columns, column]),
|
|
20
20
|
});
|
|
21
21
|
},
|
|
22
|
-
cloneWithIfNotExists(createTable, ifNotExists) {
|
|
23
|
-
return freeze({
|
|
24
|
-
...createTable,
|
|
25
|
-
ifNotExists,
|
|
26
|
-
});
|
|
27
|
-
},
|
|
28
22
|
cloneWithConstraint(createTable, constraint) {
|
|
29
23
|
return freeze({
|
|
30
24
|
...createTable,
|
|
@@ -33,4 +27,10 @@ export const CreateTableNode = freeze({
|
|
|
33
27
|
: freeze([constraint]),
|
|
34
28
|
});
|
|
35
29
|
},
|
|
30
|
+
cloneWith(createTable, params) {
|
|
31
|
+
return freeze({
|
|
32
|
+
...createTable,
|
|
33
|
+
...params,
|
|
34
|
+
});
|
|
35
|
+
},
|
|
36
36
|
});
|
|
@@ -7,6 +7,7 @@ export declare type CreateViewNodeParams = Omit<Partial<CreateViewNode>, 'kind'
|
|
|
7
7
|
export interface CreateViewNode extends OperationNode {
|
|
8
8
|
readonly kind: 'CreateViewNode';
|
|
9
9
|
readonly name: IdentifierNode;
|
|
10
|
+
readonly temporary?: boolean;
|
|
10
11
|
readonly materialized?: boolean;
|
|
11
12
|
readonly orReplace?: boolean;
|
|
12
13
|
readonly ifNotExists?: boolean;
|
|
@@ -2,18 +2,18 @@ import { ColumnNode } from './column-node.js';
|
|
|
2
2
|
import { OnConflictNode } from './on-conflict-node.js';
|
|
3
3
|
import { OnDuplicateKeyNode } from './on-duplicate-key-node.js';
|
|
4
4
|
import { OperationNode } from './operation-node.js';
|
|
5
|
-
import {
|
|
5
|
+
import { RawNode } from './raw-node.js';
|
|
6
6
|
import { ReturningNode } from './returning-node.js';
|
|
7
|
+
import { SelectQueryNode } from './select-query-node.js';
|
|
7
8
|
import { TableNode } from './table-node.js';
|
|
8
|
-
import {
|
|
9
|
+
import { ValuesNode } from './values-node.js';
|
|
9
10
|
import { WithNode } from './with-node.js';
|
|
10
|
-
export declare type InsertValuesNode = ValueListNode | PrimitiveValueListNode;
|
|
11
11
|
export declare type InsertQueryNodeProps = Omit<InsertQueryNode, 'kind' | 'into'>;
|
|
12
12
|
export interface InsertQueryNode extends OperationNode {
|
|
13
13
|
readonly kind: 'InsertQueryNode';
|
|
14
14
|
readonly into: TableNode;
|
|
15
15
|
readonly columns?: ReadonlyArray<ColumnNode>;
|
|
16
|
-
readonly values?:
|
|
16
|
+
readonly values?: ValuesNode | SelectQueryNode | RawNode;
|
|
17
17
|
readonly returning?: ReturningNode;
|
|
18
18
|
readonly onConflict?: OnConflictNode;
|
|
19
19
|
readonly onDuplicateKey?: OnDuplicateKeyNode;
|
|
@@ -63,6 +63,7 @@ import { DropViewNode } from './drop-view-node.js';
|
|
|
63
63
|
import { GeneratedAlwaysAsNode } from './generated-always-as-node.js';
|
|
64
64
|
import { DefaultValueNode } from './default-value-node.js';
|
|
65
65
|
import { OnNode } from './on-node.js';
|
|
66
|
+
import { ValuesNode } from './values-node.js';
|
|
66
67
|
/**
|
|
67
68
|
* Transforms an operation node tree into another one.
|
|
68
69
|
*
|
|
@@ -113,6 +114,7 @@ export declare class OperationNodeTransformer {
|
|
|
113
114
|
protected transformRaw(node: RawNode): RawNode;
|
|
114
115
|
protected transformWhere(node: WhereNode): WhereNode;
|
|
115
116
|
protected transformInsertQuery(node: InsertQueryNode): InsertQueryNode;
|
|
117
|
+
protected transformValues(node: ValuesNode): ValuesNode;
|
|
116
118
|
protected transformDeleteQuery(node: DeleteQueryNode): DeleteQueryNode;
|
|
117
119
|
protected transformReturning(node: ReturningNode): ReturningNode;
|
|
118
120
|
protected transformCreateTable(node: CreateTableNode): CreateTableNode;
|
|
@@ -95,6 +95,7 @@ export class OperationNodeTransformer {
|
|
|
95
95
|
GeneratedAlwaysAsNode: this.transformGeneratedAlwaysAs.bind(this),
|
|
96
96
|
DefaultValueNode: this.transformDefaultValue.bind(this),
|
|
97
97
|
OnNode: this.transformOn.bind(this),
|
|
98
|
+
ValuesNode: this.transformValues.bind(this),
|
|
98
99
|
});
|
|
99
100
|
transformNode = (node) => {
|
|
100
101
|
if (!node) {
|
|
@@ -229,7 +230,7 @@ export class OperationNodeTransformer {
|
|
|
229
230
|
kind: 'InsertQueryNode',
|
|
230
231
|
into: this.transformNode(node.into),
|
|
231
232
|
columns: this.transformNodeList(node.columns),
|
|
232
|
-
values: this.
|
|
233
|
+
values: this.transformNode(node.values),
|
|
233
234
|
returning: this.transformNode(node.returning),
|
|
234
235
|
onConflict: this.transformNode(node.onConflict),
|
|
235
236
|
onDuplicateKey: this.transformNode(node.onDuplicateKey),
|
|
@@ -237,6 +238,12 @@ export class OperationNodeTransformer {
|
|
|
237
238
|
ignore: node.ignore,
|
|
238
239
|
};
|
|
239
240
|
}
|
|
241
|
+
transformValues(node) {
|
|
242
|
+
return {
|
|
243
|
+
kind: 'ValuesNode',
|
|
244
|
+
values: this.transformNodeList(node.values),
|
|
245
|
+
};
|
|
246
|
+
}
|
|
240
247
|
transformDeleteQuery(node) {
|
|
241
248
|
return {
|
|
242
249
|
kind: 'DeleteQueryNode',
|
|
@@ -259,7 +266,9 @@ export class OperationNodeTransformer {
|
|
|
259
266
|
table: this.transformNode(node.table),
|
|
260
267
|
columns: this.transformNodeList(node.columns),
|
|
261
268
|
constraints: this.transformNodeList(node.constraints),
|
|
269
|
+
temporary: node.temporary,
|
|
262
270
|
ifNotExists: node.ifNotExists,
|
|
271
|
+
onCommit: node.onCommit,
|
|
263
272
|
};
|
|
264
273
|
}
|
|
265
274
|
transformColumnDefinition(node) {
|
|
@@ -525,6 +534,7 @@ export class OperationNodeTransformer {
|
|
|
525
534
|
return {
|
|
526
535
|
kind: 'CreateViewNode',
|
|
527
536
|
name: this.transformNode(node.name),
|
|
537
|
+
temporary: node.temporary,
|
|
528
538
|
orReplace: node.orReplace,
|
|
529
539
|
ifNotExists: node.ifNotExists,
|
|
530
540
|
materialized: node.materialized,
|
|
@@ -63,6 +63,7 @@ import { DropViewNode } from './drop-view-node.js';
|
|
|
63
63
|
import { GeneratedAlwaysAsNode } from './generated-always-as-node.js';
|
|
64
64
|
import { DefaultValueNode } from './default-value-node.js';
|
|
65
65
|
import { OnNode } from './on-node.js';
|
|
66
|
+
import { ValuesNode } from './values-node.js';
|
|
66
67
|
export declare abstract class OperationNodeVisitor {
|
|
67
68
|
#private;
|
|
68
69
|
protected readonly nodeStack: OperationNode[];
|
|
@@ -132,4 +133,5 @@ export declare abstract class OperationNodeVisitor {
|
|
|
132
133
|
protected abstract visitGeneratedAlwaysAs(node: GeneratedAlwaysAsNode): void;
|
|
133
134
|
protected abstract visitDefaultValue(node: DefaultValueNode): void;
|
|
134
135
|
protected abstract visitOn(node: OnNode): void;
|
|
136
|
+
protected abstract visitValues(node: ValuesNode): void;
|
|
135
137
|
}
|
|
@@ -69,6 +69,7 @@ export class OperationNodeVisitor {
|
|
|
69
69
|
GeneratedAlwaysAsNode: this.visitGeneratedAlwaysAs.bind(this),
|
|
70
70
|
DefaultValueNode: this.visitDefaultValue.bind(this),
|
|
71
71
|
OnNode: this.visitOn.bind(this),
|
|
72
|
+
ValuesNode: this.visitValues.bind(this),
|
|
72
73
|
});
|
|
73
74
|
visitNode = (node) => {
|
|
74
75
|
this.nodeStack.push(node);
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare type OperationNodeKind = 'IdentifierNode' | 'RawNode' | 'SelectQueryNode' | 'SelectionNode' | 'ReferenceNode' | 'ColumnNode' | 'TableNode' | 'AliasNode' | 'FromNode' | 'SelectAllNode' | 'FilterNode' | 'AndNode' | 'OrNode' | 'ParensNode' | 'ValueNode' | 'ValueListNode' | 'PrimitiveValueListNode' | 'JoinNode' | 'OperatorNode' | 'WhereNode' | 'InsertQueryNode' | 'DeleteQueryNode' | 'ReturningNode' | 'CreateTableNode' | 'ColumnDefinitionNode' | 'AddColumnNode' | 'DropTableNode' | 'DataTypeNode' | 'OrderByNode' | 'OrderByItemNode' | 'GroupByNode' | 'GroupByItemNode' | 'UpdateQueryNode' | 'ColumnUpdateNode' | 'LimitNode' | 'OffsetNode' | 'OnConflictNode' | 'OnDuplicateKeyNode' | 'CreateIndexNode' | 'DropIndexNode' | 'ListNode' | 'ReferencesNode' | 'PrimaryKeyConstraintNode' | 'UniqueConstraintNode' | 'CheckConstraintNode' | 'ForeignKeyConstraintNode' | 'WithNode' | 'CommonTableExpressionNode' | 'HavingNode' | 'CreateSchemaNode' | 'DropSchemaNode' | 'AlterTableNode' | 'ModifyColumnNode' | 'DropColumnNode' | 'RenameColumnNode' | 'AlterColumnNode' | 'AddConstraintNode' | 'DropConstraintNode' | 'UnionNode' | 'CreateViewNode' | 'DropViewNode' | 'GeneratedAlwaysAsNode' | 'DefaultValueNode' | 'OnNode';
|
|
1
|
+
export declare type OperationNodeKind = 'IdentifierNode' | 'RawNode' | 'SelectQueryNode' | 'SelectionNode' | 'ReferenceNode' | 'ColumnNode' | 'TableNode' | 'AliasNode' | 'FromNode' | 'SelectAllNode' | 'FilterNode' | 'AndNode' | 'OrNode' | 'ParensNode' | 'ValueNode' | 'ValueListNode' | 'PrimitiveValueListNode' | 'JoinNode' | 'OperatorNode' | 'WhereNode' | 'InsertQueryNode' | 'DeleteQueryNode' | 'ReturningNode' | 'CreateTableNode' | 'ColumnDefinitionNode' | 'AddColumnNode' | 'DropTableNode' | 'DataTypeNode' | 'OrderByNode' | 'OrderByItemNode' | 'GroupByNode' | 'GroupByItemNode' | 'UpdateQueryNode' | 'ColumnUpdateNode' | 'LimitNode' | 'OffsetNode' | 'OnConflictNode' | 'OnDuplicateKeyNode' | 'CreateIndexNode' | 'DropIndexNode' | 'ListNode' | 'ReferencesNode' | 'PrimaryKeyConstraintNode' | 'UniqueConstraintNode' | 'CheckConstraintNode' | 'ForeignKeyConstraintNode' | 'WithNode' | 'CommonTableExpressionNode' | 'HavingNode' | 'CreateSchemaNode' | 'DropSchemaNode' | 'AlterTableNode' | 'ModifyColumnNode' | 'DropColumnNode' | 'RenameColumnNode' | 'AlterColumnNode' | 'AddConstraintNode' | 'DropConstraintNode' | 'UnionNode' | 'CreateViewNode' | 'DropViewNode' | 'GeneratedAlwaysAsNode' | 'DefaultValueNode' | 'OnNode' | 'ValuesNode';
|
|
2
2
|
export interface OperationNode {
|
|
3
3
|
readonly kind: OperationNodeKind;
|
|
4
4
|
}
|
|
@@ -14,8 +14,6 @@ export declare type FilterableQueryNode = SelectQueryNode | DeleteQueryNode | Up
|
|
|
14
14
|
*/
|
|
15
15
|
export declare const QueryNode: Readonly<{
|
|
16
16
|
is(node: OperationNode): node is QueryNode;
|
|
17
|
-
isMutating(node: OperationNode): node is MutatingQueryNode;
|
|
18
|
-
isFilterable(node: OperationNode): node is FilterableQueryNode;
|
|
19
17
|
cloneWithWhere<T extends FilterableQueryNode>(node: T, filter: FilterExpressionNode): T;
|
|
20
18
|
cloneWithOrWhere<T_1 extends FilterableQueryNode>(node: T_1, filter: FilterExpressionNode): T_1;
|
|
21
19
|
cloneWithJoin<T_2 extends FilterableQueryNode>(node: T_2, join: JoinNode): T_2;
|
|
@@ -15,16 +15,6 @@ export const QueryNode = freeze({
|
|
|
15
15
|
UpdateQueryNode.is(node) ||
|
|
16
16
|
SelectQueryNode.is(node));
|
|
17
17
|
},
|
|
18
|
-
isMutating(node) {
|
|
19
|
-
return (DeleteQueryNode.is(node) ||
|
|
20
|
-
InsertQueryNode.is(node) ||
|
|
21
|
-
UpdateQueryNode.is(node));
|
|
22
|
-
},
|
|
23
|
-
isFilterable(node) {
|
|
24
|
-
return (SelectQueryNode.is(node) ||
|
|
25
|
-
DeleteQueryNode.is(node) ||
|
|
26
|
-
UpdateQueryNode.is(node));
|
|
27
|
-
},
|
|
28
18
|
cloneWithWhere(node, filter) {
|
|
29
19
|
return freeze({
|
|
30
20
|
...node,
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { OperationNode } from './operation-node.js';
|
|
2
|
+
import { PrimitiveValueListNode } from './primitive-value-list-node.js';
|
|
3
|
+
import { ValueListNode } from './value-list-node.js';
|
|
4
|
+
export declare type ValuesItemNode = ValueListNode | PrimitiveValueListNode;
|
|
5
|
+
export interface ValuesNode extends OperationNode {
|
|
6
|
+
readonly kind: 'ValuesNode';
|
|
7
|
+
readonly values: ReadonlyArray<ValuesItemNode>;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
export declare const ValuesNode: Readonly<{
|
|
13
|
+
is(node: OperationNode): node is ValuesNode;
|
|
14
|
+
create(values: ReadonlyArray<ValuesItemNode>): ValuesNode;
|
|
15
|
+
}>;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { freeze } from '../util/object-utils.js';
|
|
2
|
+
/**
|
|
3
|
+
* @internal
|
|
4
|
+
*/
|
|
5
|
+
export const ValuesNode = freeze({
|
|
6
|
+
is(node) {
|
|
7
|
+
return node.kind === 'ValuesNode';
|
|
8
|
+
},
|
|
9
|
+
create(values) {
|
|
10
|
+
return freeze({
|
|
11
|
+
kind: 'ValuesNode',
|
|
12
|
+
values: freeze(values),
|
|
13
|
+
});
|
|
14
|
+
},
|
|
15
|
+
});
|
package/dist/esm/package.json
CHANGED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { AliasNode } from '../operation-node/alias-node.js';
|
|
2
|
+
import { RawNode } from '../operation-node/raw-node.js';
|
|
3
|
+
import { SelectQueryNode } from '../operation-node/select-query-node.js';
|
|
4
|
+
import { AliasedQueryBuilderFactory, AliasedRawBuilderFactory, AnyAliasedQueryBuilder, AnyAliasedRawBuilder, AnySelectQueryBuilder, AnyRawBuilder, SelectQueryBuilderFactory, RawBuilderFactory } from '../util/type-utils.js';
|
|
5
|
+
import { ParseContext } from './parse-context.js';
|
|
6
|
+
export declare type ComplexExpression<DB, TB extends keyof DB> = AnySelectQueryBuilder | SelectQueryBuilderFactory<DB, TB> | AnyRawBuilder | RawBuilderFactory<DB, TB>;
|
|
7
|
+
export declare type AliasedComplexExpression<DB, TB extends keyof DB> = AnyAliasedQueryBuilder | AliasedQueryBuilderFactory<DB, TB> | AnyAliasedRawBuilder | AliasedRawBuilderFactory<DB, TB>;
|
|
8
|
+
export declare function parseComplexExpression(ctx: ParseContext, exp: ComplexExpression<any, any>): SelectQueryNode | RawNode;
|
|
9
|
+
export declare function parseAliasedComplexExpression(ctx: ParseContext, exp: AliasedComplexExpression<any, any>): AliasNode;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { isOperationNodeSource } from '../operation-node/operation-node-source.js';
|
|
2
|
+
import { isFunction } from '../util/object-utils.js';
|
|
3
|
+
export function parseComplexExpression(ctx, exp) {
|
|
4
|
+
if (isOperationNodeSource(exp)) {
|
|
5
|
+
return exp.toOperationNode();
|
|
6
|
+
}
|
|
7
|
+
else if (isFunction(exp)) {
|
|
8
|
+
return exp(ctx.createExpressionBuilder()).toOperationNode();
|
|
9
|
+
}
|
|
10
|
+
throw new Error(`invalid expression: ${JSON.stringify(exp)}`);
|
|
11
|
+
}
|
|
12
|
+
export function parseAliasedComplexExpression(ctx, exp) {
|
|
13
|
+
if (isOperationNodeSource(exp)) {
|
|
14
|
+
return exp.toOperationNode();
|
|
15
|
+
}
|
|
16
|
+
else if (isFunction(exp)) {
|
|
17
|
+
return exp(ctx.createExpressionBuilder()).toOperationNode();
|
|
18
|
+
}
|
|
19
|
+
throw new Error(`invalid aliased expression: ${JSON.stringify(exp)}`);
|
|
20
|
+
}
|
|
@@ -1,15 +1,24 @@
|
|
|
1
1
|
import { FilterNode } from '../operation-node/filter-node.js';
|
|
2
|
-
import {
|
|
2
|
+
import { AnyRawBuilder } from '../util/type-utils.js';
|
|
3
3
|
import { Operator } from '../operation-node/operator-node.js';
|
|
4
|
-
import { ReferenceExpression } from './reference-parser.js';
|
|
4
|
+
import { ExtractTypeFromReferenceExpression, ReferenceExpression } from './reference-parser.js';
|
|
5
|
+
import { ValueExpression, ValueExpressionOrList } from './value-parser.js';
|
|
5
6
|
import { FilterExpressionNode } from '../operation-node/operation-node-utils.js';
|
|
6
7
|
import { ParseContext } from './parse-context.js';
|
|
7
|
-
|
|
8
|
+
import { WhereInterface } from '../query-builder/where-interface.js';
|
|
9
|
+
import { HavingInterface } from '../query-builder/having-interface.js';
|
|
10
|
+
export declare type FilterValueExpression<DB, TB extends keyof DB, RE> = ValueExpression<DB, TB, ExtractTypeFromReferenceExpression<DB, TB, RE>>;
|
|
11
|
+
export declare type FilterValueExpressionOrList<DB, TB extends keyof DB, RE> = ValueExpressionOrList<DB, TB, ExtractTypeFromReferenceExpression<DB, TB, RE>>;
|
|
12
|
+
export declare type ExistsExpression<DB, TB extends keyof DB> = ValueExpression<DB, TB, never>;
|
|
13
|
+
export declare type WhereGrouper<DB, TB extends keyof DB> = (qb: WhereInterface<DB, TB>) => WhereInterface<DB, TB>;
|
|
14
|
+
export declare type HavingGrouper<DB, TB extends keyof DB> = (qb: HavingInterface<DB, TB>) => HavingInterface<DB, TB>;
|
|
8
15
|
export declare type FilterOperator = Operator | AnyRawBuilder;
|
|
16
|
+
declare type FilterType = 'where' | 'having' | 'on';
|
|
9
17
|
export declare function parseWhereFilter(ctx: ParseContext, args: any[]): FilterExpressionNode;
|
|
10
18
|
export declare function parseHavingFilter(ctx: ParseContext, args: any[]): FilterExpressionNode;
|
|
11
19
|
export declare function parseOnFilter(ctx: ParseContext, args: any[]): FilterExpressionNode;
|
|
12
20
|
export declare function parseReferenceFilter(ctx: ParseContext, lhs: ReferenceExpression<any, any>, op: FilterOperator, rhs: ReferenceExpression<any, any>): FilterNode;
|
|
13
21
|
export declare function parseExistFilter(ctx: ParseContext, arg: ExistsExpression<any, any>): FilterNode;
|
|
14
22
|
export declare function parseNotExistFilter(ctx: ParseContext, arg: ExistsExpression<any, any>): FilterNode;
|
|
15
|
-
export declare function parseFilter(ctx: ParseContext, type:
|
|
23
|
+
export declare function parseFilter(ctx: ParseContext, type: FilterType, args: any[]): FilterExpressionNode;
|
|
24
|
+
export {};
|
|
@@ -6,7 +6,6 @@ import { OperatorNode, OPERATORS, } from '../operation-node/operator-node.js';
|
|
|
6
6
|
import { ParensNode } from '../operation-node/parens-node.js';
|
|
7
7
|
import { parseReferenceExpression, } from './reference-parser.js';
|
|
8
8
|
import { parseValueExpressionOrList, } from './value-parser.js';
|
|
9
|
-
import { SelectQueryNode } from '../operation-node/select-query-node.js';
|
|
10
9
|
import { ValueNode } from '../operation-node/value-node.js';
|
|
11
10
|
export function parseWhereFilter(ctx, args) {
|
|
12
11
|
return parseFilter(ctx, 'where', args);
|
|
@@ -31,18 +30,9 @@ export function parseFilter(ctx, type, args) {
|
|
|
31
30
|
return parseThreeArgFilter(ctx, args[0], args[1], args[2]);
|
|
32
31
|
}
|
|
33
32
|
else if (args.length === 1) {
|
|
34
|
-
|
|
35
|
-
if (isFunction(arg)) {
|
|
36
|
-
return GROUP_PARSERS[type](ctx, arg);
|
|
37
|
-
}
|
|
38
|
-
else if (isOperationNodeSource(arg)) {
|
|
39
|
-
const node = arg.toOperationNode();
|
|
40
|
-
if (RawNode.is(node)) {
|
|
41
|
-
return node;
|
|
42
|
-
}
|
|
43
|
-
}
|
|
33
|
+
return parseOneArgFilter(ctx, type, args[0]);
|
|
44
34
|
}
|
|
45
|
-
throw
|
|
35
|
+
throw createFilterError(type, args);
|
|
46
36
|
}
|
|
47
37
|
function parseThreeArgFilter(ctx, left, op, right) {
|
|
48
38
|
if ((op === 'is' || op === 'is not') && (isNull(right) || isBoolean(right))) {
|
|
@@ -54,10 +44,8 @@ function parseIsFilter(ctx, left, op, right) {
|
|
|
54
44
|
return FilterNode.create(parseReferenceExpression(ctx, left), parseFilterOperator(op), ValueNode.createImmediate(right));
|
|
55
45
|
}
|
|
56
46
|
function parseFilterOperator(op) {
|
|
57
|
-
if (isString(op)) {
|
|
58
|
-
|
|
59
|
-
return OperatorNode.create(op);
|
|
60
|
-
}
|
|
47
|
+
if (isString(op) && OPERATORS.includes(op)) {
|
|
48
|
+
return OperatorNode.create(op);
|
|
61
49
|
}
|
|
62
50
|
else if (isOperationNodeSource(op)) {
|
|
63
51
|
return op.toOperationNode();
|
|
@@ -65,17 +53,26 @@ function parseFilterOperator(op) {
|
|
|
65
53
|
throw new Error(`invalid comparison operator ${JSON.stringify(op)} passed to a filter method`);
|
|
66
54
|
}
|
|
67
55
|
function parseExistExpression(ctx, type, arg) {
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
if (
|
|
72
|
-
|
|
56
|
+
return FilterNode.create(undefined, OperatorNode.create(type), parseValueExpressionOrList(ctx, arg));
|
|
57
|
+
}
|
|
58
|
+
function parseOneArgFilter(ctx, type, arg) {
|
|
59
|
+
if (isFunction(arg)) {
|
|
60
|
+
return GROUP_PARSERS[type](ctx, arg);
|
|
73
61
|
}
|
|
74
|
-
|
|
62
|
+
else if (isOperationNodeSource(arg)) {
|
|
63
|
+
const node = arg.toOperationNode();
|
|
64
|
+
if (RawNode.is(node)) {
|
|
65
|
+
return node;
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
throw createFilterError(type, arg);
|
|
69
|
+
}
|
|
70
|
+
function createFilterError(type, args) {
|
|
71
|
+
return new Error(`invalid arguments passed to a '${type}' method: ${JSON.stringify(args)}`);
|
|
75
72
|
}
|
|
76
73
|
const GROUP_PARSERS = freeze({
|
|
77
74
|
where(ctx, callback) {
|
|
78
|
-
const query = callback(ctx.createSelectQueryBuilder(
|
|
75
|
+
const query = callback(ctx.createSelectQueryBuilder());
|
|
79
76
|
const queryNode = query.toOperationNode();
|
|
80
77
|
if (!queryNode.where) {
|
|
81
78
|
throw new Error('no `where` methods called insided a group callback');
|
|
@@ -83,7 +80,7 @@ const GROUP_PARSERS = freeze({
|
|
|
83
80
|
return ParensNode.create(queryNode.where.where);
|
|
84
81
|
},
|
|
85
82
|
having(ctx, callback) {
|
|
86
|
-
const query = callback(ctx.createSelectQueryBuilder(
|
|
83
|
+
const query = callback(ctx.createSelectQueryBuilder());
|
|
87
84
|
const queryNode = query.toOperationNode();
|
|
88
85
|
if (!queryNode.having) {
|
|
89
86
|
throw new Error('no `having` methods called insided a group callback');
|