kysely 0.23.5 → 0.24.0

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

@@ -1,126 +0,0 @@
-import { SelectQueryBuilder } from './select-query-builder.js';
-import { TableExpression, From, FromTables } from '../parser/table-parser.js';
-import { FunctionModule } from './function-module.js';
-import { ExtractTypeFromReferenceExpression, StringReference } from '../parser/reference-parser.js';
-import { RawBuilder } from '../raw-builder/raw-builder.js';
-import { QueryExecutor } from '../query-executor/query-executor.js';
-export declare class ExpressionBuilder<DB, TB extends keyof DB> {
-    #private;
-    constructor(props: ExpressionBuilderProps);
-    /**
-     * Returns a {@link FunctionModule} that can be used to write type safe function
-     * calls.
-     *
-     * The difference between this and {@link Kysely.fn} is that this one is more
-     * type safe. You can only refer to columns visible to the part of the query
-     * you are building. {@link Kysely.fn} allows you to refer to columns in any
-     * table of the database even if it doesn't produce valid SQL.
-     *
-     * ```ts
-     * await db.selectFrom('person')
-     *   .innerJoin('pet', 'pet.owner_id', 'person.id')
-     *   .select([
-     *     'person.id',
-     *     (qb) => qb.fn.count('pet.id').as('pet_count')
-     *   ])
-     *   .groupBy('person.id')
-     *   .having(count('pet.id'), '>', 10)
-     *   .execute()
-     * ```
-     *
-     * The generated SQL (PostgreSQL):
-     *
-     * ```sql
-     * select "person"."id", count("pet"."id") as "pet_count"
-     * from "person"
-     * inner join "pet" on "pet"."owner_id" = "person"."id"
-     * group by "person"."id"
-     * having count("pet"."id") > $1
-     * ```
-     */
-    get fn(): FunctionModule<DB, TB>;
-    /**
-     * Creates a subquery.
-     *
-     * The query builder returned by this method is typed in a way that you can refer to
-     * all tables of the parent query in addition to the subquery's tables.
-     *
-     * This method accepts all the same inputs as {@link QueryCreator.selectFrom}.
-     *
-     * ### Examples
-     *
-     * This example shows that you can refer to both `pet.owner_id` and `person.id`
-     * columns from the subquery. This is needed to be able to create correlated
-     * subqueries:
-     *
-     * ```ts
-     * const result = await db.selectFrom('pet')
-     *   .select([
-     *     'pet.name',
-     *     (qb) => qb.selectFrom('person')
-     *       .whereRef('person.id', '=', 'pet.owner_id')
-     *       .select('person.first_name')
-     *       .as('owner_name')
-     *   ])
-     *   .execute()
-     *
-     * console.log(result[0].owner_name)
-     * ```
-     *
-     * The generated SQL (PostgreSQL):
-     *
-     * ```sql
-     * select
-     *   "pet"."name",
-     *   ( select "person"."first_name"
-     *     from "person"
-     *     where "person"."id" = "pet"."owner_id"
-     *   ) as "owner_name"
-     * from "pet"
-     * ```
-     *
-     * You can use a normal query in place of `(qb) => qb.selectFrom(...)` but in
-     * that case Kysely typings wouldn't allow you to reference `pet.owner_id`
-     * because `pet` is not joined to that query.
-     */
-    selectFrom<TE extends TableExpression<DB, TB>>(from: TE[]): SelectQueryBuilder<From<DB, TE>, FromTables<DB, TB, TE>, {}>;
-    selectFrom<TE extends TableExpression<DB, TB>>(from: TE): SelectQueryBuilder<From<DB, TE>, FromTables<DB, TB, TE>, {}>;
-    /**
-     * See {@link QueryCreator.withSchema}
-     */
-    withSchema(schema: string): ExpressionBuilder<DB, TB>;
-    /**
-     * This can be used to reference columns.
-     *
-     * ### Examples
-     *
-     * In the next example we use the `ref` method to reference
-     * columns of the virtual table `excluded` in a type-safe way
-     * to create an upsert operation:
-     *
-     * ```ts
-     * db.insertInto('person')
-     *   .values(person)
-     *   .onConflict(oc => oc
-     *     .column('id')
-     *     .doUpdateSet({
-     *       first_name: (eb) => eb.ref('excluded.first_name'),
-     *       last_name: (eb) => eb.ref('excluded.last_name')
-     *     })
-     *   )
-     * ```
-     *
-     * In the next example we use `ref` in a raw sql expression. Unless you
-     * want to be as type-safe as possible, this is probably overkill:
-     *
-     * ```ts
-     * db.update('pet').set({
-     *   name: (eb) => sql`concat(${eb.ref('pet.name')}, ${suffix})`
-     * })
-     * ```
-     */
-    ref<RE extends StringReference<DB, TB>>(reference: RE): RawBuilder<ExtractTypeFromReferenceExpression<DB, TB, RE>>;
-}
-export interface ExpressionBuilderProps {
-    readonly executor: QueryExecutor;
-}

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

