kysely 0.19.5 → 0.19.6

package/dist/cjs/dialect/database-introspector.d.ts

@@ -1,4 +1,3 @@
-import { ColumnDataType } from '../operation-node/data-type-node.js';
 /**
  * An interface for getting the database metadata (names of the tables and columns etc.)
  */
@@ -41,6 +40,16 @@ export interface TableMetadata {
 }
 export interface ColumnMetadata {
     readonly name: string;
-    readonly dataType: ColumnDataType;
+    /**
+     * The data type of the column as reported by the database.
+     *
+     * NOTE: This value is whatever the database engine returns and it will be
+     *       different on different dialects even if you run the same migrations.
+     *       For example `integer` datatype in a migration will produce `int4`
+     *       on PostgreSQL, `INTEGER` on SQLite and `int` on MySQL.
+     */
+    readonly dataType: string;
+    readonly isAutoIncrementing: boolean;
     readonly isNullable: boolean;
+    readonly hasDefaultValue: boolean;
 }

package/dist/cjs/dialect/mysql/mysql-introspector.js

@@ -22,10 +22,12 @@ class MysqlIntrospector {
             .selectFrom('information_schema.columns')
             .select([
             'column_name',
+            'column_default',
             'table_name',
             'table_schema',
             'is_nullable',
             'data_type',
+            'extra',
         ])
             .where('table_schema', '=', (0, sql_js_1.sql) `database()`)
             .castTo();
@@ -57,6 +59,8 @@ class MysqlIntrospector {
                 name: it.COLUMN_NAME,
                 dataType: it.DATA_TYPE,
                 isNullable: it.IS_NULLABLE === 'YES',
+                isAutoIncrementing: it.EXTRA.toLowerCase().includes('auto_increment'),
+                hasDefaultValue: it.COLUMN_DEFAULT !== null,
             }));
             return tables;
         }, []);

package/dist/cjs/dialect/postgres/postgres-introspector.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PostgresIntrospector = void 0;
 const migrator_js_1 = require("../../migration/migrator.js");
 const object_utils_js_1 = require("../../util/object-utils.js");
+const sql_js_1 = require("../../raw-builder/sql.js");
 class PostgresIntrospector {
     #db;
     constructor(db) {
@@ -25,9 +26,18 @@ class PostgresIntrospector {
             .select([
             'a.attname as column',
             'a.attnotnull as not_null',
+            'a.atthasdef as has_default',
             't.tablename as table',
             't.schemaname as schema',
             'typ.typname as type',
+            // Detect if the column is auto incrementing by finding the sequence
+            // that is created for `serial` and `bigserial` columns.
+            this.#db
+                .selectFrom('pg_class')
+                .select((0, sql_js_1.sql) `true`.as('auto_incrementing'))
+                .where('relkind', '=', 'S')
+                .where('relname', '=', (0, sql_js_1.sql) `t.tablename || '_' || a.attname || '_seq'`)
+                .as('auto_incrementing'),
         ])
             .where('t.schemaname', '!~', '^pg_')
             .where('t.schemaname', '!=', 'information_schema')
@@ -62,6 +72,8 @@ class PostgresIntrospector {
                 name: it.column,
                 dataType: it.type,
                 isNullable: !it.not_null,
+                isAutoIncrementing: !!it.auto_incrementing,
+                hasDefaultValue: it.has_default,
             }));
             return tables;
         }, []);

package/dist/cjs/dialect/sqlite/sqlite-introspector.js

@@ -34,9 +34,22 @@ class SqliteIntrospector {
     }
     async #getTableMetadata(table) {
         const db = this.#db;
+        // Get the SQL that was used to create the table.
+        const createSql = await db
+            .selectFrom('sqlite_master')
+            .where('name', '=', table)
+            .select('sql')
+            .castTo()
+            .execute();
+        // Try to find the name of the column that has `autoincrement` 🤦
+        const autoIncrementCol = createSql[0]?.sql
+            ?.split(/[\(\),]/)
+            ?.find((it) => it.toLowerCase().includes('autoincrement'))
+            ?.split(/\s+/)?.[0]
+            ?.replace(/["`]/g, '');
         const columns = await db
-            .selectFrom((0, sql_js_1.sql) `PRAGMA_TABLE_INFO(${table})`.as('table_info'))
-            .select(['name', 'type', 'notnull'])
+            .selectFrom((0, sql_js_1.sql) `pragma_table_info(${table})`.as('table_info'))
+            .select(['name', 'type', 'notnull', 'dflt_value'])
             .execute();
         return {
             name: table,
@@ -44,6 +57,8 @@ class SqliteIntrospector {
                 name: col.name,
                 dataType: col.type,
                 isNullable: !col.notnull,
+                isAutoIncrementing: col.name === autoIncrementCol,
+                hasDefaultValue: !!col.dflt_value,
             })),
         };
     }

