kysely 0.10.1 → 0.11.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 (134) hide show
  1. package/README.md +7 -3
  2. package/dist/cjs/dialect/dialect-adapter.d.ts +3 -2
  3. package/dist/cjs/dialect/mysql/mysql-adapter.js +1 -1
  4. package/dist/cjs/dialect/mysql/mysql-dialect.d.ts +3 -3
  5. package/dist/cjs/dialect/mysql/mysql-driver.js +25 -32
  6. package/dist/cjs/dialect/postgres/postgres-dialect.d.ts +2 -2
  7. package/dist/cjs/dialect/postgres/postgres-driver.js +8 -19
  8. package/dist/cjs/dialect/sqlite/sqlite-adapter.d.ts +7 -0
  9. package/dist/cjs/dialect/sqlite/sqlite-adapter.js +18 -0
  10. package/dist/cjs/dialect/sqlite/sqlite-dialect.d.ts +64 -0
  11. package/dist/cjs/dialect/sqlite/sqlite-dialect.js +33 -0
  12. package/dist/cjs/dialect/sqlite/sqlite-driver.d.ts +14 -0
  13. package/dist/cjs/dialect/sqlite/sqlite-driver.js +116 -0
  14. package/dist/cjs/dialect/sqlite/sqlite-introspector.d.ts +7 -0
  15. package/dist/cjs/dialect/sqlite/sqlite-introspector.js +31 -0
  16. package/dist/cjs/dialect/sqlite/sqlite-query-compiler.d.ts +7 -0
  17. package/dist/cjs/dialect/sqlite/sqlite-query-compiler.js +19 -0
  18. package/dist/cjs/driver/database-connection.d.ts +2 -2
  19. package/dist/cjs/index.d.ts +8 -0
  20. package/dist/cjs/index.js +8 -0
  21. package/dist/cjs/kysely.d.ts +6 -4
  22. package/dist/cjs/kysely.js +6 -4
  23. package/dist/cjs/migration/migration.d.ts +1 -1
  24. package/dist/cjs/migration/migration.js +3 -3
  25. package/dist/cjs/operation-node/create-view-node.d.ts +1 -0
  26. package/dist/cjs/operation-node/having-node.d.ts +4 -8
  27. package/dist/cjs/operation-node/having-node.js +3 -3
  28. package/dist/cjs/operation-node/join-node.d.ts +6 -9
  29. package/dist/cjs/operation-node/join-node.js +10 -7
  30. package/dist/cjs/operation-node/on-node.d.ts +14 -0
  31. package/dist/cjs/operation-node/on-node.js +28 -0
  32. package/dist/cjs/operation-node/operation-node-transformer.d.ts +2 -0
  33. package/dist/cjs/operation-node/operation-node-transformer.js +8 -0
  34. package/dist/cjs/operation-node/operation-node-visitor.d.ts +3 -0
  35. package/dist/cjs/operation-node/operation-node-visitor.js +4 -0
  36. package/dist/cjs/operation-node/operation-node.d.ts +1 -1
  37. package/dist/cjs/operation-node/query-node.d.ts +3 -3
  38. package/dist/cjs/operation-node/select-query-node.d.ts +4 -4
  39. package/dist/cjs/operation-node/where-node.d.ts +4 -8
  40. package/dist/cjs/operation-node/where-node.js +3 -3
  41. package/dist/cjs/parser/filter-parser.js +1 -1
  42. package/dist/cjs/parser/returning-parser.d.ts +4 -2
  43. package/dist/cjs/parser/select-parser.d.ts +2 -2
  44. package/dist/cjs/plugin/immediate-value.ts/immediate-value-plugin.d.ts +1 -1
  45. package/dist/cjs/query-builder/delete-result.d.ts +5 -0
  46. package/dist/cjs/query-builder/delete-result.js +13 -0
  47. package/dist/cjs/query-builder/expression-builder.d.ts +2 -2
  48. package/dist/cjs/query-builder/expression-builder.js +1 -1
  49. package/dist/cjs/query-builder/function-builder.d.ts +5 -5
  50. package/dist/cjs/query-builder/function-builder.js +3 -3
  51. package/dist/cjs/query-builder/insert-result.d.ts +27 -0
  52. package/dist/cjs/query-builder/insert-result.js +35 -0
  53. package/dist/cjs/query-builder/query-builder.d.ts +91 -81
  54. package/dist/cjs/query-builder/query-builder.js +38 -41
  55. package/dist/cjs/query-builder/update-result.d.ts +5 -0
  56. package/dist/cjs/query-builder/update-result.js +13 -0
  57. package/dist/cjs/query-compiler/compiled-query.d.ts +5 -0
  58. package/dist/cjs/query-compiler/compiled-query.js +12 -0
  59. package/dist/cjs/query-compiler/default-query-compiler.d.ts +2 -0
  60. package/dist/cjs/query-compiler/default-query-compiler.js +24 -13
  61. package/dist/cjs/query-creator.d.ts +36 -26
  62. package/dist/cjs/query-creator.js +25 -17
  63. package/dist/cjs/schema/create-view-builder.d.ts +4 -0
  64. package/dist/cjs/schema/create-view-builder.js +11 -0
  65. package/dist/cjs/util/dynamic-import.d.ts +2 -0
  66. package/dist/cjs/util/dynamic-import.js +32 -0
  67. package/dist/cjs/util/type-utils.d.ts +4 -15
  68. package/dist/esm/dialect/dialect-adapter.d.ts +3 -2
  69. package/dist/esm/dialect/mysql/mysql-adapter.js +1 -1
  70. package/dist/esm/dialect/mysql/mysql-dialect.d.ts +3 -3
  71. package/dist/esm/dialect/mysql/mysql-driver.js +26 -33
  72. package/dist/esm/dialect/postgres/postgres-dialect.d.ts +2 -2
  73. package/dist/esm/dialect/postgres/postgres-driver.js +8 -19
  74. package/dist/esm/dialect/sqlite/sqlite-adapter.d.ts +7 -0
  75. package/dist/esm/dialect/sqlite/sqlite-adapter.js +14 -0
  76. package/dist/esm/dialect/sqlite/sqlite-dialect.d.ts +64 -0
  77. package/dist/esm/dialect/sqlite/sqlite-dialect.js +29 -0
  78. package/dist/esm/dialect/sqlite/sqlite-driver.d.ts +14 -0
  79. package/dist/esm/dialect/sqlite/sqlite-driver.js +112 -0
  80. package/dist/esm/dialect/sqlite/sqlite-introspector.d.ts +7 -0
  81. package/dist/esm/dialect/sqlite/sqlite-introspector.js +27 -0
  82. package/dist/esm/dialect/sqlite/sqlite-query-compiler.d.ts +7 -0
  83. package/dist/esm/dialect/sqlite/sqlite-query-compiler.js +15 -0
  84. package/dist/esm/driver/database-connection.d.ts +2 -2
  85. package/dist/esm/index.d.ts +8 -0
  86. package/dist/esm/index.js +8 -0
  87. package/dist/esm/kysely.d.ts +6 -4
  88. package/dist/esm/kysely.js +6 -4
  89. package/dist/esm/migration/migration.d.ts +1 -1
  90. package/dist/esm/migration/migration.js +3 -3
  91. package/dist/esm/operation-node/create-view-node.d.ts +1 -0
  92. package/dist/esm/operation-node/having-node.d.ts +4 -8
  93. package/dist/esm/operation-node/having-node.js +3 -3
  94. package/dist/esm/operation-node/join-node.d.ts +6 -9
  95. package/dist/esm/operation-node/join-node.js +10 -7
  96. package/dist/esm/operation-node/on-node.d.ts +14 -0
  97. package/dist/esm/operation-node/on-node.js +25 -0
  98. package/dist/esm/operation-node/operation-node-transformer.d.ts +2 -0
  99. package/dist/esm/operation-node/operation-node-transformer.js +8 -0
  100. package/dist/esm/operation-node/operation-node-visitor.d.ts +3 -0
  101. package/dist/esm/operation-node/operation-node-visitor.js +4 -0
  102. package/dist/esm/operation-node/operation-node.d.ts +1 -1
  103. package/dist/esm/operation-node/query-node.d.ts +3 -3
  104. package/dist/esm/operation-node/select-query-node.d.ts +4 -4
  105. package/dist/esm/operation-node/where-node.d.ts +4 -8
  106. package/dist/esm/operation-node/where-node.js +3 -3
  107. package/dist/esm/parser/filter-parser.js +1 -1
  108. package/dist/esm/parser/returning-parser.d.ts +4 -2
  109. package/dist/esm/parser/select-parser.d.ts +2 -2
  110. package/dist/esm/plugin/immediate-value.ts/immediate-value-plugin.d.ts +1 -1
  111. package/dist/esm/query-builder/delete-result.d.ts +5 -0
  112. package/dist/esm/query-builder/delete-result.js +9 -0
  113. package/dist/esm/query-builder/expression-builder.d.ts +2 -2
  114. package/dist/esm/query-builder/expression-builder.js +1 -1
  115. package/dist/esm/query-builder/function-builder.d.ts +5 -5
  116. package/dist/esm/query-builder/function-builder.js +3 -3
  117. package/dist/esm/query-builder/insert-result.d.ts +27 -0
  118. package/dist/esm/query-builder/insert-result.js +31 -0
  119. package/dist/esm/query-builder/query-builder.d.ts +91 -81
  120. package/dist/esm/query-builder/query-builder.js +38 -41
  121. package/dist/esm/query-builder/update-result.d.ts +5 -0
  122. package/dist/esm/query-builder/update-result.js +9 -0
  123. package/dist/esm/query-compiler/compiled-query.d.ts +5 -0
  124. package/dist/esm/query-compiler/compiled-query.js +11 -1
  125. package/dist/esm/query-compiler/default-query-compiler.d.ts +2 -0
  126. package/dist/esm/query-compiler/default-query-compiler.js +24 -13
  127. package/dist/esm/query-creator.d.ts +36 -26
  128. package/dist/esm/query-creator.js +25 -17
  129. package/dist/esm/schema/create-view-builder.d.ts +4 -0
  130. package/dist/esm/schema/create-view-builder.js +11 -0
  131. package/dist/esm/util/dynamic-import.d.ts +2 -0
  132. package/dist/esm/util/dynamic-import.js +27 -0
  133. package/dist/esm/util/type-utils.d.ts +4 -15
  134. package/package.json +3 -1