@@ -1,104 +0,0 @@
-/// <reference types="./expression-builder.d.ts" />
-import { SelectQueryBuilder } from './select-query-builder.js';
-import { SelectQueryNode } from '../operation-node/select-query-node.js';
-import { parseTableExpressionOrList, } from '../parser/table-parser.js';
-import { WithSchemaPlugin } from '../plugin/with-schema/with-schema-plugin.js';
-import { createQueryId } from '../util/query-id.js';
-import { FunctionModule } from './function-module.js';
-import { parseStringReference, } from '../parser/reference-parser.js';
-import { RawBuilder } from '../raw-builder/raw-builder.js';
-import { freeze } from '../util/object-utils.js';
-import { RawNode } from '../operation-node/raw-node.js';
-export class ExpressionBuilder {
-    #props;
-    constructor(props) {
-        this.#props = freeze(props);
-    }
-    /**
-     * Returns a {@link FunctionModule} that can be used to write type safe function
-     * calls.
-     *
-     * The difference between this and {@link Kysely.fn} is that this one is more
-     * type safe. You can only refer to columns visible to the part of the query
-     * you are building. {@link Kysely.fn} allows you to refer to columns in any
-     * table of the database even if it doesn't produce valid SQL.
-     *
-     * ```ts
-     * await db.selectFrom('person')
-     *   .innerJoin('pet', 'pet.owner_id', 'person.id')
-     *   .select([
-     *     'person.id',
-     *     (qb) => qb.fn.count('pet.id').as('pet_count')
-     *   ])
-     *   .groupBy('person.id')
-     *   .having(count('pet.id'), '>', 10)
-     *   .execute()
-     * ```
-     *
-     * The generated SQL (PostgreSQL):
-     *
-     * ```sql
-     * select "person"."id", count("pet"."id") as "pet_count"
-     * from "person"
-     * inner join "pet" on "pet"."owner_id" = "person"."id"
-     * group by "person"."id"
-     * having count("pet"."id") > $1
-     * ```
-     */
-    get fn() {
-        return new FunctionModule();
-    }
-    selectFrom(table) {
-        return new SelectQueryBuilder({
-            queryId: createQueryId(),
-            executor: this.#props.executor,
-            queryNode: SelectQueryNode.create(parseTableExpressionOrList(table)),
-        });
-    }
-    /**
-     * See {@link QueryCreator.withSchema}
-     */
-    withSchema(schema) {
-        return new ExpressionBuilder({
-            ...this.#props,
-            executor: this.#props.executor.withPluginAtFront(new WithSchemaPlugin(schema)),
-        });
-    }
-    /**
-     * This can be used to reference columns.
-     *
-     * ### Examples
-     *
-     * In the next example we use the `ref` method to reference
-     * columns of the virtual table `excluded` in a type-safe way
-     * to create an upsert operation:
-     *
-     * ```ts
-     * db.insertInto('person')
-     *   .values(person)
-     *   .onConflict(oc => oc
-     *     .column('id')
-     *     .doUpdateSet({
-     *       first_name: (eb) => eb.ref('excluded.first_name'),
-     *       last_name: (eb) => eb.ref('excluded.last_name')
-     *     })
-     *   )
-     * ```
-     *
-     * In the next example we use `ref` in a raw sql expression. Unless you
-     * want to be as type-safe as possible, this is probably overkill:
-     *
-     * ```ts
-     * db.update('pet').set({
-     *   name: (eb) => sql`concat(${eb.ref('pet.name')}, ${suffix})`
-     * })
-     * ```
-     */
-    ref(reference) {
-        return new RawBuilder({
-            queryId: createQueryId(),
-            plugins: this.#props.executor.plugins,
-            rawNode: RawNode.createWithChild(parseStringReference(reference)),
-        });
-    }
-}