kysely 0.23.4 → 0.24.0

package/README.md

@@ -3,7 +3,7 @@
 [![Discord](https://img.shields.io/discord/890118421587578920)](https://discord.gg/xyBJ3GwvAm)
 [![Tests](https://github.com/koskimas/kysely/actions/workflows/test.yml/badge.svg)](https://github.com/koskimas/kysely)
 
-# [Kysely](https://koskimas.github.io/kysely/index.html)
+# [Kysely](https://kysely-org.github.io/kysely/index.html)
 
 Kysely (pronounce “Key-Seh-Lee”) is a type-safe and autocompletion-friendly typescript SQL query builder. Inspired by
 [knex](http://knexjs.org/). Mainly developed for [node.js](https://nodejs.org/en/) but also runs on [deno](https://deno.land/)
@@ -21,8 +21,8 @@ column names, aliases and types from selected subqueries, joined subqueries, `wi
 much anything you can think of.
 
 Of course there are cases where things cannot be typed at compile time, and Kysely offers escape
-hatches for these situations. See the [sql template tag](https://koskimas.github.io/kysely/interfaces/Sql.html) 
-and the [DynamicModule](https://koskimas.github.io/kysely/classes/DynamicModule.html#ref) for more info.
+hatches for these situations. See the [sql template tag](https://kysely-org.github.io/kysely/interfaces/Sql.html) 
+and the [DynamicModule](https://kysely-org.github.io/kysely/classes/DynamicModule.html#ref) for more info.
 
 All API documentation is written in the typing files and you can simply `cmd-click` on the module, class
 or method you're using to see it. The same documentation is also hosted [here](https://github.com/koskimas/kysely).
@@ -69,7 +69,7 @@ npm install kysely better-sqlite3
 ```
 
 More dialects will be added soon. Kysely also has a simple interface
-for [3rd party dialects](https://koskimas.github.io/kysely/interfaces/Dialect.html).
+for [3rd party dialects](https://kysely-org.github.io/kysely/interfaces/Dialect.html).
 
 ### 3rd party dialects
 
@@ -78,6 +78,9 @@ for [3rd party dialects](https://koskimas.github.io/kysely/interfaces/Dialect.ht
  - [SingleStore Data API](https://github.com/igalklebanov/kysely-singlestore)
  - [D1](https://github.com/aidenwallis/kysely-d1)
  - [SurrealDB](https://github.com/igalklebanov/kysely-surrealdb)
+ - [sqld](https://github.com/libsql/kysely-libsql)
+ - [Neon](https://github.com/seveibar/kysely-neon)
+ - [AWS S3 Select](https://github.com/igalklebanov/kysely-s3-select)
 
 # Minimal example
 
@@ -183,20 +186,33 @@ type UpdateablePerson = Updateable<PersonTable>
 
 # Playground
 
-[@wirekang](https://github.com/wirekang) has created a [playground for Kysely](https://wirekang.github.io/kysely-playground/#eyJkaWFsZWN0IjoibXlzcWwiLCJ0cyI6ImludGVyZmFjZSBEQiB7XG4gIHVzZXI6IFVzZXJUYWJsZVxufVxuXG5pbnRlcmZhY2UgVXNlclRhYmxlIHtcbiAgaWQ6IEdlbmVyYXRlZDxzdHJpbmc+XG4gIGZpcnN0X25hbWU6IHN0cmluZyB8IG51bGxcbiAgbGFzdF9uYW1lOiBzdHJpbmcgfCBudWxsXG4gIGNyZWF0ZWRfYXQ6IEdlbmVyYXRlZDxEYXRlPlxufVxuXG5yZXN1bHQgPSBreXNlbHlcbiAgLnNlbGVjdEZyb20oXCJ1c2VyXCIpXG4gIC5zZWxlY3RBbGwoKVxuICAub3JkZXJCeShcImNyZWF0ZWRfYXRcIikifQ==). You can use to quickly test stuff out and for creating code examples for your issues, PRs and discord messages.
+[@wirekang](https://github.com/wirekang) has created a [playground for Kysely](https://wirekang.github.io/kysely-playground/?p=f&i=-NLp3n_P5fyeQKMQda8n). You can use to quickly test stuff out and for creating code examples for your issues, PRs and discord messages.
 
 # Generating types
 
-If you want to generate the table types automatically from the database schema please
-check out [this awesome project](https://github.com/RobinBlomberg/kysely-codegen).
+To work with Kysely, you're required to provide a database schema type definition to the Kysely constructor.
+
+In many cases, defining your database schema definitions manually is good enough.
+
+However, when building production applications, its best to stay aligned with the 
+database schema, by automatically generating the database schema type definitions.
+
+There are several ways to do this using 3rd party libraries:
+
+- [kysely-codegen](https://github.com/RobinBlomberg/kysely-codegen) - This library 
+generates Kysely database schema type definitions by connecting to and introspecting 
+your database. This library works with all built-in dialects.
+
+- [prisma-kysely](https://github.com/valtyr/prisma-kysely) - This library generates 
+Kysely database schema type definitions from your existing Prisma schemas.
 
 # Query examples
 
 ## Select queries
 
 You can find examples of select queries in the documentation of the 
-[select method](https://koskimas.github.io/kysely/classes/SelectQueryBuilder.html#select) and
-the [where method](https://koskimas.github.io/kysely/classes/SelectQueryBuilder.html#where)
+[select method](https://kysely-org.github.io/kysely/classes/SelectQueryBuilder.html#select) and
+the [where method](https://kysely-org.github.io/kysely/classes/SelectQueryBuilder.html#where)
 among other places.
 
 ### Stream select query results
@@ -240,32 +256,36 @@ async function demo() {
 
 ## Update queries
 
-See the [set method](https://koskimas.github.io/kysely/classes/UpdateQueryBuilder.html#set) and the
-[updateTable method](https://koskimas.github.io/kysely/classes/Kysely.html#updateTable)
+See the [set method](https://kysely-org.github.io/kysely/classes/UpdateQueryBuilder.html#set) and the
+[updateTable method](https://kysely-org.github.io/kysely/classes/Kysely.html#updateTable)
 documentation.
 
 ## Insert queries
 
-See the [values method](https://koskimas.github.io/kysely/classes/InsertQueryBuilder.html#values) and the
-[insertInto method](https://koskimas.github.io/kysely/classes/Kysely.html#insertInto)
+See the [values method](https://kysely-org.github.io/kysely/classes/InsertQueryBuilder.html#values) and the
+[insertInto method](https://kysely-org.github.io/kysely/classes/Kysely.html#insertInto)
 documentation.
 
 ## Delete queries
 
-See the [deleteFrom method](https://koskimas.github.io/kysely/classes/Kysely.html#deleteFrom)
+See the [deleteFrom method](https://kysely-org.github.io/kysely/classes/Kysely.html#deleteFrom)
 documentation.
 
 # Recipes
 
-The [recipes](https://github.com/koskimas/kysely/tree/master/recipes) folder contains a bunch of small tutorials
+The [recipes](https://github.com/koskimas/kysely/tree/master/site/docs/recipes/) folder contains a bunch of small tutorials
 or "recipes" for common use cases.
 
-* [Conditional selects](https://github.com/koskimas/kysely/tree/master/recipes/conditional-selects.md)
-* [Deduplicate joins](https://github.com/koskimas/kysely/tree/master/recipes/deduplicate-joins.md)
-* [Extending kysely](https://github.com/koskimas/kysely/tree/master/recipes/extending-kysely.md)
-* [Raw SQL](https://github.com/koskimas/kysely/tree/master/recipes/raw-sql.md)
-* [Schemas](https://github.com/koskimas/kysely/tree/master/recipes/schemas.md)
-* [Dealing with the `Type instantiation is excessively deep and possibly infinite` error](https://github.com/koskimas/kysely/tree/master/recipes/excessively-deep-types.md)
+* [Expressions](https://github.com/koskimas/kysely/tree/master/site/docs/recipes/expressions.md)
+* [Conditional selects](https://github.com/koskimas/kysely/tree/master/site/docs/recipes/conditional-selects.md)
+* [Dealing with the `Type instantiation is excessively deep and possibly infinite` error](https://github.com/koskimas/kysely/tree/master/site/docs/recipes/excessively-deep-types.md)
+* [Deduplicate joins](https://github.com/koskimas/kysely/tree/master/site/docs/recipes/deduplicate-joins.md)
+* [Extending kysely](https://github.com/koskimas/kysely/tree/master/site/docs/recipes/extending-kysely.md)
+* [Introspecting relation metadata](https://github.com/koskimas/kysely/tree/master/site/docs/recipes/introspecting-relation-metadata.md)
+* [Raw SQL](https://github.com/koskimas/kysely/tree/master/site/docs/recipes/raw-sql.md)
+* [Relations](https://github.com/koskimas/kysely/tree/master/site/docs/recipes/relations.md)
+* [Schemas](https://github.com/koskimas/kysely/tree/master/site/docs/recipes/schemas.md)
+* [Splitting build, compile and execute code](https://github.com/koskimas/kysely/tree/master/site/docs/recipes/splitting-build-compile-and-execute-code.md)
 
 # Migrations
 
@@ -290,7 +310,7 @@ when you go back to previous version. The only argument for the functions is an
 Migrations should never depend on the current code of your app because they need to work even when the app
 changes. Migrations need to be "frozen in time".
 
-The migrations can use the [Kysely.schema](https://koskimas.github.io/kysely/classes/SchemaModule.html)
+The migrations can use the [Kysely.schema](https://kysely-org.github.io/kysely/classes/SchemaModule.html)
 module to modify the schema. Migrations can also run normal queries to modify data.
 
 Execution order of the migrations is the alpabetical order of their names. An excellent way to name your
@@ -299,8 +319,8 @@ where multiple team members may add migrations at the same time in parallel comm
 about the other migrations.
 
 You don't need to store your migrations as separate files if you don't want to. You can easily
-implement your own [MigrationProvider](https://koskimas.github.io/kysely/interfaces/MigrationProvider.html)
-and give it to the [Migrator](https://koskimas.github.io/kysely/classes/Migrator.html) class
+implement your own [MigrationProvider](https://kysely-org.github.io/kysely/interfaces/MigrationProvider.html)
+and give it to the [Migrator](https://kysely-org.github.io/kysely/classes/Migrator.html) class
 when you instantiate one.
 
 ### PostgreSQL migration example
@@ -388,7 +408,7 @@ await migrator.migrateToLatest(pathToMigrationsFolder)
 ```
 
 to run all migrations that have not yet been run. See the
-[Migrator](https://koskimas.github.io/kysely/classes/Migrator.html)
+[Migrator](https://kysely-org.github.io/kysely/classes/Migrator.html)
 class's documentation for more info.
 
 Kysely doesn't have a CLI for running migrations and probably never will. This is because Kysely's
@@ -570,3 +590,7 @@ a library for typescript from the ground up produces much better and simpler typ
 # How to contribute to Kysely
 
 See [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+# Sponsors
+
+<a href="https://vercel.com/?utm_source=kysely&utm_campaign=oss"><img src="https://kysely.dev/img/powered-by-vercel.svg" alt="Powered by Vercel" /></a>

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

@@ -7,7 +7,7 @@ export interface DatabaseIntrospector {
      */
     getSchemas(): Promise<SchemaMetadata[]>;
     /**
-     * Get table metadata.
+     * Get tables and views metadata.
      */
     getTables(options?: DatabaseMetadataOptions): Promise<TableMetadata[]>;
     /**
@@ -29,12 +29,14 @@ export interface SchemaMetadata {
 }
 export interface DatabaseMetadata {
     /**
-     * The tables found in the database.
+     * The tables and views found in the database.
+  *  * The propery isView can be used to tell them apart.
      */
     readonly tables: TableMetadata[];
 }
 export interface TableMetadata {
     readonly name: string;
+    readonly isView: boolean;
     readonly columns: ColumnMetadata[];
     readonly schema?: string;
 }

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

@@ -19,10 +19,10 @@ class MysqlAdapter extends dialect_adapter_base_js_1.DialectAdapterBase {
         // is released using `release_lock`. This way we know that the lock is either
         // released by us after successfull or failed migrations OR it's released by
         // MySQL if the process gets killed for some reason.
-        await (0, sql_js_1.sql) `select get_lock(${sql_js_1.sql.literal(LOCK_ID)}, ${sql_js_1.sql.literal(LOCK_TIMEOUT_SECONDS)})`.execute(db);
+        await (0, sql_js_1.sql) `select get_lock(${sql_js_1.sql.lit(LOCK_ID)}, ${sql_js_1.sql.lit(LOCK_TIMEOUT_SECONDS)})`.execute(db);
     }
     async releaseMigrationLock(db) {
-        await (0, sql_js_1.sql) `select release_lock(${sql_js_1.sql.literal(LOCK_ID)})`.execute(db);
+        await (0, sql_js_1.sql) `select release_lock(${sql_js_1.sql.lit(LOCK_ID)})`.execute(db);
     }
 }
 exports.MysqlAdapter = MysqlAdapter;

package/dist/cjs/dialect/mysql/mysql-driver.d.ts

@@ -42,7 +42,7 @@ declare class MysqlConnection implements DatabaseConnection {
     #private;
     constructor(rawConnection: MysqlPoolConnection);
     executeQuery<O>(compiledQuery: CompiledQuery): Promise<QueryResult<O>>;
-    streamQuery<O>(compiledQuery: CompiledQuery, chunkSize: number): AsyncIterableIterator<QueryResult<O>>;
+    streamQuery<O>(compiledQuery: CompiledQuery, _chunkSize: number): AsyncIterableIterator<QueryResult<O>>;
     [PRIVATE_RELEASE_METHOD](): void;
 }
 export {};

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

@@ -127,7 +127,7 @@ class MysqlConnection {
             });
         });
     }
-    async *streamQuery(compiledQuery, chunkSize) {
+    async *streamQuery(compiledQuery, _chunkSize) {
         const stream = this.#rawConnection
             .query(compiledQuery.sql, compiledQuery.parameters)
             .stream({

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

@@ -8,7 +8,7 @@ export declare class MysqlIntrospector implements DatabaseIntrospector {
      */
     getSchemas(): Promise<SchemaMetadata[]>;
     /**
-     * Get table metadata.
+     * Get tables and views metadata.
      */
     getTables(options?: DatabaseMetadataOptions): Promise<TableMetadata[]>;
     /**

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

@@ -19,24 +19,29 @@ class MysqlIntrospector {
     }
     async getTables(options = { withInternalKyselyTables: false }) {
         let query = this.#db
-            .selectFrom('information_schema.columns')
+            .selectFrom('information_schema.columns as columns')
+            .innerJoin('information_schema.tables as tables', (b) => b
+            .onRef('columns.TABLE_CATALOG', '=', 'tables.TABLE_CATALOG')
+            .onRef('columns.TABLE_SCHEMA', '=', 'tables.TABLE_SCHEMA')
+            .onRef('columns.TABLE_NAME', '=', 'tables.TABLE_NAME'))
             .select([
-            'COLUMN_NAME',
-            'COLUMN_DEFAULT',
-            'TABLE_NAME',
-            'TABLE_SCHEMA',
-            'IS_NULLABLE',
-            'DATA_TYPE',
-            'EXTRA',
+            'columns.COLUMN_NAME',
+            'columns.COLUMN_DEFAULT',
+            'columns.TABLE_NAME',
+            'columns.TABLE_SCHEMA',
+            'tables.TABLE_TYPE',
+            'columns.IS_NULLABLE',
+            'columns.DATA_TYPE',
+            'columns.EXTRA',
         ])
-            .where('table_schema', '=', (0, sql_js_1.sql) `database()`)
-            .orderBy('table_name')
-            .orderBy('ordinal_position')
+            .where('columns.TABLE_SCHEMA', '=', (0, sql_js_1.sql) `database()`)
+            .orderBy('columns.TABLE_NAME')
+            .orderBy('columns.ORDINAL_POSITION')
             .$castTo();
         if (!options.withInternalKyselyTables) {
             query = query
-                .where('table_name', '!=', migrator_js_1.DEFAULT_MIGRATION_TABLE)
-                .where('table_name', '!=', migrator_js_1.DEFAULT_MIGRATION_LOCK_TABLE);
+                .where('columns.TABLE_NAME', '!=', migrator_js_1.DEFAULT_MIGRATION_TABLE)
+                .where('columns.TABLE_NAME', '!=', migrator_js_1.DEFAULT_MIGRATION_LOCK_TABLE);
         }
         const rawColumns = await query.execute();
         return this.#parseTableMetadata(rawColumns);
@@ -52,6 +57,7 @@ class MysqlIntrospector {
             if (!table) {
                 table = (0, object_utils_js_1.freeze)({
                     name: it.TABLE_NAME,
+                    isView: it.TABLE_TYPE === 'VIEW',
                     schema: it.TABLE_SCHEMA,
                     columns: [],
                 });

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

@@ -14,7 +14,7 @@ class PostgresAdapter extends dialect_adapter_base_js_1.DialectAdapterBase {
     }
     async acquireMigrationLock(db) {
         // Acquire a transaction level advisory lock.
-        await (0, sql_js_1.sql) `select pg_advisory_xact_lock(${sql_js_1.sql.literal(LOCK_ID)})`.execute(db);
+        await (0, sql_js_1.sql) `select pg_advisory_xact_lock(${sql_js_1.sql.lit(LOCK_ID)})`.execute(db);
     }
     async releaseMigrationLock() {
         // Nothing to do here. `pg_advisory_xact_lock` is automatically released at the

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

@@ -8,7 +8,7 @@ export declare class PostgresIntrospector implements DatabaseIntrospector {
      */
     getSchemas(): Promise<SchemaMetadata[]>;
     /**
-     * Get table metadata.
+     * Get tables and views metadata.
      */
     getTables(options?: DatabaseMetadataOptions): Promise<TableMetadata[]>;
     /**

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

@@ -34,6 +34,7 @@ class PostgresIntrospector {
             'a.attnotnull as not_null',
             'a.atthasdef as has_default',
             'c.relname as table',
+            'c.relkind as table_type',
             'ns.nspname as schema',
             'typ.typname as type',
             'dtns.nspname as type_schema',
@@ -49,7 +50,7 @@ class PostgresIntrospector {
                 .as('auto_incrementing'),
         ])
             // r == normal table
-            .where('c.relkind', '=', 'r')
+            .where('c.relkind', 'in', ['r', 'v'])
             .where('ns.nspname', '!~', '^pg_')
             .where('ns.nspname', '!=', 'information_schema')
             // No system columns
@@ -78,6 +79,7 @@ class PostgresIntrospector {
             if (!table) {
                 table = (0, object_utils_js_1.freeze)({
                     name: it.table,
+                    isView: it.table_type === 'v',
                     schema: it.schema,
                     columns: [],
                 });

package/dist/cjs/dialect/sqlite/sqlite-dialect.d.ts

@@ -27,6 +27,7 @@ import { SqliteDialectConfig } from './sqlite-dialect-config.js';
  * new SqliteDialect({
  *   database: async () => new Database('db.sqlite')
  * })
+ * ```
  */
 export declare class SqliteDialect implements Dialect {
     #private;

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

@@ -28,6 +28,7 @@ const object_utils_js_1 = require("../../util/object-utils.js");
  * new SqliteDialect({
  *   database: async () => new Database('db.sqlite')
  * })
+ * ```
  */
 class SqliteDialect {
     #config;

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

@@ -8,7 +8,7 @@ export declare class SqliteIntrospector implements DatabaseIntrospector {
      */
     getSchemas(): Promise<SchemaMetadata[]>;
     /**
-     * Get table metadata.
+     * Get tables and views metadata.
      */
     getTables(options?: DatabaseMetadataOptions): Promise<TableMetadata[]>;
     /**

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

@@ -15,7 +15,7 @@ class SqliteIntrospector {
     async getTables(options = { withInternalKyselyTables: false }) {
         let query = this.#db
             .selectFrom('sqlite_schema')
-            .where('type', '=', 'table')
+            .where('type', 'in', ['table', 'view'])
             .where('name', 'not like', 'sqlite_%')
             .select('name')
             .orderBy('name')
@@ -36,14 +36,14 @@ class SqliteIntrospector {
     async #getTableMetadata(table) {
         const db = this.#db;
         // Get the SQL that was used to create the table.
-        const createSql = await db
+        const tableDefinition = await db
             .selectFrom('sqlite_master')
             .where('name', '=', table)
-            .select('sql')
+            .select(['sql', 'type'])
             .$castTo()
-            .execute();
+            .executeTakeFirstOrThrow();
         // Try to find the name of the column that has `autoincrement` 🤦
-        const autoIncrementCol = createSql[0]?.sql
+        const autoIncrementCol = tableDefinition.sql
             ?.split(/[\(\),]/)
             ?.find((it) => it.toLowerCase().includes('autoincrement'))
             ?.trimStart()
@@ -56,6 +56,7 @@ class SqliteIntrospector {
             .execute();
         return {
             name: table,
+            isView: tableDefinition.type === 'view',
             columns: columns.map((col) => ({
                 name: col.name,
                 dataType: col.type,

package/dist/cjs/driver/runtime-driver.js

@@ -76,7 +76,7 @@ class RuntimeDriver {
                 return await executeQuery.call(connection, compiledQuery);
             }
             catch (error) {
-                this.#logError(error);
+                this.#logError(error, compiledQuery, startTime);
                 throw error;
             }
             finally {
@@ -84,10 +84,12 @@ class RuntimeDriver {
             }
         };
     }
-    #logError(error) {
+    #logError(error, compiledQuery, startTime) {
         this.#log.error(() => ({
             level: 'error',
             error,
+            query: compiledQuery,
+            queryDurationMillis: this.#calculateDurationMillis(startTime),
         }));
     }
     #logQuery(compiledQuery, startTime) {