kysely
Version:
Type safe SQL query builder
2,414 lines • 80.3 kB
TypeScript
import type { CompiledQuery } from '../query-compiler/compiled-query.js';
import { type JoinCallbackExpression, type JoinReferenceExpression } from '../parser/join-parser.js';
import { type TableExpression } from '../parser/table-parser.js';
import { type SelectExpression, type Selection, type AllSelection, type SelectCallback, type CallbackSelection } from '../parser/select-parser.js';
import { type ReferenceExpression } from '../parser/reference-parser.js';
import { SelectQueryNode } from '../operation-node/select-query-node.js';
import type { DrainOuterGeneric, NarrowPartial, Nullable, ShallowRecord, Simplify, SimplifyResult, SimplifySingleResult, SqlBool } from '../util/type-utils.js';
import { type DirectedOrderByStringReference, type OrderByExpression, type OrderByModifiers } from '../parser/order-by-parser.js';
import type { Compilable } from '../util/compilable.js';
import type { QueryExecutor } from '../query-executor/query-executor.js';
import type { QueryId } from '../util/query-id.js';
import { type GroupByArg } from '../parser/group-by-parser.js';
import type { KyselyPlugin } from '../plugin/kysely-plugin.js';
import type { WhereInterface } from './where-interface.js';
import type { HavingInterface } from './having-interface.js';
import type { Explainable, ExplainFormat } from '../util/explainable.js';
import { type SetOperandExpression } from '../parser/set-operation-parser.js';
import type { AliasedExpression, Expression } from '../expression/expression.js';
import { type ComparisonOperatorExpression, type OperandValueExpressionOrList } from '../parser/binary-operation-parser.js';
import type { KyselyTypeError } from '../util/type-error.js';
import type { Selectable } from '../util/column-type.js';
import type { Streamable, StreamOptions } from '../util/streamable.js';
import type { ExpressionOrFactory } from '../parser/expression-parser.js';
import { ExpressionWrapper } from '../expression/expression-wrapper.js';
import type { SelectQueryBuilderExpression } from './select-query-builder-expression.js';
import { type ValueExpression } from '../parser/value-parser.js';
import type { FetchModifier } from '../operation-node/fetch-node.js';
import type { TopModifier } from '../operation-node/top-node.js';
import type { OrderByInterface } from './order-by-interface.js';
import type { Executable, ExecuteTakeFirstOrThrowOptions } from '../util/executable.js';
import type { AbortableQueryOptions } from '../util/abort.js';
export interface SelectQueryBuilder<DB, TB extends keyof DB, O> extends WhereInterface<DB, TB>, HavingInterface<DB, TB>, OrderByInterface<DB, TB, O>, SelectQueryBuilderExpression<O>, Compilable<O>, Executable<O>, Explainable, Streamable<O> {
/**
* Adds a `where` expression to the query.
*
* Calling this method multiple times will combine the expressions using `and`.
*
* Also see {@link whereRef}
*
* ### Examples
*
* <!-- siteExample("where", "Simple where clause", 10) -->
*
* `where` method calls are combined with `AND`:
*
* ```ts
* const person = await db
* .selectFrom('person')
* .selectAll()
* .where('first_name', '=', 'Jennifer')
* .where('age', '>', 40)
* .executeTakeFirst()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select * from "person" where "first_name" = $1 and "age" > $2
* ```
*
* Operator can be any supported operator or if the typings don't support it
* you can always use:
*
* ```ts
* import { sql } from 'kysely'
*
* sql`your operator`
* ```
*
* <!-- siteExample("where", "Where in", 20) -->
*
* Find multiple items using a list of identifiers:
*
* ```ts
* const persons = await db
* .selectFrom('person')
* .selectAll()
* .where('id', 'in', [1, 2, 3])
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select * from "person" where "id" in ($1, $2, $3)
* ```
*
* <!-- siteExample("where", "Object filter", 30) -->
*
* You can use the `and` function to create a simple equality
* filter using an object
*
* ```ts
* const persons = await db
* .selectFrom('person')
* .selectAll()
* .where((eb) => eb.and({
* first_name: 'Jennifer',
* last_name: eb.ref('first_name')
* }))
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select *
* from "person"
* where (
* "first_name" = $1
* and "last_name" = "first_name"
* )
* ```
*
* <!-- siteExample("where", "OR where", 40) -->
*
* To combine conditions using `OR`, you can use the expression builder.
* There are two ways to create `OR` expressions. Both are shown in this
* example:
*
* ```ts
* const persons = await db
* .selectFrom('person')
* .selectAll()
* // 1. Using the `or` method on the expression builder:
* .where((eb) => eb.or([
* eb('first_name', '=', 'Jennifer'),
* eb('first_name', '=', 'Sylvester')
* ]))
* // 2. Chaining expressions using the `or` method on the
* // created expressions:
* .where((eb) =>
* eb('last_name', '=', 'Aniston').or('last_name', '=', 'Stallone')
* )
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select *
* from "person"
* where (
* ("first_name" = $1 or "first_name" = $2)
* and
* ("last_name" = $3 or "last_name" = $4)
* )
* ```
*
* <!-- siteExample("where", "Conditional where calls", 50) -->
*
* You can add expressions conditionally like this:
*
* ```ts
* import { Expression, SqlBool } from 'kysely'
*
* const firstName: string | undefined = 'Jennifer'
* const lastName: string | undefined = 'Aniston'
* const under18 = true
* const over60 = true
*
* let query = db
* .selectFrom('person')
* .selectAll()
*
* if (firstName) {
* // The query builder is immutable. Remember to reassign
* // the result back to the query variable.
* query = query.where('first_name', '=', firstName)
* }
*
* if (lastName) {
* query = query.where('last_name', '=', lastName)
* }
*
* if (under18 || over60) {
* // Conditional OR expressions can be added like this.
* query = query.where((eb) => {
* const ors: Expression<SqlBool>[] = []
*
* if (under18) {
* ors.push(eb('age', '<', 18))
* }
*
* if (over60) {
* ors.push(eb('age', '>', 60))
* }
*
* return eb.or(ors)
* })
* }
*
* const persons = await query.execute()
* ```
*
* Both the first and third argument can also be arbitrary expressions like
* subqueries. An expression can defined by passing a function and calling
* the methods of the {@link ExpressionBuilder} passed to the callback:
*
* ```ts
* const persons = await db
* .selectFrom('person')
* .selectAll()
* .where(
* (qb) => qb.selectFrom('pet')
* .select('pet.name')
* .whereRef('pet.owner_id', '=', 'person.id')
* .limit(1),
* '=',
* 'Fluffy'
* )
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select *
* from "person"
* where (
* select "pet"."name"
* from "pet"
* where "pet"."owner_id" = "person"."id"
* limit $1
* ) = $2
* ```
*
* A `where in` query can be built by using the `in` operator and an array
* of values. The values in the array can also be expressions:
*
* ```ts
* const persons = await db
* .selectFrom('person')
* .selectAll()
* .where('person.id', 'in', [100, 200, 300])
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select * from "person" where "id" in ($1, $2, $3)
* ```
*
* <!-- siteExample("where", "Complex where clause", 60) -->
*
* For complex `where` expressions you can pass in a single callback and
* use the `ExpressionBuilder` to build your expression:
*
* ```ts
* const firstName = 'Jennifer'
* const maxAge = 60
*
* const persons = await db
* .selectFrom('person')
* .selectAll('person')
* .where(({ eb, or, and, not, exists, selectFrom }) => and([
* or([
* eb('first_name', '=', firstName),
* eb('age', '<', maxAge)
* ]),
* not(exists(
* selectFrom('pet')
* .select('pet.id')
* .whereRef('pet.owner_id', '=', 'person.id')
* ))
* ]))
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person".*
* from "person"
* where (
* (
* "first_name" = $1
* or "age" < $2
* )
* and not exists (
* select "pet"."id" from "pet" where "pet"."owner_id" = "person"."id"
* )
* )
* ```
*
* If everything else fails, you can always use the {@link sql} tag
* as any of the arguments, including the operator:
*
* ```ts
* import { sql } from 'kysely'
*
* const persons = await db
* .selectFrom('person')
* .selectAll()
* .where(
* sql<string>`coalesce(first_name, last_name)`,
* 'like',
* '%' + name + '%',
* )
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select * from "person"
* where coalesce(first_name, last_name) like $1
* ```
*
* In all examples above the columns were known at compile time
* (except for the raw {@link sql} expressions). By default kysely only
* allows you to refer to columns that exist in the database **and**
* can be referred to in the current query and context.
*
* Sometimes you may want to refer to columns that come from the user
* input and thus are not available at compile time.
*
* You have two options, the {@link sql} tag or `db.dynamic`. The example below
* uses both:
*
* ```ts
* import { sql } from 'kysely'
* const { ref } = db.dynamic
*
* const columnFromUserInput: string = 'id'
*
* const persons = await db
* .selectFrom('person')
* .selectAll()
* .where(ref(columnFromUserInput), '=', 1)
* .where(sql.id(columnFromUserInput), '=', 2)
* .execute()
* ```
*/
where<RE extends ReferenceExpression<DB, TB>, VE extends OperandValueExpressionOrList<DB, TB, RE>>(lhs: RE, op: ComparisonOperatorExpression, rhs: VE): SelectQueryBuilder<DB, TB, O>;
where<E extends ExpressionOrFactory<DB, TB, SqlBool>>(expression: E): SelectQueryBuilder<DB, TB, O>;
/**
* Adds a `where` clause where both sides of the operator are references
* to columns.
*
* The normal `where` method treats the right hand side argument as a
* value by default. `whereRef` treats it as a column reference. This method is
* expecially useful with joins and correlated subqueries.
*
* ### Examples
*
* Usage with a join:
*
* ```ts
* db.selectFrom(['person', 'pet'])
* .selectAll()
* .whereRef('person.first_name', '=', 'pet.name')
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select * from "person", "pet" where "person"."first_name" = "pet"."name"
* ```
*
* Usage in a subquery:
*
* ```ts
* const persons = await db
* .selectFrom('person')
* .selectAll('person')
* .select((eb) => eb
* .selectFrom('pet')
* .select('name')
* .whereRef('pet.owner_id', '=', 'person.id')
* .limit(1)
* .as('pet_name')
* )
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person".*, (
* select "name"
* from "pet"
* where "pet"."owner_id" = "person"."id"
* limit $1
* ) as "pet_name"
* from "person"
*/
whereRef<LRE extends ReferenceExpression<DB, TB>, RRE extends ReferenceExpression<DB, TB>>(lhs: LRE, op: ComparisonOperatorExpression, rhs: RRE): SelectQueryBuilder<DB, TB, O>;
/**
* Just like {@link WhereInterface.where | where} but adds a `having` statement
* instead of a `where` statement.
*/
having<RE extends ReferenceExpression<DB, TB>, VE extends OperandValueExpressionOrList<DB, TB, RE>>(lhs: RE, op: ComparisonOperatorExpression, rhs: VE): SelectQueryBuilder<DB, TB, O>;
having<E extends ExpressionOrFactory<DB, TB, SqlBool>>(expression: E): SelectQueryBuilder<DB, TB, O>;
/**
* Just like {@link WhereInterface.whereRef | whereRef} but adds a `having` statement
* instead of a `where` statement.
*/
havingRef<LRE extends ReferenceExpression<DB, TB>, RRE extends ReferenceExpression<DB, TB>>(lhs: LRE, op: ComparisonOperatorExpression, rhs: RRE): SelectQueryBuilder<DB, TB, O>;
/**
* Adds a select statement to the query.
*
* When a column (or any expression) is selected, Kysely adds its type to the return
* type of the query. Kysely is smart enough to parse the selection names and types
* from aliased columns, subqueries, raw expressions etc.
*
* Kysely only allows you to select columns and expressions that exist and would
* produce valid SQL. However, Kysely is not perfect and there may be cases where
* the type inference doesn't work and you need to override it. You can always
* use the {@link Kysely.dynamic | dynamic} module and the {@link sql} tag
* to override the types.
*
* Select calls are additive. Calling `select('id').select('first_name')` is the
* same as calling `select(['id', 'first_name'])`.
*
* To select all columns of the query or specific tables see the
* {@link selectAll} method.
*
* See the {@link $if} method if you are looking for a way to add selections
* based on a runtime condition.
*
* ### Examples
*
* <!-- siteExample("select", "A single column", 10) -->
*
* Select a single column:
*
* ```ts
* const persons = await db
* .selectFrom('person')
* .select('id')
* .where('first_name', '=', 'Arnold')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id" from "person" where "first_name" = $1
* ```
*
* <!-- siteExample("select", "Column with a table", 20) -->
*
* Select a single column and specify a table:
*
* ```ts
* const persons = await db
* .selectFrom(['person', 'pet'])
* .select('person.id')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person"."id" from "person", "pet"
* ```
*
* <!-- siteExample("select", "Multiple columns", 30) -->
*
* Select multiple columns:
*
* ```ts
* const persons = await db
* .selectFrom('person')
* .select(['person.id', 'first_name'])
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person"."id", "first_name" from "person"
* ```
*
* <!-- siteExample("select", "Aliases", 40) -->
*
* You can give an alias for selections and tables by appending `as the_alias` to the name:
*
* ```ts
* const persons = await db
* .selectFrom('person as p')
* .select([
* 'first_name as fn',
* 'p.last_name as ln'
* ])
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select
* "first_name" as "fn",
* "p"."last_name" as "ln"
* from "person" as "p"
* ```
*
* <!-- siteExample("select", "Complex selections", 50) -->
*
* You can select arbitrary expression including subqueries and raw sql snippets.
* When you do that, you need to give a name for the selections using the `as` method:
*
* ```ts
* import { sql } from 'kysely'
*
* const persons = await db.selectFrom('person')
* .select(({ eb, selectFrom, or, val, lit }) => [
* // Select a correlated subquery
* selectFrom('pet')
* .whereRef('person.id', '=', 'pet.owner_id')
* .select('pet.name')
* .orderBy('pet.name')
* .limit(1)
* .as('first_pet_name'),
*
* // Build and select an expression using
* // the expression builder
* or([
* eb('first_name', '=', 'Jennifer'),
* eb('first_name', '=', 'Arnold')
* ]).as('is_jennifer_or_arnold'),
*
* // Select a raw sql expression
* sql<string>`concat(first_name, ' ', last_name)`.as('full_name'),
*
* // Select a static string value
* val('Some value').as('string_value'),
*
* // Select a literal value
* lit(42).as('literal_value'),
* ])
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select
* (
* select "pet"."name"
* from "pet"
* where "person"."id" = "pet"."owner_id"
* order by "pet"."name"
* limit $1
* ) as "pet_name",
* ("first_name" = $2 or "first_name" = $3) as "jennifer_or_arnold",
* concat(first_name, ' ', last_name) as "full_name",
* $4 as "string_value",
* 42 as "literal_value"
* from "person"
* ```
*
* In case you use the {@link sql} tag you need to specify the type of the expression
* (in this example `string`).
*
* <!-- siteExample("select", "Not null", 51) -->
*
* Sometimes you can be sure something's not null, but Kysely isn't able to infer
* it. For example calling `where('last_name', 'is not', null)` doesn't make
* `last_name` not null in the result type, but unless you have other where statements
* you can be sure it's never null.
*
* Kysely has a couple of helpers for dealing with these cases: `$notNull()` and `$narrowType`.
* Both are used in the following example:
*
* ```ts
* import { NotNull } from 'kysely'
* import { jsonObjectFrom } from 'kysely/helpers/postgres'
*
* const persons = db
* .selectFrom('person')
* .select((eb) => [
* 'last_name',
* // Let's assume we know the person has at least one
* // pet. We can use the `.$notNull()` method to make
* // the expression not null. You could just as well
* // add `pet` to the `$narrowType` call below.
* jsonObjectFrom(
* eb.selectFrom('pet')
* .selectAll()
* .limit(1)
* .whereRef('person.id', '=', 'pet.owner_id')
* ).$notNull().as('pet')
* ])
* .where('last_name', 'is not', null)
* // $narrowType can be used to narrow the output type.
* // The special `NotNull` type can be used to make a
* // selection not null. You could add `pet: NotNull`
* // here and omit the `$notNull()` call on it.
* // Use whichever way you prefer.
* .$narrowType<{ last_name: NotNull }>()
* .execute()
* ```
*
* All the examples above assume you know the column names at compile time.
* While it's better to build your code like that (that way you also know
* the types) sometimes it's not possible or you just prefer to write more
* dynamic code.
* <br><br>
* In this example, we use the `dynamic` module's methods to add selections
* dynamically:
*
* ```ts
* const { ref } = db.dynamic
*
* // Some column name provided by the user. Value not known at compile time.
* const columnFromUserInput: string = 'first_name';
*
* // A type that lists all possible values `columnFromUserInput` can have.
* // You can use `keyof Person` if any column of an interface is allowed.
* type PossibleColumns = 'last_name' | 'first_name' | 'birthdate'
*
* const people = await db
* .selectFrom('person')
* .select([
* ref<PossibleColumns>(columnFromUserInput),
* 'id'
* ])
* .execute()
*
* // The resulting type contains all `PossibleColumns` as optional fields
* // because we cannot know which field was actually selected before
* // running the code.
* const lastName: string | null | undefined = people[0].last_name
* const firstName: string | undefined = people[0].first_name
* const birthDate: Date | null | undefined = people[0].birthdate
*
* // The result type also contains the compile time selection `id`.
* people[0].id
* ```
*/
select<SE extends SelectExpression<DB, TB>>(selections: ReadonlyArray<SE>): SelectQueryBuilder<DB, TB, O & Selection<DB, TB, SE>>;
select<const CB extends SelectCallback<DB, TB>>(callback: CB): SelectQueryBuilder<DB, TB, O & CallbackSelection<DB, TB, CB>>;
select<SE extends SelectExpression<DB, TB>>(selection: SE): SelectQueryBuilder<DB, TB, O & Selection<DB, TB, SE>>;
/**
* Adds `distinct on` expressions to the select clause.
*
* ### Examples
*
* <!-- siteExample("select", "Distinct on", 80) -->
*
* ```ts
* const persons = await db.selectFrom('person')
* .innerJoin('pet', 'pet.owner_id', 'person.id')
* .where('pet.name', '=', 'Doggo')
* .distinctOn('person.id')
* .selectAll('person')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select distinct on ("person"."id") "person".*
* from "person"
* inner join "pet" on "pet"."owner_id" = "person"."id"
* where "pet"."name" = $1
* ```
*/
distinctOn<RE extends ReferenceExpression<DB, TB>>(selections: ReadonlyArray<RE>): SelectQueryBuilder<DB, TB, O>;
distinctOn<RE extends ReferenceExpression<DB, TB>>(selection: RE): SelectQueryBuilder<DB, TB, O>;
/**
* This can be used to add any additional SQL to the front of the query __after__ the `select` keyword.
*
* ### Examples
*
* ```ts
* import { sql } from 'kysely'
*
* await db.selectFrom('person')
* .modifyFront(sql`sql_no_cache`)
* .select('first_name')
* .execute()
* ```
*
* The generated SQL (MySQL):
*
* ```sql
* select sql_no_cache `first_name`
* from `person`
* ```
*/
modifyFront(modifier: Expression<any>): SelectQueryBuilder<DB, TB, O>;
/**
* This can be used to add any additional SQL to the end of the query.
*
* Also see {@link forUpdate}, {@link forShare}, {@link forKeyShare}, {@link forNoKeyUpdate}
* {@link skipLocked} and {@link noWait}.
*
* ### Examples
*
* ```ts
* import { sql } from 'kysely'
*
* await db.selectFrom('person')
* .select('first_name')
* .modifyEnd(sql`for update`)
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "first_name"
* from "person"
* for update
* ```
*/
modifyEnd(modifier: Expression<any>): SelectQueryBuilder<DB, TB, O>;
/**
* Makes the selection distinct.
*
* ### Examples
*
* <!-- siteExample("select", "Distinct", 70) -->
*
* ```ts
* const persons = await db.selectFrom('person')
* .select('first_name')
* .distinct()
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select distinct "first_name" from "person"
* ```
*/
distinct(): SelectQueryBuilder<DB, TB, O>;
/**
* Adds the `for update` modifier to a select query on supported databases.
*/
forUpdate(of?: TableOrList<TB>): SelectQueryBuilder<DB, TB, O>;
/**
* Adds the `for share` modifier to a select query on supported databases.
*/
forShare(of?: TableOrList<TB>): SelectQueryBuilder<DB, TB, O>;
/**
* Adds the `for key share` modifier to a select query on supported databases.
*/
forKeyShare(of?: TableOrList<TB>): SelectQueryBuilder<DB, TB, O>;
/**
* Adds the `for no key update` modifier to a select query on supported databases.
*/
forNoKeyUpdate(of?: TableOrList<TB>): SelectQueryBuilder<DB, TB, O>;
/**
* Adds the `skip locked` modifier to a select query on supported databases.
*/
skipLocked(): SelectQueryBuilder<DB, TB, O>;
/**
* Adds the `nowait` modifier to a select query on supported databases.
*/
noWait(): SelectQueryBuilder<DB, TB, O>;
/**
* Adds a `select *` or `select table.*` clause to the query.
*
* ### Examples
*
* <!-- siteExample("select", "All columns", 90) -->
*
* The `selectAll` method generates `SELECT *`:
*
* ```ts
* const persons = await db
* .selectFrom('person')
* .selectAll()
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select * from "person"
* ```
*
* <!-- siteExample("select", "All columns of a table", 100) -->
*
* Select all columns of a table:
*
* ```ts
* const persons = await db
* .selectFrom('person')
* .selectAll('person')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person".* from "person"
* ```
*
* Select all columns of multiple tables:
*
* ```ts
* const personsPets = await db
* .selectFrom(['person', 'pet'])
* .selectAll(['person', 'pet'])
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person".*, "pet".* from "person", "pet"
* ```
*/
selectAll<T extends TB>(table: ReadonlyArray<T>): SelectQueryBuilder<DB, TB, O & AllSelection<DB, T>>;
selectAll<T extends TB>(table: T): SelectQueryBuilder<DB, TB, O & Selectable<DB[T]>>;
selectAll(): SelectQueryBuilder<DB, TB, O & AllSelection<DB, TB>>;
/**
* Joins another table to the query using an `inner join`.
*
* ### Examples
*
* <!-- siteExample("join", "Simple inner join", 10) -->
*
* Simple `inner join`s can be done by providing a table name and two columns to join:
*
* ```ts
* const result = await db
* .selectFrom('person')
* .innerJoin('pet', 'pet.owner_id', 'person.id')
* // `select` needs to come after the call to `innerJoin` so
* // that you can select from the joined table.
* .select(['person.id', 'pet.name as pet_name'])
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person"."id", "pet"."name" as "pet_name"
* from "person"
* inner join "pet"
* on "pet"."owner_id" = "person"."id"
* ```
*
* <!-- siteExample("join", "Aliased inner join", 20) -->
*
* You can give an alias for the joined table like this:
*
* ```ts
* await db.selectFrom('person')
* .innerJoin('pet as p', 'p.owner_id', 'person.id')
* .where('p.name', '=', 'Doggo')
* .selectAll()
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select *
* from "person"
* inner join "pet" as "p"
* on "p"."owner_id" = "person"."id"
* where "p".name" = $1
* ```
*
* <!-- siteExample("join", "Complex join", 30) -->
*
* You can provide a function as the second argument to get a join
* builder for creating more complex joins. The join builder has a
* bunch of `on*` methods for building the `on` clause of the join.
* There's basically an equivalent for every `where` method
* (`on`, `onRef` etc.).
*
* You can do all the same things with the
* `on` method that you can with the corresponding `where` method (like [OR expressions for example](https://kysely.dev/docs/examples/WHERE/or-where)).
* See the `where` method documentation for more examples.
*
* ```ts
* await db.selectFrom('person')
* .innerJoin(
* 'pet',
* (join) => join
* .onRef('pet.owner_id', '=', 'person.id')
* .on('pet.name', '=', 'Doggo')
* .on((eb) => eb.or([
* eb('person.age', '>', 18),
* eb('person.age', '<', 100)
* ]))
* )
* .selectAll()
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select *
* from "person"
* inner join "pet"
* on "pet"."owner_id" = "person"."id"
* and "pet"."name" = $1
* and (
* "person"."age" > $2
* OR "person"."age" < $3
* )
* ```
*
* <!-- siteExample("join", "Subquery join", 40) -->
*
* You can join a subquery by providing two callbacks:
*
* ```ts
* const result = await db.selectFrom('person')
* .innerJoin(
* (eb) => eb
* .selectFrom('pet')
* .select(['owner_id as owner', 'name'])
* .where('name', '=', 'Doggo')
* .as('doggos'),
* (join) => join
* .onRef('doggos.owner', '=', 'person.id'),
* )
* .selectAll('doggos')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "doggos".*
* from "person"
* inner join (
* select "owner_id" as "owner", "name"
* from "pet"
* where "name" = $1
* ) as "doggos"
* on "doggos"."owner" = "person"."id"
* ```
*/
innerJoin<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>;
innerJoin<TE extends TableExpression<DB, TB>, const FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithInnerJoin<DB, TB, O, TE>;
/**
* Just like {@link innerJoin} but adds a `left join` instead of an `inner join`.
*/
leftJoin<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>;
leftJoin<TE extends TableExpression<DB, TB>, const FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithLeftJoin<DB, TB, O, TE>;
/**
* Just like {@link innerJoin} but adds a `right join` instead of an `inner join`.
*/
rightJoin<TE extends TableExpression<DB, TB>, K1 extends JoinReferenceExpression<DB, TB, TE>, K2 extends JoinReferenceExpression<DB, TB, TE>>(table: TE, k1: K1, k2: K2): SelectQueryBuilderWithRightJoin<DB, TB, O, TE>;
rightJoin<TE extends TableExpression<DB, TB>, const FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithRightJoin<DB, TB, O, TE>;
/**
* Just like {@link innerJoin} but adds a `full join` instead of an `inner join`.
*
* This is only supported by some dialects like PostgreSQL, MS SQL Server and SQLite.
*/
fullJoin<TE extends TableExpression<DB, TB>, K1 extends JoinReferenceExpression<DB, TB, TE>, K2 extends JoinReferenceExpression<DB, TB, TE>>(table: TE, k1: K1, k2: K2): SelectQueryBuilderWithFullJoin<DB, TB, O, TE>;
fullJoin<TE extends TableExpression<DB, TB>, const FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithFullJoin<DB, TB, O, TE>;
/**
* Just like {@link innerJoin} but adds a `cross join` instead of an `inner join`.
*/
crossJoin<TE extends TableExpression<DB, TB>>(table: TE): SelectQueryBuilderWithInnerJoin<DB, TB, O, TE>;
/**
* Just like {@link innerJoin} but adds a lateral join instead of an inner join.
*
* This is only supported by some dialects like PostgreSQL and MySQL.
*
* ### Examples
*
* ```ts
* await 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')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person"."first_name", "p"."name"
* from "person"
* inner join lateral (
* select "name"
* from "pet"
* where "pet"."owner_id" = "person"."id"
* ) as "p" on true
* order by "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>, const FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithInnerJoin<DB, TB, O, TE>;
/**
* Just like {@link innerJoin} but adds a `left join lateral` instead of an `inner join`.
*
* This is only supported by some dialects like PostgreSQL and MySQL.
*
* ### Examples
*
* ```ts
* await 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')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person"."first_name", "p"."name"
* from "person"
* left join lateral (
* select "name"
* from "pet"
* where "pet"."owner_id" = "person"."id"
* ) as "p" on true
* order by "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>, const FN extends JoinCallbackExpression<DB, TB, TE>>(table: TE, callback: FN): SelectQueryBuilderWithLeftJoin<DB, TB, O, TE>;
/**
* Just like {@link innerJoin} but adds a `cross join lateral` instead of an `inner join`.
*
* This is only supported by some dialects like PostgreSQL.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .crossJoinLateral(
* (eb) =>
* eb.selectFrom('pet')
* .select('name')
* .whereRef('pet.owner_id', '=', 'person.id')
* .as('p')
* )
* .select(['first_name', 'p.name'])
* .orderBy('first_name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person"."first_name", "p"."name"
* from "person"
* cross join lateral (
* select "name"
* from "pet"
* where "pet"."owner_id" = "person"."id"
* ) as "p"
* order by "first_name"
* ```
*/
crossJoinLateral<TE extends TableExpression<DB, TB>>(table: TE): SelectQueryBuilderWithInnerJoin<DB, TB, O, TE>;
/**
* Joins another table to the query using a `cross apply`.
*
* This is only supported by some dialects like MS SQL Server.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .crossApply(
* (eb) =>
* eb.selectFrom('pet')
* .select('name')
* .whereRef('pet.owner_id', '=', 'person.id')
* .as('p')
* )
* .select(['first_name', 'p.name'])
* .orderBy('first_name')
* .execute()
* ```
*
* The generated SQL (MS SQL Server):
*
* ```sql
* select "person"."first_name", "p"."name"
* from "person"
* cross apply (
* select "name"
* from "pet"
* where "pet"."owner_id" = "person"."id"
* ) as "p"
* order by "first_name"
* ```
*/
crossApply<TE extends TableExpression<DB, TB>>(table: TE): SelectQueryBuilderWithInnerJoin<DB, TB, O, TE>;
/**
* Just like {@link crossApply} but adds an `outer apply` instead of a `cross apply`.
*
* This is only supported by some dialects like MS SQL Server.
*/
outerApply<TE extends TableExpression<DB, TB>>(table: TE): SelectQueryBuilderWithLeftJoin<DB, TB, O, TE>;
/**
* Adds a `group by` clause to the query.
*
* ### Examples
*
* ```ts
* import { sql } from 'kysely'
*
* await db
* .selectFrom('person')
* .select([
* 'first_name',
* sql<string>`max(id)`.as('max_id')
* ])
* .groupBy('first_name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "first_name", max(id)
* from "person"
* group by "first_name"
* ```
*
* `groupBy` also accepts an array:
*
* ```ts
* import { sql } from 'kysely'
*
* await db
* .selectFrom('person')
* .select([
* 'first_name',
* 'last_name',
* sql<string>`max(id)`.as('max_id')
* ])
* .groupBy([
* 'first_name',
* 'last_name'
* ])
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "first_name", "last_name", max(id)
* from "person"
* group by "first_name", "last_name"
* ```
*
* The group by expressions can also be subqueries or
* raw sql expressions:
*
* ```ts
* import { sql } from 'kysely'
*
* await db
* .selectFrom('person')
* .select([
* 'first_name',
* 'last_name',
* sql<string>`max(id)`.as('max_id')
* ])
* .groupBy([
* sql<string>`concat(first_name, last_name)`,
* (qb) => qb.selectFrom('pet').select('id').limit(1)
* ])
* .execute()
* ```
*
* `dynamic.ref` can be used to refer to columns not known at
* compile time:
*
* ```ts
* async function someQuery(groupBy: string) {
* const { ref } = db.dynamic
*
* return await db
* .selectFrom('person')
* .select('first_name')
* .groupBy(ref(groupBy))
* .execute()
* }
*
* someQuery('first_name')
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "first_name"
* from "person"
* group by "first_name"
* ```
*/
groupBy<GE extends GroupByArg<DB, TB, O>>(groupBy: GE): SelectQueryBuilder<DB, TB, O>;
/**
* Adds an `order by` clause to the query.
*
* `orderBy` calls are additive. Meaning, additional `orderBy` calls append to
* the existing order by clause.
*
* `orderBy` is supported in select queries on all dialects. In MySQL, you can
* also use `orderBy` in update and delete queries.
*
* In a single call you can add a single column/expression or multiple columns/expressions.
*
* Single column/expression calls can have 1-2 arguments. The first argument is
* the expression to order by, while the second optional argument is the direction
* (`asc` or `desc`), a callback that accepts and returns an {@link OrderByItemBuilder}
* or an expression.
*
* See {@link clearOrderBy} to remove the `order by` clause from a query.
*
* ### Examples
*
* Single column/expression per call:
*
* ```ts
* await db
* .selectFrom('person')
* .select('person.first_name as fn')
* .orderBy('id')
* .orderBy('fn', 'desc')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person"."first_name" as "fn"
* from "person"
* order by "id", "fn" desc
* ```
*
* Building advanced modifiers:
*
* ```ts
* await db
* .selectFrom('person')
* .select('person.first_name as fn')
* .orderBy('id', (ob) => ob.desc().nullsFirst())
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person"."first_name" as "fn"
* from "person"
* order by "id" desc nulls first
* ```
*
* The order by expression can also be a raw sql expression or a subquery
* in addition to column references:
*
* ```ts
* import { sql } from 'kysely'
*
* await db
* .selectFrom('person')
* .selectAll()
* .orderBy((eb) => eb.selectFrom('pet')
* .select('pet.name')
* .whereRef('pet.owner_id', '=', 'person.id')
* .limit(1)
* )
* .orderBy(
* sql<string>`concat(first_name, last_name) asc`
* )
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select *
* from "person"
* order by
* ( select "pet"."name"
* from "pet"
* where "pet"."owner_id" = "person"."id"
* limit $1
* ) asc,
* concat(first_name, last_name) asc
* ```
*
* `dynamic.ref` can be used to refer to columns not known at
* compile time:
*
* ```ts
* async function someQuery(orderBy: string) {
* const { ref } = db.dynamic
*
* return await db
* .selectFrom('person')
* .select('person.first_name as fn')
* .orderBy(ref(orderBy))
* .execute()
* }
*
* someQuery('fn')
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "person"."first_name" as "fn"
* from "person"
* order by "fn"
* ```
*/
orderBy<OE extends OrderByExpression<DB, TB, O>>(expr: OE, modifiers?: OrderByModifiers): SelectQueryBuilder<DB, TB, O>;
/**
* @deprecated It does ~2-2.5x more compile-time instantiations than multiple `orderBy(expr, modifiers?)` calls, and has broken autocompletion.
*/
orderBy<OE extends OrderByExpression<DB, TB, O> | DirectedOrderByStringReference<DB, TB, O>>(exprs: ReadonlyArray<OE>): SelectQueryBuilder<DB, TB, O>;
/**
* @deprecated Use orderBy(expr, direction) instead.
*/
orderBy<OE extends DirectedOrderByStringReference<DB, TB, O>>(expr: OE): SelectQueryBuilder<DB, TB, O>;
/**
* @deprecated Use `orderBy(expr, (ob) => ...)` instead.
*/
orderBy<OE extends OrderByExpression<DB, TB, O>>(expr: OE, modifiers: Expression<any>): SelectQueryBuilder<DB, TB, O>;
/**
* Adds a limit clause to the query.
*
* Passing a `null` value is only supported by some dialects like PostgreSQL,
* and will result in a no-op limit clause.
*
* ### Examples
*
* Select the first 10 rows of the result:
*
* ```ts
* await db
* .selectFrom('person')
* .select('first_name')
* .limit(10)
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "first_name" from "person" limit $1
* ```
*
* Select rows from index 10 to index 19 of the result:
*
* ```ts
* await db
* .selectFrom('person')
* .select('first_name')
* .limit(10)
* .offset(10)
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "first_name" from "person" limit $1 offset $2
* ```
*/
limit<VE extends ValueExpression<DB, TB, number | bigint | null>>(limit: VE): SelectQueryBuilder<DB, TB, O>;
/**
* Adds an `offset` clause to the query.
*
* ### Examples
*
* Select rows from index 10 to index 19 of the result:
*
* ```ts
* await db
* .selectFrom('person')
* .select('first_name')
* .limit(10)
* .offset(10)
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "first_name" from "person" limit $1 offset $2
* ```
*/
offset<VE extends ValueExpression<DB, TB, number | bigint>>(offset: VE): SelectQueryBuilder<DB, TB, O>;
/**
* Adds a `fetch` clause to the query.
*
* This clause is only supported by some dialects like PostgreSQL or MS SQL Server.
*
* ### Examples
*
* ```ts
* await db
* .selectFrom('person')
* .select('first_name')
* .orderBy('first_name')
* .offset(0)
* .fetch(10)
* .execute()
* ```
*
* The generated SQL (MS SQL Server):
*
* ```sql
* select "first_name"
* from "person"
* order by "first_name"
* offset 0 rows
* fetch next 10 rows only
* ```
*/
fetch(rowCount: number | bigint, modifier?: FetchModifier): SelectQueryBuilder<DB, TB, O>;
/**
* Adds a `top` clause to the query.
*
* This clause is only supported by some dialects like MS SQL Server.
*
* ### Examples
*
* Select 10 biggest ages:
*
* ```ts
* await db
* .selectFrom('person')
* .select('age')
* .top(10)
* .orderBy('age desc')
* .execute()
* ```
*
* The generated SQL (MS SQL Server):
*
* ```sql
* select top(10) "age" from "person" order by "age" desc
* ```
*
* Select 10% first rows:
*
* ```ts
* await db
* .selectFrom('person')
* .selectAll()
* .top(10, 'percent')
* .execute()
* ```
*
* The generated SQL (MS SQL Server):
*
* ```sql
* select top(10) percent * from "person"
* ```
*/
top(expression: number | bigint, modifiers?: TopModifier): SelectQueryBuilder<DB, TB, O>;
/**
* Combines another select query or raw expression to this query using `union`.
*
* The output row type of the combined query must match `this` query.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .union(db.selectFrom('pet').select(['id', 'name']))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* union
* select "id", "name"
* from "pet"
* order by "name"
* ```
*
* You can provide a callback to get an expression builder.
* In the following example, this allows us to wrap the query in parentheses:
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .union((eb) => eb.parens(
* eb.selectFrom('pet').select(['id', 'name'])
* ))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* union
* (
* select "id", "name"
* from "pet"
* )
* order by "name"
* ```
*/
union<E extends SetOperandExpression<DB, O>>(expression: E): SelectQueryBuilder<DB, TB, O>;
/**
* Combines another select query or raw expression to this query using `union all`.
*
* The output row type of the combined query must match `this` query.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .unionAll(db.selectFrom('pet').select(['id', 'name']))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* union all
* select "id", "name"
* from "pet"
* order by "name"
* ```
*
* You can provide a callback to get an expression builder.
* In the following example, this allows us to wrap the query in parentheses:
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .unionAll((eb) => eb.parens(
* eb.selectFrom('pet').select(['id', 'name'])
* ))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* union all
* (
* select "id", "name"
* from "pet"
* )
* order by "name"
* ```
*/
unionAll<E extends SetOperandExpression<DB, O>>(expression: E): SelectQueryBuilder<DB, TB, O>;
/**
* Combines another select query or raw expression to this query using `intersect`.
*
* The output row type of the combined query must match `this` query.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .intersect(db.selectFrom('pet').select(['id', 'name']))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* intersect
* select "id", "name"
* from "pet"
* order by "name"
* ```
*
* You can provide a callback to get an expression builder.
* In the following example, this allows us to wrap the query in parentheses:
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .intersect((eb) => eb.parens(
* eb.selectFrom('pet').select(['id', 'name'])
* ))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* intersect
* (
* select "id", "name"
* from "pet"
* )
* order by "name"
* ```
*/
intersect<E extends SetOperandExpression<DB, O>>(expression: E): SelectQueryBuilder<DB, TB, O>;
/**
* Combines another select query or raw expression to this query using `intersect all`.
*
* The output row type of the combined query must match `this` query.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .intersectAll(db.selectFrom('pet').select(['id', 'name']))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* intersect all
* select "id", "name"
* from "pet"
* order by "name"
* ```
*
* You can provide a callback to get an expression builder.
* In the following example, this allows us to wrap the query in parentheses:
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .intersectAll((eb) => eb.parens(
* eb.selectFrom('pet').select(['id', 'name'])
* ))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* intersect all
* (
* select "id", "name"
* from "pet"
* )
* order by "name"
* ```
*/
intersectAll<E extends SetOperandExpression<DB, O>>(expression: E): SelectQueryBuilder<DB, TB, O>;
/**
* Combines another select query or raw expression to this query using `except`.
*
* The output row type of the combined query must match `this` query.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .except(db.selectFrom('pet').select(['id', 'name']))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* except
* select "id", "name"
* from "pet"
* order by "name"
* ```
*
* You can provide a callback to get an expression builder.
* In the following example, this allows us to wrap the query in parentheses:
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .except((eb) => eb.parens(
* eb.selectFrom('pet').select(['id', 'name'])
* ))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* except
* (
* select "id", "name"
* from "pet"
* )
* order by "name"
* ```
*/
except<E extends SetOperandExpression<DB, O>>(expression: E): SelectQueryBuilder<DB, TB, O>;
/**
* Combines another select query or raw expression to this query using `except all`.
*
* The output row type of the combined query must match `this` query.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .exceptAll(db.selectFrom('pet').select(['id', 'name']))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* except all
* select "id", "name"
* from "pet"
* order by "name"
* ```
*
* You can provide a callback to get an expression builder.
* In the following example, this allows us to wrap the query in parentheses:
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name as name'])
* .exceptAll((eb) => eb.parens(
* eb.selectFrom('pet').select(['id', 'name'])
* ))
* .orderBy('name')
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "id", "first_name" as "name"
* from "person"
* except all
* (
* select "id", "name"
* from "pet"
* )
* order by "name"
* ```
*/
exceptAll<E extends SetOperandExpression<DB, O>>(expression: E): SelectQueryBuilder<DB, TB, O>;
/**
* Gives an alias for the query. This method is only useful for sub queries.
*
* ### Examples
*
* ```ts
* const pets = await db.selectFrom('pet')
* .selectAll('pet')
* .select(
* (qb) => qb.selectFrom('person')
* .select('first_name')
* .whereRef('pet.owner_id', '=', 'person.id')
* .as('owner_first_name')
* )
* .execute()
*
* pets[0].owner_first_name
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select "pet".*, (
* select "first_name"
* from "person"
* where "pet"."owner_id" = "person"."id"
* ) as "owner_first_name"
* from "pet"
* ```
*/
as<A extends string>(alias: A): AliasedSelectQueryBuilder<O, A>;
/**
* Clears all select clauses from the query.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .select(['id', 'first_name'])
* .clearSelect()
* .select(['id', 'gender'])
* .execute()
* ```
*
* The generated SQL(PostgreSQL):
*
* ```sql
* select "id", "gender" from "person"
* ```
*/
clearSelect(): SelectQueryBuilder<DB, TB, {}>;
/**
* Clears all where expressions from the query.
*
* ### Examples
*
* ```ts
* db.selectFrom('person')
* .selectAll()
* .where('id','=',42)
* .clearWhere()
* ```
*
* The generated SQL(PostgreSQL):
*
* ```sql
* select * from "person"
* ```
*/
clearWhere(): SelectQueryBuilder<DB, TB, O>;
/**
* Clears limit clause from the query.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .selectAll()
* .limit(10)
* .clearLimit()
* .execute()
* ```
*
* The generated SQL(PostgreSQL):
*
* ```sql
* select * from "person"
* ```
*/
clearLimit(): SelectQueryBuilder<DB, TB, O>;
/**
* Clears offset clause from the query.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .selectAll()
* .limit(10)
* .offset(20)
* .clearOffset()
* .execute()
* ```
*
* The generated SQL(PostgreSQL):
*
* ```sql
* select * from "person" limit 10
* ```
*/
clearOffset(): SelectQueryBuilder<DB, TB, O>;
/**
* Clears all `order by` clauses from the query.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .selectAll()
* .orderBy('id')
* .clearOrderBy()
* .execute()
* ```
*
* The generated SQL(PostgreSQL):
*
* ```sql
* select * from "person"
* ```
*/
clearOrderBy(): SelectQueryBuilder<DB, TB, O>;
/**
* Clears `group by` clause from the query.
*
* ### Examples
*
* ```ts
* await db.selectFrom('person')
* .selectAll()
* .groupBy('id')
* .clearGroupBy()
* .execute()
* ```
*
* The generated SQL(PostgreSQL):
*
* ```sql
* select * from "person"
* ```
*/
clearGroupBy(): SelectQueryBuilder<DB, TB, O>;
/**
* Simply calls the provided function passing `this` as the only argument. `$call` returns
* what the provided function returns.
*
* If you want to conditionally call a method on `this`, see
* the {@link $if} method.
*
* ### Examples
*
* The next example uses a helper function `log` to log a query:
*
* ```ts
* import type { Compilable } from 'kysely'
*
* function log<T extends Compilable>(qb: T): T {
* console.log(qb.compile())
* return qb
* }
*
* await db.selectFrom('person')
* .selectAll()
* .$call(log)
* .execute()
* ```
*/
$call<T>(func: (qb: this) => T): T;
/**
* Call `func(this)` if `condition` is true.
*
* NOTE: This method has an impact on TypeScript performance and it should only be used
* when necessary. Remember that you can call most methods like `where` conditionally
* like this:
*
* ```ts
* async function getPeople(firstName?: string, lastName?: string) {
* let query = db.selectFrom('person').selectAll()
*
* if (firstName) {
* query = query.where('first_name', '=', firstName)
* }
*
* if (lastName) {
* query = query.where('last_name', '=', lastName)
* }
*
* return await query.execute()
* }
* ```
*
* This method is mainly useful with optional selects. Any `select` or `selectAll`
* method called inside the callback add optional fields to the result type. This is
* because we can't know if those selections were actually made before running the code.
*
* Also see [this recipe](https://github.com/kysely-org/kysely/blob/master/site/docs/recipes/0005-conditional-selects.md)
*
* ### Examples
*
* ```ts
* async function getPerson(id: number, withLastName: boolean) {
* return await db
* .selectFrom('person')
* .select(['id', 'first_name'])
* .$if(withLastName, (qb) => qb.select('last_name'))
* .where('id', '=', id)
* .executeTakeFirstOrThrow()
* }
* ```
*
* Any selections added inside the `if` callback will be added as optional fields to the
* output type since we can't know if the selections were actually made before running
* the code. In the example above the return type of the `getPerson` function is:
*
* ```ts
* Promise<{
* id: number
* first_name: string
* last_name?: string
* }>
* ```
*
* You can also call any other methods inside the callback:
*
* ```ts
* async function getPeople(firstName?: string, petCountLimit?: number) {
* return await db.selectFrom('person')
* .select('person.id')
* .$if(firstName != null, (qb) => qb.where('first_name', '=', firstName!))
* .$if(petCountLimit != null, (qb) => qb
* .innerJoin('pet', 'pet.owner_id', 'person.id')
* .having((eb) => eb.fn.count('pet.id'), '>', petCountLimit!)
* .groupBy('person.id')
* )
* .execute()
* }
* ```
*/
$if<O2>(condition: boolean, func: (qb: this) => SelectQueryBuilder<any, any, O & O2>): SelectQueryBuilder<DB, TB, O & Partial<Omit<O2, keyof O>>>;
/**
* Change the output type of the query.
*
* This method call doesn't change the SQL in any way. This methods simply
* returns a copy of this `SelectQueryBuilder` with a new output type.
*/
$castTo<C>(): SelectQueryBuilder<DB, TB, C>;
/**
* Changes the output type from an object to a tuple.
*
* This doesn't affect the generated SQL in any way. This function is
* just a necessary evil when you need to convert a query's output
* record type to a tuple type. Typescript doesn't currently offer
* tools to do this automatically (without insane hackery).
*
* The returned object can no longer be executed. It can only be used
* as a subquery.
*
* ### Examples
*
* ```ts
* const result = await db
* .selectFrom('person')
* .selectAll('person')
* .where(({ eb, refTuple, selectFrom }) => eb(
* refTuple('first_name', 'last_name'),
* 'in',
* selectFrom('pet')
* .select(['name', 'species'])
* .where('pet.species', '!=', 'cat')
* .$asTuple('name', 'species')
* ))
* .execute()
* ```
*
* The generated SQL(PostgreSQL):
*
* ```sql
* select
* "person".*
* from
* "person"
* where
* ("first_name", "last_name")
* in
* (
* select "name", "species"
* from "pet"
* where "pet"."species" != $1
* )
* ```
*/
$asTuple<K1 extends keyof O, K2 extends Exclude<keyof O, K1>>(key1: K1, key2: K2): keyof O extends K1 | K2 ? ExpressionWrapper<DB, TB, [O[K1], O[K2]]> : KyselyTypeError<'$asTuple() call failed: All selected columns must be provided as arguments'>;
$asTuple<K1 extends keyof O, K2 extends Exclude<keyof O, K1>, K3 extends Exclude<keyof O, K1 | K2>>(key1: K1, key2: K2, key3: K3): keyof O extends K1 | K2 | K3 ? ExpressionWrapper<DB, TB, [O[K1], O[K2], O[K3]]> : KyselyTypeError<'$asTuple() call failed: All selected columns must be provided as arguments'>;
$asTuple<K1 extends keyof O, K2 extends Exclude<keyof O, K1>, K3 extends Exclude<keyof O, K1 | K2>, K4 extends Exclude<keyof O, K1 | K2 | K3>>(key1: K1, key2: K2, key3: K3, key4: K4): keyof O extends K1 | K2 | K3 | K4 ? ExpressionWrapper<DB, TB, [O[K1], O[K2], O[K3], O[K4]]> : KyselyTypeError<'$asTuple() call failed: All selected columns must be provided as arguments'>;
$asTuple<K1 extends keyof O, K2 extends Exclude<keyof O, K1>, K3 extends Exclude<keyof O, K1 | K2>, K4 extends Exclude<keyof O, K1 | K2 | K3>, K5 extends Exclude<keyof O, K1 | K2 | K3 | K4>>(key1: K1, key2: K2, key3: K3, key4: K4, key5: K5): keyof O extends K1 | K2 | K3 | K4 | K5 ? ExpressionWrapper<DB, TB, [O[K1], O[K2], O[K3], O[K4], O[K5]]> : KyselyTypeError<'$asTuple() call failed: All selected columns must be provided as arguments'>;
/**
* Plucks the value type of the output record.
*
* In SQL, any record type that only has one column can be used as a scalar.
* For example a query like this works:
*
* ```sql
* select
* id,
* first_name
* from
* person as p
* where
* -- This is ok since the query only selects one row
* -- and one column.
* (select name from pet where pet.owner_id = p.id limit 1) = 'Doggo'
* ```
*
* In many cases Kysely handles this automatically and picks the correct
* scalar type instead of the record type, but sometimes you need to give
* Kysely a hint.
*
* One such case are custom helper functions that take `Expression<T>`
* instances as inputs:
*
* ```ts
* import type { Expression } from 'kysely'
*
* function doStuff(expr: Expression<string>) {
* // ...
* }
*
* // Error! This is not ok because the expression type is
* // `{ first_name: string }` instead of `string`.
* // doStuff(db.selectFrom('person').select('first_name'))
*
* // Ok! This is ok since we've plucked the `string` type of the
* // only column in the output type.
* doStuff(db.selectFrom('person').select('first_name').$asScalar())
* ```
*
* This function has absolutely no effect on the generated SQL. It's
* purely a type-level helper.
*
* This method returns an `ExpressionWrapper` instead of a `SelectQueryBuilder`
* since the return value should only be used as a part of an expression
* and never executed as the main query.
*/
$asScalar<K extends keyof O = keyof O>(): ExpressionWrapper<DB, TB, O[K]>;
/**
* Narrows (parts of) the output type of the query.
*
* Kysely tries to be as type-safe as possible, but in some cases we have to make
* compromises for better maintainability and compilation performance. At present,
* Kysely doesn't narrow the output type of the query when using {@link where}, {@link having}
* or {@link JoinQueryBuilder.on}.
*
* This utility method is very useful for these situations, as it removes unncessary
* runtime assertion/guard code. Its input type is limited to the output type
* of the query, so you can't add a column that doesn't exist, or change a column's
* type to something that doesn't exist in its union type.
*
* ### Examples
*
* Turn this code:
*
* ```ts
* import type { Person } from 'type-editor' // imaginary module
*
* const person = await db.selectFrom('person')
* .where('nullable_column', 'is not', null)
* .selectAll()
* .executeTakeFirstOrThrow()
*
* if (isWithNoNullValue(person)) {
* functionThatExpectsPersonWithNonNullValue(person)
* }
*
* function isWithNoNullValue(person: Person): person is Person & { nullable_column: string } {
* return person.nullable_column != null
* }
* ```
*
* Into this:
*
* ```ts
* import type { NotNull } from 'kysely'
*
* const person = await db.selectFrom('person')
* .where('nullable_column', 'is not', null)
* .selectAll()
* .$narrowType<{ nullable_column: NotNull }>()
* .executeTakeFirstOrThrow()
*
* functionThatExpectsPersonWithNonNullValue(person)
* ```
*
* Giving the explicit narrowed type (`string` in the example above) works fine for
* simple types. If the type is complex, for example a JSON column or a subquery,
* you can use the special `NotNull` type to make the column not null.
*
* ```ts
* import { NotNull } from 'kysely'
*
* const person = await db.selectFrom('person')
* .where('nullable_column', 'is not', null)
* .selectAll()
* .$narrowType<{ nullable_column: NotNull }>()
* .executeTakeFirstOrThrow()
*
* functionThatExpectsPersonWithNonNullValue(person)
* ```
*/
$narrowType<T>(): SelectQueryBuilder<DB, TB, NarrowPartial<O, T>>;
/**
* Asserts that query's output row type equals the given type `T`.
*
* This method can be used to simplify excessively complex types to make TypeScript happy
* and much faster.
*
* Kysely uses complex type magic to achieve its type safety. This complexity is sometimes too much
* for TypeScript and you get errors like this:
*
* ```
* error TS2589: Type instantiation is excessively deep and possibly infinite.
* ```
*
* In these case you can often use this method to help TypeScript a little bit. When you use this
* method to assert the output type of a query, Kysely can drop the complex output type that
* consists of multiple nested helper types and replace it with the simple asserted type.
*
* Using this method doesn't reduce type safety at all. You have to pass in a type that is
* structurally equal to the current type.
*
* ### Examples
*
* ```ts
* const result = await db
* .with('first_and_last', (qb) => qb
* .selectFrom('person')
* .select(['first_name', 'last_name'])
* .$assertType<{ first_name: string, last_name: string | null }>()
* )
* .with('age', (qb) => qb
* .selectFrom('person')
* .select('age')
* .$assertType<{ age: number | null }>()
* )
* .selectFrom(['first_and_last', 'age'])
* .selectAll()
* .executeTakeFirstOrThrow()
* ```
*/
$assertType<T extends O>(): O extends T ? SelectQueryBuilder<DB, TB, T> : KyselyTypeError<`$assertType() call failed: The type passed in is not equal to the output type of the query.`>;
/**
* Returns a copy of this SelectQueryBuilder instance with the given plugin installed.
*/
withPlugin(plugin: KyselyPlugin): SelectQueryBuilder<DB, TB, O>;
/**
* Creates the OperationNode that describes how to compile this expression into SQL.
*
* ### Examples
*
* If you are creating a custom expression, it's often easiest to use the {@link sql}
* template tag to build the node:
*
* ```ts
* import { type Expression, type OperationNode, sql } from 'kysely'
*
* class SomeExpression<T> implements Expression<T> {
* get expressionType(): T | undefined {
* return undefined
* }
*
* toOperationNode(): OperationNode {
* return sql`some sql here`.toOperationNode()
* }
* }
* ```
*/
toOperationNode(): SelectQueryNode;
compile(): CompiledQuery<Simplify<O>>;
/**
* Executes the query and returns an array of rows.
*
* Also see the {@link executeTakeFirst} and {@link executeTakeFirstOrThrow} methods.
*/
execute(options?: AbortableQueryOptions): Promise<NonNullable<SimplifyResult<O>>[]>;
/**
* Executes the query and returns the first result or undefined if
* the query returned no result.
*/
executeTakeFirst(options?: AbortableQueryOptions): Promise<SimplifySingleResult<O>>;
/**
* Executes the query and returns the first result or throws if
* the query returned no result.
*
* By default an instance of {@link NoResultError} is thrown, but you can
* provide a custom error class, or callback to throw a different
* error.
*/
executeTakeFirstOrThrow(options?: ExecuteTakeFirstOrThrowOptions | ExecuteTakeFirstOrThrowOptions['errorConstructor']): Promise<SimplifyResult<O>>;
/**
* Executes the query and streams the rows.
*
* The optional argument `chunkSize` defines how many rows to fetch from the database
* at a time. It only affects some dialects like PostgreSQL that support it.
*
* ### Examples
*
* ```ts
* const stream = db
* .selectFrom('person')
* .select(['first_name', 'last_name'])
* .where('gender', '=', 'other')
* .stream()
*
* for await (const person of stream) {
* console.log(person.first_name)
*
* if (person.last_name === 'Something') {
* // Breaking or returning before the stream has ended will release
* // the database connection and invalidate the stream.
* break
* }
* }
* ```
*/
stream(chunkSizeOrOptions?: StreamOptions | StreamOptions['chunkSize']): AsyncIterableIterator<O>;
/**
* Executes query with `explain` statement before the main query.
*
* ```ts
* const explained = await db
* .selectFrom('person')
* .where('gender', '=', 'female')
* .selectAll()
* .explain('json')
* ```
*
* The generated SQL (MySQL):
*
* ```sql
* explain format=json select * from `person` where `gender` = ?
* ```
*
* You can also execute `explain analyze` statements.
*
* ```ts
* import { sql } from 'kysely'
*
* const explained = await db
* .selectFrom('person')
* .where('gender', '=', 'female')
* .selectAll()
* .explain('json', sql`analyze`)
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* explain (analyze, format json) select * from "person" where "gender" = $1
* ```
*/
explain<ER extends Record<string, any> = Record<string, any>>(format?: ExplainFormat, options?: Expression<any>): Promise<ER[]>;
}
export declare function createSelectQueryBuilder<DB, TB extends keyof DB, O>(props: SelectQueryBuilderProps): SelectQueryBuilder<DB, TB, O>;
export interface SelectQueryBuilderProps {
readonly queryId: QueryId;
readonly queryNode: SelectQueryNode;
readonly executor: QueryExecutor;
}
export interface AliasedSelectQueryBuilder<out O = undefined, out A extends string = never> extends AliasedExpression<O, A> {
get isAliasedSelectQueryBuilder(): true;
}
/**
* Guards a join's result type against being computed for an unknown table
* expression.
*
* `TableExpression<DB, TB> extends TE` only holds when `TE` is as wide as its
* own constraint, which never happens at a call site - there `TE` is a specific
* table name, alias or subquery. It does happen when the compiler asks what a
* join returns for an arbitrary table expression, which is what it has to do
* whenever it compares two `SelectQueryBuilder` types structurally.
*
* Without this guard that comparison never terminates on its own: computing the
* join result yields a `SelectQueryBuilder` over a wider `DB`, whose own join
* methods yield a wider one still, so the compiler only stops when it hits its
* internal recursion limit. That limit differs between TypeScript versions - 7.0
* searches a level deeper than 5.9 and 6.0 - which made comparing two select
* query builders over 6x more expensive there.
*
* Collapsing to a fixed type makes the recursion converge instead: joining an
* unknown table expression again produces the same type, so the compiler
* recognises the pair it is already comparing and stops immediately.
*/
type JoinResultForUnknownTable<O> = SelectQueryBuilder<any, any, O>;
export type SelectQueryBuilderWithInnerJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TableExpression<DB, TB> extends TE ? JoinResultForUnknownTable<O> : TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? InnerJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? SelectQueryBuilder<DB, TB | TE, O> : TE extends AliasedExpression<infer QO, infer QA> ? InnerJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? InnerJoinedBuilder<DB, TB, O, QA, QO> : never;
type InnerJoinedBuilder<DB, TB extends keyof DB, O, A extends string, R> = A extends keyof DB ? SelectQueryBuilder<InnerJoinedDB<DB, A, R>, TB | A, O> : SelectQueryBuilder<DB & ShallowRecord<A, R>, TB | A, O>;
type InnerJoinedDB<DB, A extends string, R> = DrainOuterGeneric<{
[C in keyof DB | A]: C extends A ? R : C extends keyof DB ? DB[C] : never;
}>;
export type SelectQueryBuilderWithLeftJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TableExpression<DB, TB> extends TE ? JoinResultForUnknownTable<O> : TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? LeftJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? LeftJoinedBuilder<DB, TB, O, TE, DB[TE]> : TE extends AliasedExpression<infer QO, infer QA> ? LeftJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? LeftJoinedBuilder<DB, TB, O, QA, QO> : never;
type LeftJoinedBuilder<DB, TB extends keyof DB, O, A extends keyof any, R> = A extends keyof DB ? SelectQueryBuilder<LeftJoinedDB<DB, A, R>, TB | A, O> : SelectQueryBuilder<DB & ShallowRecord<A, Nullable<R>>, TB | A, O>;
type LeftJoinedDB<DB, A extends keyof any, R> = DrainOuterGeneric<{
[C in keyof DB | A]: C extends A ? Nullable<R> : C extends keyof DB ? DB[C] : never;
}>;
export type SelectQueryBuilderWithRightJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TableExpression<DB, TB> extends TE ? JoinResultForUnknownTable<O> : TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? RightJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? RightJoinedBuilder<DB, TB, O, TE, DB[TE]> : TE extends AliasedExpression<infer QO, infer QA> ? RightJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? RightJoinedBuilder<DB, TB, O, QA, QO> : never;
type RightJoinedBuilder<DB, TB extends keyof DB, O, A extends keyof any, R> = SelectQueryBuilder<RightJoinedDB<DB, TB, A, R>, TB | A, O>;
type RightJoinedDB<DB, TB extends keyof DB, A extends keyof any, R> = DrainOuterGeneric<{
[C in keyof DB | A]: C extends A ? R : C extends TB ? Nullable<DB[C]> : C extends keyof DB ? DB[C] : never;
}>;
export type SelectQueryBuilderWithFullJoin<DB, TB extends keyof DB, O, TE extends TableExpression<DB, TB>> = TableExpression<DB, TB> extends TE ? JoinResultForUnknownTable<O> : TE extends `${infer T} as ${infer A}` ? T extends keyof DB ? OuterJoinedBuilder<DB, TB, O, A, DB[T]> : never : TE extends keyof DB ? OuterJoinedBuilder<DB, TB, O, TE, DB[TE]> : TE extends AliasedExpression<infer QO, infer QA> ? OuterJoinedBuilder<DB, TB, O, QA, QO> : TE extends (qb: any) => AliasedExpression<infer QO, infer QA> ? OuterJoinedBuilder<DB, TB, O, QA, QO> : never;
type OuterJoinedBuilder<DB, TB extends keyof DB, O, A extends keyof any, R> = SelectQueryBuilder<OuterJoinedBuilderDB<DB, TB, A, R>, TB | A, O>;
type OuterJoinedBuilderDB<DB, TB extends keyof DB, A extends keyof any, R> = DrainOuterGeneric<{
[C in keyof DB | A]: C extends A ? Nullable<R> : C extends TB ? Nullable<DB[C]> : C extends keyof DB ? DB[C] : never;
}>;
type TableOrList<TB extends keyof any> = (TB & string) | ReadonlyArray<TB & string>;
export {};