package/dist/cjs/query-builder/join-builder.d.ts

@@ -66,6 +66,10 @@ export declare class JoinBuilder<DB, TB extends keyof DB> implements OperationNo
      * See {@link WhereInterface.orWhereNotExists} for documentation and examples.
      */
     orOnNotExists(arg: ExistsExpression<DB, TB>): JoinBuilder<DB, TB>;
+    /**
+     * Adds `on true`.
+     */
+    onTrue(): JoinBuilder<DB, TB>;
     toOperationNode(): JoinNode;
 }
 export interface JoinBuilderProps {

package/dist/cjs/query-builder/join-builder.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JoinBuilder = void 0;
 const join_node_js_1 = require("../operation-node/join-node.js");
+const raw_node_js_1 = require("../operation-node/raw-node.js");
 const filter_parser_js_1 = require("../parser/filter-parser.js");
 const object_utils_js_1 = require("../util/object-utils.js");
 const prevent_await_js_1 = require("../util/prevent-await.js");
@@ -94,6 +95,15 @@ class JoinBuilder {
             joinNode: join_node_js_1.JoinNode.cloneWithOrOn(this.#props.joinNode, (0, filter_parser_js_1.parseNotExistFilter)(arg)),
         });
     }
+    /**
+     * Adds `on true`.
+     */
+    onTrue() {
+        return new JoinBuilder({
+            ...this.#props,
+            joinNode: join_node_js_1.JoinNode.cloneWithOn(this.#props.joinNode, raw_node_js_1.RawNode.createWithSql('true')),
+        });
+    }
     toOperationNode() {
         return this.#props.joinNode;
     }

package/dist/cjs/query-builder/select-query-builder.d.ts

@@ -875,11 +875,41 @@ export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements W
     fullJoin<TE extends TableExpression<DB, TB>, FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithFullJoin<DB, TB, O, TE>;
     /**
      * Just like {@link innerJoin} but adds a lateral join instead of an inner join.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .innerJoinLateral(
+     *     (eb) =>
+     *       eb.selectFrom('pet')
+     *         .select('name')
+     *         .whereRef('pet.owner_id', '=', 'person.id')
+     *         .as('p'),
+     *     (join) => join.onTrue()
+     *   )
+     *   .select(['first_name', 'p.name'])
+     *   .orderBy('first_name')
      */
     innerJoinLateral<TE extends TableExpression<DB, TB>, K1 extends JoinReferenceExpression<DB, TB, TE>, K2 extends JoinReferenceExpression<DB, TB, TE>>(table: TE, k1: K1, k2: K2): SelectQueryBuilderWithInnerJoin<DB, TB, O, TE>;
     innerJoinLateral<TE extends TableExpression<DB, TB>, FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithInnerJoin<DB, TB, O, TE>;
     /**
      * Just like {@link innerJoin} but adds a lateral left join instead of an inner join.
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .leftJoinLateral(
+     *     (eb) =>
+     *       eb.selectFrom('pet')
+     *         .select('name')
+     *         .whereRef('pet.owner_id', '=', 'person.id')
+     *         .as('p'),
+     *     (join) => join.onTrue()
+     *   )
+     *   .select(['first_name', 'p.name'])
+     *   .orderBy('first_name')
+     * ```
      */
     leftJoinLateral<TE extends TableExpression<DB, TB>, K1 extends JoinReferenceExpression<DB, TB, TE>, K2 extends JoinReferenceExpression<DB, TB, TE>>(table: TE, k1: K1, k2: K2): SelectQueryBuilderWithLeftJoin<DB, TB, O, TE>;
     leftJoinLateral<TE extends TableExpression<DB, TB>, FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithLeftJoin<DB, TB, O, TE>;

package/dist/esm/dialect/database-introspector.d.ts

@@ -1,4 +1,3 @@
-import { ColumnDataType } from '../operation-node/data-type-node.js';
 /**
  * An interface for getting the database metadata (names of the tables and columns etc.)
  */
@@ -41,6 +40,16 @@ export interface TableMetadata {
 }
 export interface ColumnMetadata {
     readonly name: string;
-    readonly dataType: ColumnDataType;
+    /**
+     * The data type of the column as reported by the database.
+     *
+     * NOTE: This value is whatever the database engine returns and it will be
+     *       different on different dialects even if you run the same migrations.
+     *       For example `integer` datatype in a migration will produce `int4`
+     *       on PostgreSQL, `INTEGER` on SQLite and `int` on MySQL.
+     */
+    readonly dataType: string;
+    readonly isAutoIncrementing: boolean;
     readonly isNullable: boolean;
+    readonly hasDefaultValue: boolean;
 }

package/dist/esm/dialect/mysql/mysql-introspector.js

@@ -20,10 +20,12 @@ export class MysqlIntrospector {
             .selectFrom('information_schema.columns')
             .select([
             'column_name',
+            'column_default',
             'table_name',
             'table_schema',
             'is_nullable',
             'data_type',
+            'extra',
         ])
             .where('table_schema', '=', sql `database()`)
             .castTo();
@@ -55,6 +57,8 @@ export class MysqlIntrospector {
                 name: it.COLUMN_NAME,
                 dataType: it.DATA_TYPE,
                 isNullable: it.IS_NULLABLE === 'YES',
+                isAutoIncrementing: it.EXTRA.toLowerCase().includes('auto_increment'),
+                hasDefaultValue: it.COLUMN_DEFAULT !== null,
             }));
             return tables;
         }, []);

