kysely 0.19.12 → 0.20.0

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.
Files changed (90) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/dialect/mysql/mysql-introspector.js +2 -0
  3. package/dist/cjs/dialect/mysql/mysql-query-compiler.d.ts +5 -0
  4. package/dist/cjs/dialect/mysql/mysql-query-compiler.js +16 -0
  5. package/dist/cjs/dialect/postgres/postgres-introspector.js +7 -1
  6. package/dist/cjs/dialect/postgres/postgres-query-compiler.d.ts +1 -3
  7. package/dist/cjs/dialect/postgres/postgres-query-compiler.js +3 -8
  8. package/dist/cjs/dialect/sqlite/sqlite-introspector.js +2 -0
  9. package/dist/cjs/dialect/sqlite/sqlite-query-compiler.d.ts +3 -0
  10. package/dist/cjs/dialect/sqlite/sqlite-query-compiler.js +10 -0
  11. package/dist/cjs/index.d.ts +2 -0
  12. package/dist/cjs/index.js +2 -0
  13. package/dist/cjs/operation-node/create-table-node.d.ts +6 -1
  14. package/dist/cjs/operation-node/create-table-node.js +16 -0
  15. package/dist/cjs/operation-node/delete-query-node.d.ts +3 -0
  16. package/dist/cjs/operation-node/delete-query-node.js +6 -0
  17. package/dist/cjs/operation-node/explain-node.d.ts +16 -0
  18. package/dist/cjs/operation-node/explain-node.js +19 -0
  19. package/dist/cjs/operation-node/insert-query-node.d.ts +2 -0
  20. package/dist/cjs/operation-node/operation-node-transformer.d.ts +2 -0
  21. package/dist/cjs/operation-node/operation-node-transformer.js +14 -0
  22. package/dist/cjs/operation-node/operation-node-visitor.d.ts +2 -0
  23. package/dist/cjs/operation-node/operation-node-visitor.js +1 -0
  24. package/dist/cjs/operation-node/operation-node.d.ts +1 -1
  25. package/dist/cjs/operation-node/select-query-node.d.ts +3 -0
  26. package/dist/cjs/operation-node/select-query-node.js +6 -0
  27. package/dist/cjs/operation-node/update-query-node.d.ts +3 -0
  28. package/dist/cjs/operation-node/update-query-node.js +6 -0
  29. package/dist/cjs/query-builder/delete-query-builder.d.ts +19 -1
  30. package/dist/cjs/query-builder/delete-query-builder.js +24 -0
  31. package/dist/cjs/query-builder/function-builder.d.ts +3 -3
  32. package/dist/cjs/query-builder/insert-query-builder.d.ts +20 -2
  33. package/dist/cjs/query-builder/insert-query-builder.js +26 -0
  34. package/dist/cjs/query-builder/select-query-builder.d.ts +38 -1
  35. package/dist/cjs/query-builder/select-query-builder.js +45 -2
  36. package/dist/cjs/query-builder/update-query-builder.d.ts +20 -1
  37. package/dist/cjs/query-builder/update-query-builder.js +25 -0
  38. package/dist/cjs/query-compiler/default-query-compiler.d.ts +6 -0
  39. package/dist/cjs/query-compiler/default-query-compiler.js +58 -3
  40. package/dist/cjs/raw-builder/sql.d.ts +96 -96
  41. package/dist/cjs/raw-builder/sql.js +0 -96
  42. package/dist/cjs/schema/create-table-builder.d.ts +54 -0
  43. package/dist/cjs/schema/create-table-builder.js +64 -0
  44. package/dist/cjs/util/explainable.d.ts +5 -0
  45. package/dist/cjs/util/explainable.js +2 -0
  46. package/dist/esm/dialect/mysql/mysql-introspector.js +2 -0
  47. package/dist/esm/dialect/mysql/mysql-query-compiler.d.ts +5 -0
  48. package/dist/esm/dialect/mysql/mysql-query-compiler.js +16 -0
  49. package/dist/esm/dialect/postgres/postgres-introspector.js +7 -1
  50. package/dist/esm/dialect/postgres/postgres-query-compiler.d.ts +1 -3
  51. package/dist/esm/dialect/postgres/postgres-query-compiler.js +3 -8
  52. package/dist/esm/dialect/sqlite/sqlite-introspector.js +2 -0
  53. package/dist/esm/dialect/sqlite/sqlite-query-compiler.d.ts +3 -0
  54. package/dist/esm/dialect/sqlite/sqlite-query-compiler.js +10 -0
  55. package/dist/esm/index.d.ts +2 -0
  56. package/dist/esm/index.js +2 -0
  57. package/dist/esm/operation-node/create-table-node.d.ts +6 -1
  58. package/dist/esm/operation-node/create-table-node.js +16 -0
  59. package/dist/esm/operation-node/delete-query-node.d.ts +3 -0
  60. package/dist/esm/operation-node/delete-query-node.js +6 -0
  61. package/dist/esm/operation-node/explain-node.d.ts +16 -0
  62. package/dist/esm/operation-node/explain-node.js +17 -0
  63. package/dist/esm/operation-node/insert-query-node.d.ts +2 -0
  64. package/dist/esm/operation-node/operation-node-transformer.d.ts +2 -0
  65. package/dist/esm/operation-node/operation-node-transformer.js +14 -0
  66. package/dist/esm/operation-node/operation-node-visitor.d.ts +2 -0
  67. package/dist/esm/operation-node/operation-node-visitor.js +1 -0
  68. package/dist/esm/operation-node/operation-node.d.ts +1 -1
  69. package/dist/esm/operation-node/select-query-node.d.ts +3 -0
  70. package/dist/esm/operation-node/select-query-node.js +6 -0
  71. package/dist/esm/operation-node/update-query-node.d.ts +3 -0
  72. package/dist/esm/operation-node/update-query-node.js +6 -0
  73. package/dist/esm/query-builder/delete-query-builder.d.ts +19 -1
  74. package/dist/esm/query-builder/delete-query-builder.js +24 -0
  75. package/dist/esm/query-builder/function-builder.d.ts +3 -3
  76. package/dist/esm/query-builder/insert-query-builder.d.ts +20 -2
  77. package/dist/esm/query-builder/insert-query-builder.js +26 -0
  78. package/dist/esm/query-builder/select-query-builder.d.ts +38 -1
  79. package/dist/esm/query-builder/select-query-builder.js +45 -2
  80. package/dist/esm/query-builder/update-query-builder.d.ts +20 -1
  81. package/dist/esm/query-builder/update-query-builder.js +25 -0
  82. package/dist/esm/query-compiler/default-query-compiler.d.ts +6 -0
  83. package/dist/esm/query-compiler/default-query-compiler.js +58 -3
  84. package/dist/esm/raw-builder/sql.d.ts +96 -96
  85. package/dist/esm/raw-builder/sql.js +0 -96
  86. package/dist/esm/schema/create-table-builder.d.ts +54 -0
  87. package/dist/esm/schema/create-table-builder.js +64 -0
  88. package/dist/esm/util/explainable.d.ts +5 -0
  89. package/dist/esm/util/explainable.js +2 -0
  90. package/package.json +3 -1