@@ -1,18 +1,14 @@
1
- import { AndNode } from './and-node.js';
2
- import { FilterNode } from './filter-node.js';
1
+ import { FilterExpressionNode } from './operation-node-utils.js';
3
2
  import { OperationNode } from './operation-node.js';
4
- import { OrNode } from './or-node.js';
5
- import { ParensNode } from './parens-node.js';
6
- export declare type WhereChildNode = FilterNode | AndNode | OrNode | ParensNode;
7
3
  export interface WhereNode extends OperationNode {
8
4
  readonly kind: 'WhereNode';
9
- readonly where: WhereChildNode;
5
+ readonly where: FilterExpressionNode;
10
6
  }
11
7
  /**
12
8
  * @internal
13
9
  */
14
10
  export declare const WhereNode: Readonly<{
15
11
  is(node: OperationNode): node is WhereNode;
16
- create(filter: WhereChildNode): WhereNode;
17
- cloneWithFilter(whereNode: WhereNode, op: 'And' | 'Or', where: WhereChildNode): WhereNode;
12
+ create(filter: FilterExpressionNode): WhereNode;
13
+ cloneWithFilter(whereNode: WhereNode, op: 'And' | 'Or', filter: FilterExpressionNode): WhereNode;
18
14
  }>;
@@ -14,12 +14,12 @@ export const WhereNode = freeze({
14
14
  where: filter,
15
15
  });