package/dist/esm/dialect/postgres/postgres-introspector.js

@@ -1,6 +1,7 @@
 /// <reference types="./postgres-introspector.d.ts" />
 import { DEFAULT_MIGRATION_LOCK_TABLE, DEFAULT_MIGRATION_TABLE, } from '../../migration/migrator.js';
 import { freeze } from '../../util/object-utils.js';
+import { sql } from '../../raw-builder/sql.js';
 export class PostgresIntrospector {
     #db;
     constructor(db) {
@@ -23,9 +24,18 @@ export class PostgresIntrospector {
             .select([
             'a.attname as column',
             'a.attnotnull as not_null',
+            'a.atthasdef as has_default',
             't.tablename as table',
             't.schemaname as schema',
             'typ.typname as type',
+            // Detect if the column is auto incrementing by finding the sequence
+            // that is created for `serial` and `bigserial` columns.
+            this.#db
+                .selectFrom('pg_class')
+                .select(sql `true`.as('auto_incrementing'))
+                .where('relkind', '=', 'S')
+                .where('relname', '=', sql `t.tablename || '_' || a.attname || '_seq'`)
+                .as('auto_incrementing'),
         ])
             .where('t.schemaname', '!~', '^pg_')
             .where('t.schemaname', '!=', 'information_schema')
@@ -60,6 +70,8 @@ export class PostgresIntrospector {
                 name: it.column,
                 dataType: it.type,
                 isNullable: !it.not_null,
+                isAutoIncrementing: !!it.auto_incrementing,
+                hasDefaultValue: it.has_default,
             }));
             return tables;
         }, []);

package/dist/esm/dialect/sqlite/sqlite-introspector.js

@@ -32,9 +32,22 @@ export class SqliteIntrospector {
     }
     async #getTableMetadata(table) {
         const db = this.#db;
+        // Get the SQL that was used to create the table.
+        const createSql = await db
+            .selectFrom('sqlite_master')
+            .where('name', '=', table)
+            .select('sql')
+            .castTo()
+            .execute();
+        // Try to find the name of the column that has `autoincrement` 🤦
+        const autoIncrementCol = createSql[0]?.sql
+            ?.split(/[\(\),]/)
+            ?.find((it) => it.toLowerCase().includes('autoincrement'))
+            ?.split(/\s+/)?.[0]
+            ?.replace(/["`]/g, '');
         const columns = await db
-            .selectFrom(sql `PRAGMA_TABLE_INFO(${table})`.as('table_info'))
-            .select(['name', 'type', 'notnull'])
+            .selectFrom(sql `pragma_table_info(${table})`.as('table_info'))
+            .select(['name', 'type', 'notnull', 'dflt_value'])
             .execute();
         return {
             name: table,
@@ -42,6 +55,8 @@ export class SqliteIntrospector {
                 name: col.name,
                 dataType: col.type,
                 isNullable: !col.notnull,
+                isAutoIncrementing: col.name === autoIncrementCol,
+                hasDefaultValue: !!col.dflt_value,
             })),
         };
     }

