kysely 0.3.8 → 0.3.9

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

@@ -75,7 +75,8 @@ class QueryBuilder {
      * Usage in a subquery:
      *
      * ```ts
-     * db.selectFrom('person)
+     * const persons = await db
+     *   .selectFrom('person')
      *   .selectAll('person')
      *   .select((qb) => qb
      *     .subQuery('pet')
@@ -84,6 +85,7 @@ class QueryBuilder {
      *     .limit(1)
      *     .as('pet_name')
      *   )
+     *   .execute()
      * ```
      *
      * The generated SQL (postgresql):
@@ -93,8 +95,9 @@ class QueryBuilder {
      *   select "name"
      *   from "pet"
      *   where "pet"."owner_id" = "person"."id"
-     * ) as pet_name
-     * from "person"`
+     *   limit $1
+     * ) as "pet_name"
+     * from "person"
      */
     whereRef(lhs, op, rhs) {
         ensureCanHaveWhereClause(this.#queryNode);
@@ -132,7 +135,8 @@ class QueryBuilder {
      * The query below selets all persons that own a pet named Catto:
      *
      * ```ts
-     * db.selectFrom('person')
+     * const persons = await db
+     *   .selectFrom('person')
      *   .selectAll()
      *   .whereExists((qb) => qb
      *     .subQuery('pet')
@@ -140,6 +144,7 @@ class QueryBuilder {
      *     .whereRef('person.id', '=', 'pet.owner_id')
      *     .where('pet.name', '=', 'Catto')
      *   )
+     *   .execute()
      * ```
      *
      * The generated SQL (postgresql):
@@ -452,7 +457,7 @@ class QueryBuilder {
         });
     }
     /**
-     * Sets the values to update for an `updateTable` query.
+     * Sets the values to update for an {@link Kysely.updateTable | update} query.
      *
      * This method takes an object whose keys are column names and values are
      * values to update. In addition to the column's type, the values can be `raw`
@@ -483,7 +488,7 @@ class QueryBuilder {
      * ```
      *
      * @example
-     * On postgresql you need to chain `returning` to the query to get
+     * On postgresql you ca chain `returning` to the query to get
      * the updated rows' columns (or any other expression) as the
      * return value:
      *
@@ -496,7 +501,7 @@ class QueryBuilder {
      *   })
      *   .where('id', '=', 1)
      *   .returning('id')
-     *   .executeTakeFirst()
+     *   .executeTakeFirstOrThrow()
      *
      * row.id
      * ```

package/dist/cjs/query-builder/type-utils.d.ts

@@ -40,7 +40,7 @@ export declare type RowType<DB, TB extends keyof DB> = UnionToIntersection<DB[TB
  */
 export declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
 /**
- * Given a database type and a union of table name in that db returns
+ * Given a database type and a union of table names in that db, returns
  * a union type with all possible column names.
  *
  * Example:
@@ -74,7 +74,7 @@ export declare type AnyColumn<DB, TB extends keyof DB> = {
     [T in TB]: keyof DB[T];
 }[TB];
 /**
- * Given a database type and a union of table names in that db returns
+ * Given a database type and a union of table names in that db, returns
  * a union type with all possible `table`.`column` combinations.
  *
  * Example:
@@ -107,21 +107,30 @@ export declare type AnyColumn<DB, TB extends keyof DB> = {
 export declare type AnyColumnWithTable<DB, TB extends keyof DB> = {
     [T in TB]: T extends string ? keyof DB[T] extends string ? `${T}.${keyof DB[T]}` : never : never;
 }[TB];
+/**
+ * Just like {@link AnyColumn} but with a ` as <string>` suffix.
+ */
 export declare type AnyAliasedColumn<DB, TB extends keyof DB> = {
     [T in TB]: T extends string ? keyof DB[T] extends string ? `${keyof DB[T]} as ${string}` : never : never;
 }[TB];
-export declare type AnyAliasedColumnWithTable<DB, TB extends keyof DB> = `${AnyColumnWithTable<DB, TB>} as ${string}`;
 /**
- * Extracts an array item type.
+ * Just like {@link AnyColumnWithTable} but with a ` as <string>` suffix.
+ */
+export declare type AnyAliasedColumnWithTable<DB, TB extends keyof DB> = {
+    [T in TB]: T extends string ? keyof DB[T] extends string ? `${T}.${keyof DB[T]} as ${string}` : never : never;
+}[TB];
+/**
+ * Extracts the item type of an array.
  */
 export declare type ArrayItemType<T> = T extends ReadonlyArray<infer I> ? I : never;
 export declare type AnyQueryBuilder = QueryBuilder<any, any, any>;
 export declare type AnyAliasedQueryBuilder = AliasedQueryBuilder<any, any, any, any>;
 export declare type AnyRawBuilder = RawBuilder<any>;
+export declare type AnyAliasedRawBuilder = AliasedRawBuilder<any, any>;
 export declare type QueryBuilderFactory<DB, TB extends keyof DB> = (qb: SubQueryBuilder<DB, TB>) => QueryBuilder<any, any, any>;
 export declare type AliasedQueryBuilderFactory<DB, TB extends keyof DB> = (qb: SubQueryBuilder<DB, TB>) => AnyAliasedQueryBuilder;
 export declare type RawBuilderFactory<DB, TB extends keyof DB> = (qb: SubQueryBuilder<DB, TB>) => AnyRawBuilder;
-export declare type AliasedRawBuilderFactory<DB, TB extends keyof DB> = (qb: SubQueryBuilder<DB, TB>) => AliasedRawBuilder<any, any>;
+export declare type AliasedRawBuilderFactory<DB, TB extends keyof DB> = (qb: SubQueryBuilder<DB, TB>) => AnyAliasedRawBuilder;
 export interface InsertResultTypeTag {
     /** @internal */
     __isInsertResultTypeTag__: true;

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

@@ -23,6 +23,7 @@ export class PostgresDriver extends Driver {
             port: cfg.port,
             user: cfg.user,
             password: cfg.password,
+            ssl: cfg.ssl,
             // Pool options.
             connectionTimeoutMillis: cfg.pool.connectionTimeoutMillis,
             idleTimeoutMillis: cfg.pool.idleTimeoutMillis,

package/dist/esm/driver/driver-config.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import { SecureContextOptions } from 'tls';
 import { DatabaseConnection } from './database-connection.js';
 export interface DriverConfig {
     /**
@@ -24,6 +26,10 @@ export interface DriverConfig {
      * Connection pooling config.
      */
     pool?: PoolConfig;
+    /**
+     * Optional SSL configuration.
+     */
+    ssl?: SecureContextOptions;
 }
 export interface PoolConfig {
     /**

package/dist/esm/parser/select-parser.d.ts

@@ -1,12 +1,12 @@
 import { AliasedRawBuilder } from '../raw-builder/raw-builder.js';
 import { AliasedQueryBuilder, QueryBuilder } from '../query-builder/query-builder.js';
 import { SelectionNode } from '../operation-node/selection-node.js';
-import { AliasedQueryBuilderFactory, AliasedRawBuilderFactory, AnyAliasedColumn, AnyAliasedColumnWithTable, AnyAliasedQueryBuilder, AnyColumn, AnyColumnWithTable, InsertResultTypeTag, RowType, ValueType } from '../query-builder/type-utils.js';
+import { AliasedQueryBuilderFactory, AliasedRawBuilderFactory, AnyAliasedColumn, AnyAliasedColumnWithTable, AnyAliasedQueryBuilder, AnyAliasedRawBuilder, AnyColumn, AnyColumnWithTable, InsertResultTypeTag, RowType, ValueType } from '../query-builder/type-utils.js';
 import { DynamicReferenceBuilder } from '../dynamic/dynamic-reference-builder.js';
 /**
  * A selection expression.
  */
-export declare type SelectExpression<DB, TB extends keyof DB> = AnyAliasedColumnWithTable<DB, TB> | AnyAliasedColumn<DB, TB> | AnyColumnWithTable<DB, TB> | AnyColumn<DB, TB> | AliasedRawBuilder<any, any> | AliasedRawBuilderFactory<DB, TB> | AnyAliasedQueryBuilder | AliasedQueryBuilderFactory<DB, TB> | DynamicReferenceBuilder<any>;
+export declare type SelectExpression<DB, TB extends keyof DB> = AnyAliasedColumnWithTable<DB, TB> | AnyAliasedColumn<DB, TB> | AnyColumnWithTable<DB, TB> | AnyColumn<DB, TB> | AnyAliasedRawBuilder | AliasedRawBuilderFactory<DB, TB> | AnyAliasedQueryBuilder | AliasedQueryBuilderFactory<DB, TB> | DynamicReferenceBuilder<any>;
 export declare type SelectExpressionOrList<DB, TB extends keyof DB> = SelectExpression<DB, TB> | ReadonlyArray<SelectExpression<DB, TB>>;
 /**
  * Given a selection expression returns a query builder type that

package/dist/esm/parser/table-parser.d.ts

@@ -1,10 +1,10 @@
 import { AliasedQueryBuilder, QueryBuilder } from '../query-builder/query-builder.js';
 import { TableNode } from '../operation-node/table-node.js';
-import { AliasedQueryBuilderFactory, AnyAliasedQueryBuilder } from '../query-builder/type-utils.js';
+import { AliasedQueryBuilderFactory, AnyAliasedQueryBuilder, AnyAliasedRawBuilder } from '../query-builder/type-utils.js';
 import { AliasedRawBuilder } from '../raw-builder/raw-builder.js';
 import { TableExpressionNode } from '../operation-node/operation-node-utils.js';
 export declare type TableExpression<DB, TB extends keyof DB> = TableReference<DB> | AnyAliasedQueryBuilder | AliasedQueryBuilderFactory<DB, TB>;
-export declare type TableReference<DB> = AnyAliasedTable<DB, any, any> | AnyTable<DB> | AliasedRawBuilder<any, any>;
+export declare type TableReference<DB> = AnyAliasedTable<DB, any, any> | AnyTable<DB> | AnyAliasedRawBuilder;
 export declare type QueryBuilderWithTable<DB, TB extends keyof DB, O, TE> = QueryBuilder<TableExpressionDatabaseType<DB, TE>, TB | ExtractAliasFromTableExpression<DB, TE>, O>;
 export declare type TableExpressionDatabaseType<DB, TE> = DB extends ExtractDatabaseTypeFromTableExpression<DB, TE> ? DB : DB & ExtractDatabaseTypeFromTableExpression<DB, TE>;
 export declare type ExtractAliasFromTableExpression<DB, TE> = TE extends `${string} as ${infer TA}` ? TA : TE extends keyof DB ? TE : TE extends AliasedQueryBuilder<any, any, any, infer QA> ? QA : TE extends (qb: any) => AliasedQueryBuilder<any, any, any, infer QA> ? QA : TE extends (qb: any) => AliasedRawBuilder<any, infer RA> ? RA : never;