16
16
  },
17
- cloneWithFilter(whereNode, op, where) {
17
+ cloneWithFilter(whereNode, op, filter) {
18
18
  return freeze({
19
19
  ...whereNode,
20
20
  where: op === 'And'
21
- ? AndNode.create(whereNode.where, where)
22
- : OrNode.create(whereNode.where, where),
21
+ ? AndNode.create(whereNode.where, filter)
22
+ : OrNode.create(whereNode.where, filter),
23
23
  });
24
24
  },
25
25
  });
@@ -92,7 +92,7 @@ function parseOnGroup(ctx, callback) {
92
92
  if (!joinNode.on) {
93
93
  throw new Error('no `on*` methods called insided a group callback');
94
94
  }
95
- return ParensNode.create(joinNode.on);
95
+ return ParensNode.create(joinNode.on.on);
96
96
  }
97
97
  function parseExistExpression(ctx, type, arg) {
98
98
  const node = isFunction(arg)
@@ -1,7 +1,9 @@
1
+ import { DeleteResult } from '../query-builder/delete-result.js';
2
+ import { InsertResult } from '../query-builder/insert-result.js';
1
3
  import { QueryBuilder } from '../query-builder/query-builder.js';
2
- import { DeleteResultTypeTag, InsertResultTypeTag, UpdateResultTypeTag } from '../util/type-utils.js';
4
+ import { UpdateResult } from '../query-builder/update-result.js';
3
5
  import { Selection } from './select-parser.js';
4
6
  /**
5
7
  * `returning` method output query builder type
6
8
  */
7
- export declare type QueryBuilderWithReturning<DB, TB extends keyof DB, O, S> = QueryBuilder<DB, TB, O extends InsertResultTypeTag ? Selection<DB, TB, S> : O extends DeleteResultTypeTag ? Selection<DB, TB, S> : O extends UpdateResultTypeTag ? Selection<DB, TB, S> : O & Selection<DB, TB, S>>;
9
+ export declare type QueryBuilderWithReturning<DB, TB extends keyof DB, O, S> = QueryBuilder<DB, TB, O extends InsertResult ? Selection<DB, TB, S> : O extends DeleteResult ? Selection<DB, TB, S> : O extends UpdateResult ? Selection<DB, TB, S> : O & Selection<DB, TB, S>>;
@@ -1,7 +1,7 @@
1
1
  import { AliasedRawBuilder } from '../raw-builder/raw-builder.js';
2
2
  import { AliasedQueryBuilder, QueryBuilder } from '../query-builder/query-builder.js';
3
3
  import { SelectionNode } from '../operation-node/selection-node.js';
4
- import { AliasedQueryBuilderFactory, AliasedRawBuilderFactory, AnyAliasedColumn, AnyAliasedColumnWithTable, AnyAliasedQueryBuilder, AnyAliasedRawBuilder, AnyColumn, AnyColumnWithTable, InsertResultTypeTag, RowType, ValueType } from '../util/type-utils.js';
4
+ import { AliasedQueryBuilderFactory, AliasedRawBuilderFactory, AnyAliasedColumn, AnyAliasedColumnWithTable, AnyAliasedQueryBuilder, AnyAliasedRawBuilder, AnyColumn, AnyColumnWithTable, RowType, ValueType } from '../util/type-utils.js';
5
5
  import { DynamicReferenceBuilder } from '../dynamic/dynamic-reference-builder.js';
6
6
  import { ParseContext } from './parse-context.js';
7
7
  /**
@@ -13,7 +13,7 @@ export declare type SelectExpressionOrList<DB, TB extends keyof DB> = SelectExpr
13
13
  * Given a selection expression returns a query builder type that
14
14
  * has the selection.
15
15
  */
16
- export declare type QueryBuilderWithSelection<DB, TB extends keyof DB, O, S> = QueryBuilder<DB, TB, O extends InsertResultTypeTag ? InsertResultTypeTag : O & Selection<DB, TB, S>>;
16
+ export declare type QueryBuilderWithSelection<DB, TB extends keyof DB, O, S> = QueryBuilder<DB, TB, O & Selection<DB, TB, S>>;
17
17
  /**
18
18
  * `selectAll` output query builder type.
19
19
  */
@@ -1,6 +1,6 @@
1
1
  import { QueryResult } from '../../driver/database-connection.js';
2
- import { UnknownRow } from '../../index.js';
3
2
  import { RootOperationNode } from '../../query-compiler/query-compiler.js';
3
+ import { UnknownRow } from '../../util/type-utils.js';
4
4
  import { KyselyPlugin, PluginTransformQueryArgs, PluginTransformResultArgs } from '../kysely-plugin.js';
5
5
  /**
6
6
  * Transforms all ValueNodes to immediate.
@@ -0,0 +1,5 @@
1
+ export declare class DeleteResult {
2
+ #private;
3
+ constructor(numDeletedRows: bigint);
4
+ get numDeletedRows(): bigint;
5
+ }
@@ -0,0 +1,9 @@
1
+ export class DeleteResult {
2
+ #numDeletedRows;
3
+ constructor(numDeletedRows) {
4
+ this.#numDeletedRows = numDeletedRows;
5
+ }
6
+ get numDeletedRows() {
7
+ return this.#numDeletedRows;
8
+ }
9
+ }
@@ -26,7 +26,7 @@ export declare class ExpressionBuilder<DB, TB extends keyof DB> {
26
26
  * .execute()
27
27
  * ```
28
28
  *
29
- * The generated SQL (postgresql):
29
+ * The generated SQL (PostgreSQL):
30
30
  *
31
31
  * ```sql
32
32
  * select "person"."id", count("pet"."id") as "pet_count"
@@ -62,7 +62,7 @@ export declare class ExpressionBuilder<DB, TB extends keyof DB> {
62
62
  * console.log(result[0].owner_name)
63
63
  * ```
64
64
  *
65
- * The generated SQL (postgresql):
65
+ * The generated SQL (PostgreSQL):
66
66
  *
67
67
  * ```sql
68
68
  * select
@@ -31,7 +31,7 @@ export class ExpressionBuilder {
31
31
  * .execute()
32
32
  * ```
33
33
  *
34
- * The generated SQL (postgresql):
34
+ * The generated SQL (PostgreSQL):
35
35
  *
36
36
  * ```sql
37
37
  * select "person"."id", count("pet"."id") as "pet_count"
@@ -19,7 +19,7 @@ import { RawBuilder } from '../raw-builder/raw-builder.js';
19
19
  * .execute()
20
20
  * ```
21
21
  *
22
- * The generated SQL (postgresql):
22
+ * The generated SQL (PostgreSQL):
23
23
  *
24
24
  * ```sql
25
25
  * select "person"."id", count("pet"."id") as "pet_count"
@@ -66,7 +66,7 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
66
66
  * Calls the `sum` function for the column given as the argument.
67
67
  *
68
68
  * If this is used in a `select` statement the type of the selected expression
69
- * will be `number | string | BigInt` by default. This is because Kysely can't
69
+ * will be `number | string | bigint` by default. This is because Kysely can't
70
70
  * know the type the db driver outputs. Sometimes the output can be larger than
71
71
  * the largest javascript number and a string is returned instead. Most drivers
72
72
  * allow you to configure the output type of large numbers and Kysely can't
@@ -83,12 +83,12 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
83
83
  * .execute()
84
84
  * ```
85
85
  */
86
- sum<O extends number | string | BigInt, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
86
+ sum<O extends number | string | bigint, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
87
87
  /**
88
88
  * Calls the `count` function for the column given as the argument.
89
89
  *
90
90
  * If this is used in a `select` statement the type of the selected expression
91
- * will be `number | string | BigInt` by default. This is because Kysely can't
91
+ * will be `number | string |bigint` by default. This is because Kysely can't
92
92
  * know the type the db driver outputs. Sometimes the output can be larger than
93
93
  * the largest javascript number and a string is returned instead. Most drivers
94
94
  * allow you to configure the output type of large numbers and Kysely can't
@@ -105,7 +105,7 @@ export declare class FunctionBuilder<DB, TB extends keyof DB> {
105
105
  * .execute()
106
106
  * ```
107
107
  */
108
- count<O extends number | string | BigInt, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
108
+ count<O extends number | string | bigint, C extends StringReference<DB, TB> = any>(column: C): RawBuilder<O>;
109
109
  }