@@ -9,102 +9,6 @@ const table_parser_js_1 = require("../parser/table-parser.js");
9
9
  const value_parser_js_1 = require("../parser/value-parser.js");
10
10
  const query_id_js_1 = require("../util/query-id.js");
11
11
  const raw_builder_js_1 = require("./raw-builder.js");
12
- /**
13
- * Template tag for creating raw SQL snippets and queries.
14
- *
15
- * ```ts
16
- * import { sql } from 'kysely'
17
- *
18
- * const id = 123
19
- *
20
- * const snippet = sql<Person[]>`select * from person where id = ${id}`
21
- * ```
22
- *
23
- * Substitutions (the things inside `${}`) are automatically passed to the database
24
- * as parameters and are NOT interpolated to the SQL string. There's no need to worry
25
- * about SQL injection vulnerabilities.
26
- *
27
- * If you need your substitutions to be interpreted as identifiers, value literals or
28
- * lists of things, see the {@link Sql.ref}, {@link Sql.table}, {@link Sql.id},
29
- * {@link Sql.literal}, {@link Sql.raw} and {@link Sql.join} functions.
30
- *
31
- * You can pass sql snippets returned by the `sql` tag pretty much anywhere. Whenever
32
- * something can't be done using the Kysely API, you should be able to drop down to
33
- * raw SQL using the `sql` tag. Here's an example query that uses raw sql in a bunch
34
- * of methods:
35
- *
36
- * ```ts
37
- * const persons = await db
38
- * .selectFrom('person')
39
- * .select(
40
- * // If you use `sql` in a select statement, remember to call the `as`
41
- * // method to give it an alias. Otherwise Kysely is not able to add
42
- * // the column to the result type.
43
- * sql<string>`concat(first_name, ' ', last_name)`.as('full_name')
44
- * )
45
- * .where(sql`birthdate between ${date1} and ${date2}`)
46
- * // Here we assume we have list of nicknames for the person
47
- * // (a list of strings) and we use the PostgreSQL `@>` operator
48
- * // to test if all of them are valid nicknames for the user.
49
- * .where('nicknames', '@>', sql`ARRAY[${sql.join(nicknames)}]`)
50
- * .orderBy(sql`concat(first_name, ' ', last_name)`)
51
- * .execute()
52
- * ```
53
- *
54
- * The generated SQL (PostgreSQL):
55
- *
56
- * ```sql
57
- * select concat(first_name, ' ', last_name) as "full_name"
58
- * from "person"
59
- * where birthdate between $1 and $2
60
- * and "nicknames" @> ARRAY[$3, $4, $5, $6, $7, $8, $9, $10]
61
- * order by concat(first_name, ' ', last_name)
62
- * ```
63
- *
64
- * SQL snippets can be executed by calling the `execute` method and passing a `Kysely`
65
- * instance as the only argument:
66
- *
67
- * ```ts
68
- * const result = await sql<Person[]>`select * from person`.execute(db)
69
- * ```
70
- *
71
- * You can merge other `sql` expressions and queries using substitutions:
72
- *
73
- * ```ts
74
- * const petName = db.selectFrom('pet').select('name').limit(1)
75
- * const fullName = sql`concat(first_name, ' ', last_name)`
76
- *
77
- * sql`
78
- * select ${fullName} as full_name, ${petName} as pet_name
79
- * from person
80
- * `
81
- * ```
82
- *
83
- * Substitutions also handle {@link ExpressionBuilder.ref},
84
- * {@link DynamicModule.ref} and pretty much anything else you
85
- * throw at it. Here's an example of calling a function in a
86
- * type-safe way:
87
- *
88
- * ```ts
89
- * db.selectFrom('person')
90
- * .select([
91
- * 'first_name',
92
- * 'last_name',
93
- * (eb) => {
94
- * // The `eb.ref` method is type-safe and only accepts
95
- * // column references that are possible.
96
- * const firstName = eb.ref('first_name')
97
- * const lastName = eb.ref('last_name')
98
- *
99
- * const fullName = sql<string>`concat(${firstName}, ' ', ${lastName})`
100
- * return fullName.as('full_name')
101
- * }
102
- * ])
103
- * ```
104
- *
105
- * don't know if that amount of ceremony is worth the small increase in
106
- * type-safety though... But it's possible.
107
- */
108
12
  exports.sql = Object.assign((sqlFragments, ...parameters) => {
109
13
  return new raw_builder_js_1.RawBuilder({
110
14
  queryId: (0, query_id_js_1.createQueryId)(),
@@ -149,6 +149,60 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
149
149
  * ```
150
150
  */
151
151
  addForeignKeyConstraint(constraintName: string, columns: C[], targetTable: string, targetColumns: string[], build?: ForeignKeyConstraintBuilderCallback): CreateTableBuilder<TB, C>;
152
+ /**
153
+ * This can be used to add any additional SQL to the front of the query __after__ the `create` keyword.
154
+ *
155
+ * Also see {@link temporary}.
156
+ *
157
+ * ### Examples
158
+ *
159
+ * ```ts
160
+ * db.schema.createTable('person')
161
+ * .modifyFront(sql`global temporary`)
162
+ * .addColumn('id', 'integer', col => col => primaryKey())
163
+ * .addColumn('first_name', 'varchar(64)', col => col.notNull())
164
+ * .addColumn('last_name', 'varchar(64), col => col.notNull())
165
+ * .execute()
166
+ * ```
167
+ *
168
+ * The generated SQL (Postgres):
169
+ *
170
+ * ```sql
171
+ * create global temporary table "person" (
172
+ * "id" integer primary key,
173
+ * "first_name" varchar(64) not null,
174
+ * "last_name" varchar(64) not null
175
+ * )
176
+ * ```
177
+ */
178
+ modifyFront(modifier: AnyRawBuilder): CreateTableBuilder<TB, C>;
179
+ /**
180
+ * This can be used to add any additional SQL to the end of the query.
181
+ *
182
+ * Also see {@link onCommit}.
183
+ *
184
+ * ### Examples
185
+ *
186
+ * ```ts
187
+ * db.schema.createTable('person')
188
+ * .addColumn('id', 'integer', col => col => primaryKey())
189
+ * .addColumn('first_name', 'varchar(64)', col => col.notNull())
190
+ * .addColumn('last_name', 'varchar(64), col => col.notNull())
191
+ * .modifyEnd(sql`collate utf8_unicode_ci`)
192
+ * .execute()
193
+ * ```
194
+ *
195
+ * The generated SQL (MySQL):
196
+ *
197
+ * ```sql
198
+ * create table `person` (
199
+ * `id` integer primary key,
200
+ * `first_name` varchar(64) not null,
201
+ * `last_name` varchar(64) not null
202
+ * ) collate utf8_unicode_ci
203
+ * ```
204
+ */
205
+ modifyEnd(modifier: AnyRawBuilder): CreateTableBuilder<TB, C>;
152
206
  toOperationNode(): CreateTableNode;
153
207
  compile(): CompiledQuery;
154
208
  execute(): Promise<void>;
@@ -206,6 +206,70 @@ class CreateTableBuilder {
206
206
  createTableNode: create_table_node_js_1.CreateTableNode.cloneWithConstraint(this.#props.createTableNode, builder.toOperationNode()),
207
207
  });
208
208
  }
209
+ /**
210
+ * This can be used to add any additional SQL to the front of the query __after__ the `create` keyword.
211
+ *
212
+ * Also see {@link temporary}.
213
+ *
214
+ * ### Examples
215
+ *
216
+ * ```ts
217
+ * db.schema.createTable('person')
218
+ * .modifyFront(sql`global temporary`)
219
+ * .addColumn('id', 'integer', col => col => primaryKey())
220
+ * .addColumn('first_name', 'varchar(64)', col => col.notNull())
221
+ * .addColumn('last_name', 'varchar(64), col => col.notNull())
222
+ * .execute()
223
+ * ```
224
+ *
225
+ * The generated SQL (Postgres):
226
+ *
227
+ * ```sql
228
+ * create global temporary table "person" (
229
+ * "id" integer primary key,
230
+ * "first_name" varchar(64) not null,
231
+ * "last_name" varchar(64) not null
232
+ * )
233
+ * ```
234
+ */
235
+ modifyFront(modifier) {
236
+ return new CreateTableBuilder({
237
+ ...this.#props,
238
+ createTableNode: create_table_node_js_1.CreateTableNode.cloneWithFrontModifier(this.#props.createTableNode, modifier.toOperationNode()),
239
+ });
240
+ }
241
+ /**
242
+ * This can be used to add any additional SQL to the end of the query.
243
+ *
244
+ * Also see {@link onCommit}.
245
+ *
246
+ * ### Examples
247
+ *
248
+ * ```ts
249
+ * db.schema.createTable('person')
250
+ * .addColumn('id', 'integer', col => col => primaryKey())
251
+ * .addColumn('first_name', 'varchar(64)', col => col.notNull())
252
+ * .addColumn('last_name', 'varchar(64), col => col.notNull())
253
+ * .modifyEnd(sql`collate utf8_unicode_ci`)
254
+ * .execute()
255
+ * ```
256
+ *
257
+ * The generated SQL (MySQL):
258
+ *
259
+ * ```sql
260
+ * create table `person` (
261
+ * `id` integer primary key,
262
+ * `first_name` varchar(64) not null,
263
+ * `last_name` varchar(64) not null
264
+ * ) collate utf8_unicode_ci
265
+ * ```
266
+ */
267
+ modifyEnd(modifier) {
268
+ return new CreateTableBuilder({
269
+ ...this.#props,
270
+ createTableNode: create_table_node_js_1.CreateTableNode.cloneWithEndModifier(this.#props.createTableNode, modifier.toOperationNode()),
271
+ });
272
+ }
209
273
  toOperationNode() {
210
274
  return this.#props.executor.transformQuery(this.#props.createTableNode, this.#props.queryId);
211
275
  }
@@ -0,0 +1,5 @@
1
+ import { AnyRawBuilder } from './type-utils.js';
2
+ export declare type ExplainFormat = 'text' | 'xml' | 'json' | 'yaml' | 'traditional' | 'tree';
3
+ export interface Explainable {
4
+ explain<O extends Record<string, any> = Record<string, any>>(format?: ExplainFormat, options?: AnyRawBuilder): Promise<O[]>;
5
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -28,6 +28,8 @@ export class MysqlIntrospector {
28
28
  'extra',
29
29
  ])
30
30
  .where('table_schema', '=', sql `database()`)
31
+ .orderBy('table_name')
32
+ .orderBy('column_name')
31
33
  .castTo();
32
34
  if (!options.withInternalKyselyTables) {
33
35
  query = query
@@ -1,6 +1,11 @@
1
1
  import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
2
2
  export declare class MysqlQueryCompiler extends DefaultQueryCompiler {
3
3
  protected getCurrentParameterPlaceholder(): string;
4
+ protected getLeftExplainOptionsWrapper(): string;
5
+ protected getExplainOptionAssignment(): string;
6
+ protected getExplainOptionsDelimiter(): string;
7
+ protected getRightExplainOptionsWrapper(): string;
4
8
  protected getLeftIdentifierWrapper(): string;
5
9
  protected getRightIdentifierWrapper(): string;
10
+ protected sanitizeIdentifier(identifier: string): string;
6
11
  }
@@ -1,13 +1,29 @@
1
1
  /// <reference types="./mysql-query-compiler.d.ts" />
2
2
  import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
3
+ const ID_WRAP_REGEX = /`/g;
3
4
  export class MysqlQueryCompiler extends DefaultQueryCompiler {
4
5
  getCurrentParameterPlaceholder() {
5
6
  return '?';
6
7
  }
8
+ getLeftExplainOptionsWrapper() {
9
+ return '';
10
+ }
11
+ getExplainOptionAssignment() {
12
+ return '=';
13
+ }
14
+ getExplainOptionsDelimiter() {
15
+ return ' ';
16
+ }
17
+ getRightExplainOptionsWrapper() {
18
+ return '';
19
+ }
7
20
  getLeftIdentifierWrapper() {
8
21
  return '`';
9
22
  }
10
23
  getRightIdentifierWrapper() {
11
24
  return '`';
12
25
  }
26
+ sanitizeIdentifier(identifier) {
27
+ return identifier.replace(ID_WRAP_REGEX, '``');
28
+ }
13
29
  }
@@ -19,7 +19,10 @@ export class PostgresIntrospector {
19
19
  let query = this.#db
20
20
  .selectFrom('pg_catalog.pg_attribute as a')
21
21
  .innerJoin('pg_catalog.pg_class as c', 'a.attrelid', 'c.oid')
22
- .innerJoin('pg_catalog.pg_tables as t', 't.tablename', 'c.relname')
22
+ .innerJoin('pg_catalog.pg_namespace as ns', 'c.relnamespace', 'ns.oid')
23
+ .innerJoin('pg_catalog.pg_tables as t', (join) => join
24
+ .onRef('t.tablename', '=', 'c.relname')
25
+ .onRef('t.schemaname', '=', 'ns.nspname'))
23
26
  .innerJoin('pg_catalog.pg_type as typ', 'a.atttypid', 'typ.oid')
24
27
  .select([
25
28
  'a.attname as column',
@@ -41,6 +44,9 @@ export class PostgresIntrospector {
41
44
  .where('t.schemaname', '!=', 'information_schema')
42
45
  .where('a.attnum', '>=', 0) // No system columns
43
46
  .where('a.attisdropped', '!=', true)
47
+ .orderBy('t.schemaname')
48
+ .orderBy('t.tablename')
49
+ .orderBy('a.attname')
44
50
  .castTo();
45
51
  if (!options.withInternalKyselyTables) {
46
52
  query = query
@@ -1,6 +1,4 @@
1
1
  import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
2
2
  export declare class PostgresQueryCompiler extends DefaultQueryCompiler {
3
- protected getCurrentParameterPlaceholder(): string;
4
- protected getLeftIdentifierWrapper(): string;
5
- protected getRightIdentifierWrapper(): string;
3
+ protected sanitizeIdentifier(identifier: string): string;
6
4
  }
@@ -1,13 +1,8 @@
1
1
  /// <reference types="./postgres-query-compiler.d.ts" />
2
2
  import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
3
+ const ID_WRAP_REGEX = /"/g;
3
4
  export class PostgresQueryCompiler extends DefaultQueryCompiler {
4
- getCurrentParameterPlaceholder() {
5
- return '$' + this.numParameters;
6
- }
7
- getLeftIdentifierWrapper() {
8
- return '"';
9
- }
10
- getRightIdentifierWrapper() {
11
- return '"';
5
+ sanitizeIdentifier(identifier) {
6
+ return identifier.replace(ID_WRAP_REGEX, '""');
12
7
  }
13
8
  }
@@ -16,6 +16,7 @@ export class SqliteIntrospector {
16
16
  .where('type', '=', 'table')
17
17
  .where('name', 'not like', 'sqlite_%')
18
18
  .select('name')
19
+ .orderBy('name')
19
20
  .castTo();
20
21
  if (!options.withInternalKyselyTables) {
21
22
  query = query
@@ -48,6 +49,7 @@ export class SqliteIntrospector {
48
49
  const columns = await db
49
50
  .selectFrom(sql `pragma_table_info(${table})`.as('table_info'))
50
51
  .select(['name', 'type', 'notnull', 'dflt_value'])
52
+ .orderBy('name')
51
53
  .execute();
52
54
  return {
53
55
  name: table,
@@ -1,7 +1,10 @@
1
1
  import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
2
2
  export declare class SqliteQueryCompiler extends DefaultQueryCompiler {
3
3
  protected getCurrentParameterPlaceholder(): string;
4
+ protected getLeftExplainOptionsWrapper(): string;
5
+ protected getRightExplainOptionsWrapper(): string;
4
6
  protected getLeftIdentifierWrapper(): string;
5
7
  protected getRightIdentifierWrapper(): string;
6
8
  protected getAutoIncrement(): string;
9
+ protected sanitizeIdentifier(identifier: string): string;
7
10
  }
@@ -1,9 +1,16 @@
1
1
  /// <reference types="./sqlite-query-compiler.d.ts" />
2
2
  import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
3
+ const ID_WRAP_REGEX = /"/g;
3
4
  export class SqliteQueryCompiler extends DefaultQueryCompiler {
4
5
  getCurrentParameterPlaceholder() {
5
6
  return '?';
6
7
  }
8
+ getLeftExplainOptionsWrapper() {
9
+ return '';
10
+ }
11
+ getRightExplainOptionsWrapper() {
12
+ return '';
13
+ }
7
14
  getLeftIdentifierWrapper() {
8
15
  return '"';
9
16
  }
@@ -13,4 +20,7 @@ export class SqliteQueryCompiler extends DefaultQueryCompiler {
13
20
  getAutoIncrement() {
14
21
  return 'autoincrement';
15
22
  }
23
+ sanitizeIdentifier(identifier) {
24
+ return identifier.replace(ID_WRAP_REGEX, '""');
25
+ }
16
26
  }
@@ -149,8 +149,10 @@ export * from './operation-node/value-node.js';
149
149
  export * from './operation-node/values-node.js';
150
150
  export * from './operation-node/where-node.js';
151
151
  export * from './operation-node/with-node.js';
152
+ export * from './operation-node/explain-node.js';
152
153
  export * from './util/column-type.js';
153
154
  export * from './util/compilable.js';
155
+ export * from './util/explainable.js';
154
156
  export * from './util/log.js';
155
157
  export { AnyColumn, UnknownRow, AnySelectQueryBuilder, } from './util/type-utils.js';
156
158
  export { SelectExpression, SelectExpressionOrList, Selection, } from './parser/select-parser.js';
package/dist/esm/index.js CHANGED
@@ -150,6 +150,8 @@ export * from './operation-node/value-node.js';
150
150
  export * from './operation-node/values-node.js';
151
151
  export * from './operation-node/where-node.js';
152
152
  export * from './operation-node/with-node.js';
153
+ export * from './operation-node/explain-node.js';
153
154
  export * from './util/column-type.js';
154
155
  export * from './util/compilable.js';
156
+ export * from './util/explainable.js';
155
157
  export * from './util/log.js';
@@ -3,9 +3,10 @@ import { TableNode } from './table-node.js';
3
3
  import { ConstraintNode } from './constraint-node.js';
4
4
  import { ColumnDefinitionNode } from './column-definition-node.js';
5
5
  import { ArrayItemType } from '../util/type-utils.js';
6
+ import { RawNode } from './raw-node.js';
6
7
  export declare const ON_COMMIT_ACTIONS: string[];
7
8
  export declare type OnCommitAction = ArrayItemType<typeof ON_COMMIT_ACTIONS>;
8
- export declare type CreateTableNodeParams = Omit<CreateTableNode, 'kind' | 'table' | 'columns' | 'constraints'>;
9
+ export declare type CreateTableNodeParams = Omit<CreateTableNode, 'kind' | 'table' | 'columns' | 'constraints' | 'frontModifiers' | 'endModifiers'>;
9
10
  export interface CreateTableNode extends OperationNode {
10
11
  readonly kind: 'CreateTableNode';
11
12
  readonly table: TableNode;
@@ -14,6 +15,8 @@ export interface CreateTableNode extends OperationNode {
14
15
  readonly temporary?: boolean;
15
16
  readonly ifNotExists?: boolean;
16
17
  readonly onCommit?: OnCommitAction;
18
+ readonly frontModifiers?: ReadonlyArray<RawNode>;
19
+ readonly endModifiers?: ReadonlyArray<RawNode>;
17
20
  }
18
21
  /**
19
22
  * @internal
@@ -23,5 +26,7 @@ export declare const CreateTableNode: Readonly<{
23
26
  create(table: TableNode): CreateTableNode;
24
27
  cloneWithColumn(createTable: CreateTableNode, column: ColumnDefinitionNode): CreateTableNode;
25
28
  cloneWithConstraint(createTable: CreateTableNode, constraint: ConstraintNode): CreateTableNode;
29
+ cloneWithFrontModifier(createTable: CreateTableNode, modifier: RawNode): CreateTableNode;
30
+ cloneWithEndModifier(createTable: CreateTableNode, modifier: RawNode): CreateTableNode;
26
31
  cloneWith(createTable: CreateTableNode, params: CreateTableNodeParams): CreateTableNode;
27
32
  }>;
@@ -29,6 +29,22 @@ export const CreateTableNode = freeze({
29
29
  : freeze([constraint]),
30
30
  });
31
31
  },
32
+ cloneWithFrontModifier(createTable, modifier) {
33
+ return freeze({
34
+ ...createTable,
35
+ frontModifiers: createTable.frontModifiers
36
+ ? freeze([...createTable.frontModifiers, modifier])
37
+ : freeze([modifier]),
38
+ });
39
+ },
40
+ cloneWithEndModifier(createTable, modifier) {
41
+ return freeze({
42
+ ...createTable,
43
+ endModifiers: createTable.endModifiers
44
+ ? freeze([...createTable.endModifiers, modifier])
45
+ : freeze([modifier]),
46
+ });
47
+ },
32
48
  cloneWith(createTable, params) {
33
49
  return freeze({
34
50
  ...createTable,
@@ -8,6 +8,7 @@ import { WithNode } from './with-node.js';
8
8
  import { LimitNode } from './limit-node.js';
9
9
  import { OrderByNode } from './order-by-node.js';
10
10
  import { OrderByItemNode } from './order-by-item-node.js';
11
+ import { ExplainNode } from './explain-node.js';
11
12
  export interface DeleteQueryNode extends OperationNode {
12
13
  readonly kind: 'DeleteQueryNode';
13
14
  readonly from: FromNode;
@@ -17,6 +18,7 @@ export interface DeleteQueryNode extends OperationNode {
17
18
  readonly with?: WithNode;
18
19
  readonly orderBy?: OrderByNode;
19
20
  readonly limit?: LimitNode;
21
+ readonly explain?: ExplainNode;
20
22
  }
21
23
  /**
22
24
  * @internal
@@ -26,4 +28,5 @@ export declare const DeleteQueryNode: Readonly<{
26
28
  create(fromItem: TableExpressionNode, withNode?: WithNode): DeleteQueryNode;
27
29
  cloneWithOrderByItem(deleteNode: DeleteQueryNode, item: OrderByItemNode): DeleteQueryNode;
28
30
  cloneWithLimit(deleteNode: DeleteQueryNode, limit: LimitNode): DeleteQueryNode;
31
+ cloneWithExplain(deleteNode: DeleteQueryNode, explain: ExplainNode): DeleteQueryNode;
29
32
  }>;
@@ -30,4 +30,10 @@ export const DeleteQueryNode = freeze({
30
30
  limit,
31
31
  });
32
32
  },
33
+ cloneWithExplain(deleteNode, explain) {
34
+ return freeze({
35
+ ...deleteNode,
36
+ explain,
37
+ });
38
+ },
33
39
  });
@@ -0,0 +1,16 @@
1
+ import { ExplainFormat } from '../util/explainable.js';
2
+ import { AnyRawBuilder } from '../util/type-utils.js';
3
+ import { OperationNode } from './operation-node.js';
4
+ import { RawNode } from './raw-node.js';
5
+ export interface ExplainNode extends OperationNode {
6
+ readonly kind: 'ExplainNode';
7
+ readonly format?: ExplainFormat;
8
+ readonly options?: RawNode;
9
+ }
10
+ /**
11
+ * @internal
12
+ */
13
+ export declare const ExplainNode: Readonly<{
14
+ is(node: OperationNode): node is ExplainNode;
15
+ create(format?: ExplainFormat, options?: AnyRawBuilder): ExplainNode;
16
+ }>;
@@ -0,0 +1,17 @@
1
+ /// <reference types="./explain-node.d.ts" />
2
+ import { freeze } from '../util/object-utils.js';
3
+ /**
4
+ * @internal
5
+ */
6
+ export const ExplainNode = freeze({
7
+ is(node) {
8
+ return node.kind === 'ExplainNode';
9
+ },
10
+ create(format, options) {
11
+ return freeze({
12
+ kind: 'ExplainNode',
13
+ format,
14
+ options: options?.toOperationNode(),
15
+ });
16
+ },
17
+ });
@@ -1,4 +1,5 @@
1
1
  import { ColumnNode } from './column-node.js';
2
+ import { ExplainNode } from './explain-node.js';
2
3
  import { OnConflictNode } from './on-conflict-node.js';
3
4
  import { OnDuplicateKeyNode } from './on-duplicate-key-node.js';
4
5
  import { OperationNode } from './operation-node.js';
@@ -20,6 +21,7 @@ export interface InsertQueryNode extends OperationNode {
20
21
  readonly with?: WithNode;
21
22
  readonly ignore?: boolean;
22
23
  readonly replace?: boolean;
24
+ readonly explain?: ExplainNode;
23
25
  }
24
26
  /**
25
27
  * @internal
@@ -68,6 +68,7 @@ import { ValuesNode } from './values-node.js';
68
68
  import { SelectModifierNode } from './select-modifier-node.js';
69
69
  import { CreateTypeNode } from './create-type-node.js';
70
70
  import { DropTypeNode } from './drop-type-node.js';
71
+ import { ExplainNode } from './explain-node.js';
71
72
  /**
72
73
  * Transforms an operation node tree into another one.
73
74
  *
@@ -172,4 +173,5 @@ export declare class OperationNodeTransformer {
172
173
  protected transformValue(node: ValueNode): ValueNode;
173
174
  protected transformPrimitiveValueList(node: PrimitiveValueListNode): PrimitiveValueListNode;
174
175
  protected transformOperator(node: OperatorNode): OperatorNode;
176
+ protected transformExplain(node: ExplainNode): ExplainNode;
175
177
  }
@@ -102,6 +102,7 @@ export class OperationNodeTransformer {
102
102
  SelectModifierNode: this.transformSelectModifier.bind(this),
103
103
  CreateTypeNode: this.transformCreateType.bind(this),
104
104
  DropTypeNode: this.transformDropType.bind(this),
105
+ ExplainNode: this.transformExplain.bind(this),
105
106
  });
106
107
  transformNode = (node) => {
107
108
  if (!node) {
@@ -135,6 +136,7 @@ export class OperationNodeTransformer {
135
136
  with: this.transformNode(node.with),
136
137
  having: this.transformNode(node.having),
137
138
  union: this.transformNodeList(node.union),
139
+ explain: this.transformNode(node.explain),
138
140
  });
139
141
  }
140
142
  transformSelection(node) {
@@ -243,6 +245,7 @@ export class OperationNodeTransformer {
243
245
  with: this.transformNode(node.with),
244
246
  ignore: node.ignore,
245
247
  replace: node.replace,
248
+ explain: this.transformNode(node.explain),
246
249
  });
247
250
  }
248
251
  transformValues(node) {
@@ -261,6 +264,7 @@ export class OperationNodeTransformer {
261
264
  with: this.transformNode(node.with),
262
265
  orderBy: this.transformNode(node.orderBy),
263
266
  limit: this.transformNode(node.limit),
267
+ explain: this.transformNode(node.explain),
264
268
  });
265
269
  }
266
270
  transformReturning(node) {
@@ -278,6 +282,8 @@ export class OperationNodeTransformer {
278
282
  temporary: node.temporary,
279
283
  ifNotExists: node.ifNotExists,
280
284
  onCommit: node.onCommit,
285
+ frontModifiers: this.transformNodeList(node.frontModifiers),
286
+ endModifiers: this.transformNodeList(node.endModifiers),
281
287
  });
282
288
  }
283
289
  transformColumnDefinition(node) {
@@ -344,6 +350,7 @@ export class OperationNodeTransformer {
344
350
  updates: this.transformNodeList(node.updates),
345
351
  returning: this.transformNode(node.returning),
346
352
  with: this.transformNode(node.with),
353
+ explain: this.transformNode(node.explain),
347
354
  });
348
355
  }
349
356
  transformColumnUpdate(node) {
@@ -642,4 +649,11 @@ export class OperationNodeTransformer {
642
649
  // An Object.freezed leaf node. No need to clone.
643
650
  return node;
644
651
  }
652
+ transformExplain(node) {
653
+ return requireAllProps({
654
+ kind: 'ExplainNode',
655
+ format: node.format,
656
+ options: this.transformNode(node.options),
657
+ });
658
+ }
645
659
  }
@@ -68,6 +68,7 @@ import { ValuesNode } from './values-node.js';
68
68
  import { SelectModifierNode } from './select-modifier-node.js';
69
69
  import { CreateTypeNode } from './create-type-node.js';
70
70
  import { DropTypeNode } from './drop-type-node.js';
71
+ import { ExplainNode } from './explain-node.js';
71
72
  export declare abstract class OperationNodeVisitor {
72
73
  #private;
73
74
  protected readonly nodeStack: OperationNode[];
@@ -142,4 +143,5 @@ export declare abstract class OperationNodeVisitor {
142
143
  protected abstract visitSelectModifier(node: SelectModifierNode): void;
143
144
  protected abstract visitCreateType(node: CreateTypeNode): void;
144
145
  protected abstract visitDropType(node: DropTypeNode): void;
146
+ protected abstract visitExplain(node: ExplainNode): void;
145
147
  }
@@ -75,6 +75,7 @@ export class OperationNodeVisitor {
75
75
  SelectModifierNode: this.visitSelectModifier.bind(this),
76
76
  CreateTypeNode: this.visitCreateType.bind(this),
77
77
  DropTypeNode: this.visitDropType.bind(this),
78
+ ExplainNode: this.visitExplain.bind(this),
78
79
  });
79
80
  visitNode = (node) => {
80
81
  this.nodeStack.push(node);