package/dist/esm/query-builder/join-builder.d.ts

@@ -66,6 +66,10 @@ export declare class JoinBuilder<DB, TB extends keyof DB> implements OperationNo
      * See {@link WhereInterface.orWhereNotExists} for documentation and examples.
      */
     orOnNotExists(arg: ExistsExpression<DB, TB>): JoinBuilder<DB, TB>;
+    /**
+     * Adds `on true`.
+     */
+    onTrue(): JoinBuilder<DB, TB>;
     toOperationNode(): JoinNode;
 }
 export interface JoinBuilderProps {

package/dist/esm/query-builder/join-builder.js

@@ -1,5 +1,6 @@
 /// <reference types="./join-builder.d.ts" />
 import { JoinNode } from '../operation-node/join-node.js';
+import { RawNode } from '../operation-node/raw-node.js';
 import { parseExistFilter, parseNotExistFilter, parseOnFilter, parseReferenceFilter, } from '../parser/filter-parser.js';
 import { freeze } from '../util/object-utils.js';
 import { preventAwait } from '../util/prevent-await.js';
@@ -92,6 +93,15 @@ export class JoinBuilder {
             joinNode: JoinNode.cloneWithOrOn(this.#props.joinNode, parseNotExistFilter(arg)),
         });
     }
+    /**
+     * Adds `on true`.
+     */
+    onTrue() {
+        return new JoinBuilder({
+            ...this.#props,
+            joinNode: JoinNode.cloneWithOn(this.#props.joinNode, RawNode.createWithSql('true')),
+        });
+    }
     toOperationNode() {
         return this.#props.joinNode;
     }

package/dist/esm/query-builder/select-query-builder.d.ts

@@ -875,11 +875,41 @@ export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements W
     fullJoin<TE extends TableExpression<DB, TB>, FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithFullJoin<DB, TB, O, TE>;
     /**
      * Just like {@link innerJoin} but adds a lateral join instead of an inner join.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .innerJoinLateral(
+     *     (eb) =>
+     *       eb.selectFrom('pet')
+     *         .select('name')
+     *         .whereRef('pet.owner_id', '=', 'person.id')
+     *         .as('p'),
+     *     (join) => join.onTrue()
+     *   )
+     *   .select(['first_name', 'p.name'])
+     *   .orderBy('first_name')
      */
     innerJoinLateral<TE extends TableExpression<DB, TB>, K1 extends JoinReferenceExpression<DB, TB, TE>, K2 extends JoinReferenceExpression<DB, TB, TE>>(table: TE, k1: K1, k2: K2): SelectQueryBuilderWithInnerJoin<DB, TB, O, TE>;
     innerJoinLateral<TE extends TableExpression<DB, TB>, FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithInnerJoin<DB, TB, O, TE>;
     /**
      * Just like {@link innerJoin} but adds a lateral left join instead of an inner join.
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .leftJoinLateral(
+     *     (eb) =>
+     *       eb.selectFrom('pet')
+     *         .select('name')
+     *         .whereRef('pet.owner_id', '=', 'person.id')
+     *         .as('p'),
+     *     (join) => join.onTrue()
+     *   )
+     *   .select(['first_name', 'p.name'])
+     *   .orderBy('first_name')
+     * ```
      */
     leftJoinLateral<TE extends TableExpression<DB, TB>, K1 extends JoinReferenceExpression<DB, TB, TE>, K2 extends JoinReferenceExpression<DB, TB, TE>>(table: TE, k1: K1, k2: K2): SelectQueryBuilderWithLeftJoin<DB, TB, O, TE>;
     leftJoinLateral<TE extends TableExpression<DB, TB>, FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithLeftJoin<DB, TB, O, TE>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.19.5",
+  "version": "0.19.6",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",