110
110
  export interface FunctionBuilderProps {
111
111
  readonly executor: QueryExecutor;
@@ -19,7 +19,7 @@ import { createQueryId } from '../util/query-id.js';
19
19
  * .execute()
20
20
  * ```
21
21
  *
22
- * The generated SQL (postgresql):
22
+ * The generated SQL (PostgreSQL):
23
23
  *
24
24
  * ```sql
25
25
  * select "person"."id", count("pet"."id") as "pet_count"
@@ -79,7 +79,7 @@ export class FunctionBuilder {
79
79
  * Calls the `sum` function for the column given as the argument.
80
80
  *
81
81
  * If this is used in a `select` statement the type of the selected expression
82
- * will be `number | string | BigInt` by default. This is because Kysely can't
82
+ * will be `number | string | bigint` by default. This is because Kysely can't
83
83
  * know the type the db driver outputs. Sometimes the output can be larger than
84
84
  * the largest javascript number and a string is returned instead. Most drivers
85
85
  * allow you to configure the output type of large numbers and Kysely can't
@@ -103,7 +103,7 @@ export class FunctionBuilder {
103
103
  * Calls the `count` function for the column given as the argument.
104
104
  *
105
105
  * If this is used in a `select` statement the type of the selected expression
106
- * will be `number | string | BigInt` by default. This is because Kysely can't
106
+ * will be `number | string |bigint` by default. This is because Kysely can't
107
107
  * know the type the db driver outputs. Sometimes the output can be larger than
108
108
  * the largest javascript number and a string is returned instead. Most drivers
109
109
  * allow you to configure the output type of large numbers and Kysely can't
@@ -0,0 +1,27 @@
1
+ /**
2
+ * The result of an insert query.
3
+ *
4
+ * If the table has an auto incrementing primary key {@link insertId} will hold
5
+ * the generated id on dialects that support it. For example PostgreSQL doesn't
6
+ * return the id by default and {@link insertId} is undefined. On PostgreSQL you
7
+ * need to use {@link QueryBuilder.returning} or {@link QueryBuilder.returningAll}
8
+ * to get out the inserted id.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const result = await db
13
+ * .insertInto('person')
14
+ * .values(person)
15
+ * .executeTakeFirst()
16
+ *
17
+ * console.log(result.insertId)
18
+ * ```
19
+ */
20
+ export declare class InsertResult {
21
+ #private;
22
+ constructor(insertId: bigint | undefined);
23
+ /**
24
+ * The auto incrementing primary key
25
+ */
26
+ get insertId(): bigint | undefined;
27
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * The result of an insert query.
3
+ *
4
+ * If the table has an auto incrementing primary key {@link insertId} will hold
5
+ * the generated id on dialects that support it. For example PostgreSQL doesn't
6
+ * return the id by default and {@link insertId} is undefined. On PostgreSQL you
7
+ * need to use {@link QueryBuilder.returning} or {@link QueryBuilder.returningAll}
8
+ * to get out the inserted id.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const result = await db
13
+ * .insertInto('person')
14
+ * .values(person)
15
+ * .executeTakeFirst()
16
+ *
17
+ * console.log(result.insertId)
18
+ * ```
19
+ */
20
+ export class InsertResult {
21
+ #insertId;
22
+ constructor(insertId) {
23
+ this.#insertId = insertId;
24
+ }
25
+ /**
26
+ * The auto incrementing primary key
27
+ */
28
+ get insertId() {
29
+ return this.#insertId;
30
+ }
31
+ }