import { AliasNode } from '../operation-node/alias-node.js'; import { AndNode } from '../operation-node/and-node.js'; import { OperationNode } from '../operation-node/operation-node.js'; import { OrNode } from '../operation-node/or-node.js'; import { ParensNode } from '../operation-node/parens-node.js'; import { ComparisonOperatorExpression, OperandValueExpressionOrList } from '../parser/binary-operation-parser.js'; import { OperandExpression } from '../parser/expression-parser.js'; import { ReferenceExpression } from '../parser/reference-parser.js'; import { KyselyTypeError } from '../util/type-error.js'; import { SqlBool } from '../util/type-utils.js'; import { AliasableExpression, AliasedExpression, Expression } from './expression.js'; export declare class ExpressionWrapper implements AliasableExpression { #private; constructor(node: OperationNode); /** @private */ /** * All expressions need to have this getter for complicated type-related reasons. * Simply add this getter for your expression and always return `undefined` from it: * * ```ts * class SomeExpression implements Expression { * get expressionType(): T | undefined { * return undefined * } * } * ``` * * The getter is needed to make the expression assignable to another expression only * if the types `T` are assignable. Without this property (or some other property * that references `T`), you could assing `Expression` to `Expression`. */ get expressionType(): T | undefined; /** * Returns an aliased version of the expression. * * In addition to slapping `as "the_alias"` to the end of the SQL, * this method also provides strict typing: * * ```ts * const result = await db * .selectFrom('person') * .select((eb) => * eb('first_name', '=', 'Jennifer').as('is_jennifer') * ) * .executeTakeFirstOrThrow() * * // `is_jennifer: SqlBool` field exists in the result type. * console.log(result.is_jennifer) * ``` * * The generated SQL (PostgreSQL): * * ```ts * select "first_name" = $1 as "is_jennifer" * from "person" * ``` */ as(alias: A): AliasedExpression; /** * Returns an aliased version of the expression. * * In addition to slapping `as "the_alias"` at the end of the expression, * this method also provides strict typing: * * ```ts * const result = await db * .selectFrom('person') * .select((eb) => * // `eb.fn` returns an AliasableExpression * eb.fn('concat', ['first_name' eb.val(' '), 'last_name']).as('full_name') * ) * .executeTakeFirstOrThrow() * * // `full_name: string` field exists in the result type. * console.log(result.full_name) * ``` * * The generated SQL (PostgreSQL): * * ```ts * select * concat("first_name", $1, "last_name") as "full_name" * from * "person" * ``` * * You can also pass in a raw SQL snippet (or any expression) but in that case you must * provide the alias as the only type argument: * * ```ts * const values = sql<{ a: number, b: string }>`(values (1, 'foo'))` * * // The alias is `t(a, b)` which specifies the column names * // in addition to the table name. We must tell kysely that * // columns of the table can be referenced through `t` * // by providing an explicit type argument. * const aliasedValues = values.as<'t'>(sql`t(a, b)`) * * await db * .insertInto('person') * .columns(['first_name', 'last_name']) * .expression( * db.selectFrom(aliasedValues).select(['t.a', 't.b']) * ) * ``` * * The generated SQL (PostgreSQL): * * ```ts * insert into "person" ("first_name", "last_name") * from (values (1, 'foo')) as t(a, b) * select "t"."a", "t"."b" * ``` */ as(alias: Expression): AliasedExpression; /** * Combines `this` and another expression using `OR`. * * Also see {@link ExpressionBuilder.or} * * ### Examples * * ```ts * db.selectFrom('person') * .selectAll() * .where(eb => eb('first_name', '=', 'Jennifer') * .or('first_name', '=', 'Arnold') * .or('first_name', '=', 'Sylvester') * ) * ``` * * The generated SQL (PostgreSQL): * * ```ts * select * * from "person" * where ( * "first_name" = $1 * or "first_name" = $2 * or "first_name" = $3 * ) * ``` * * You can also pass any expression as the only argument to * this method: * * ```ts * db.selectFrom('person') * .selectAll() * .where(eb => eb('first_name', '=', 'Jennifer') * .or(eb('first_name', '=', 'Sylvester').and('last_name', '=', 'Stallone')) * .or(eb.exists( * eb.selectFrom('pet') * .select('id') * .whereRef('pet.owner_id', '=', 'person.id') * ) * ) * ``` * * The generated SQL (PostgreSQL): * * ```ts * select * * from "person" * where ( * "first_name" = $1 * or ("first_name" = $2 and "last_name" = $3) * or exists ( * select "id" * from "pet" * where "pet"."owner_id" = "person"."id" * ) * ) * ``` */ or, VE extends OperandValueExpressionOrList>(lhs: RE, op: ComparisonOperatorExpression, rhs: VE): T extends SqlBool ? OrWrapper : KyselyTypeError<'or() method can only be called on boolean expressions'>; or>(expression: E): T extends SqlBool ? OrWrapper : KyselyTypeError<'or() method can only be called on boolean expressions'>; /** * Combines `this` and another expression using `AND`. * * Also see {@link ExpressionBuilder.and} * * ### Examples * * ```ts * db.selectFrom('person') * .selectAll() * .where(eb => eb('first_name', '=', 'Jennifer') * .and('last_name', '=', 'Aniston') * .and('age', '>', 40) * ) * ``` * * The generated SQL (PostgreSQL): * * ```ts * select * * from "person" * where ( * "first_name" = $1 * and "last_name" = $2 * and "age" > $3 * ) * ``` * * You can also pass any expression as the only argument to * this method: * * ```ts * db.selectFrom('person') * .selectAll() * .where(eb => eb('first_name', '=', 'Jennifer') * .and(eb('first_name', '=', 'Sylvester').or('last_name', '=', 'Stallone')) * .and(eb.exists( * eb.selectFrom('pet') * .select('id') * .whereRef('pet.owner_id', '=', 'person.id') * ) * ) * ``` * * The generated SQL (PostgreSQL): * * ```ts * select * * from "person" * where ( * "first_name" = $1 * and ("first_name" = $2 or "last_name" = $3) * and exists ( * select "id" * from "pet" * where "pet"."owner_id" = "person"."id" * ) * ) * ``` */ and, VE extends OperandValueExpressionOrList>(lhs: RE, op: ComparisonOperatorExpression, rhs: VE): T extends SqlBool ? AndWrapper : KyselyTypeError<'and() method can only be called on boolean expressions'>; and>(expression: E): T extends SqlBool ? AndWrapper : KyselyTypeError<'and() method can only be called on boolean expressions'>; /** * Change the output type of the expression. * * This method call doesn't change the SQL in any way. This methods simply * returns a copy of this `ExpressionWrapper` with a new output type. */ $castTo(): ExpressionWrapper; /** * Omit null from the expression's type. * * This function can be useful in cases where you know an expression can't be * null, but Kysely is unable to infer it. * * This method call doesn't change the SQL in any way. This methods simply * returns a copy of `this` with a new output type. */ $notNull(): ExpressionWrapper>; /** * Creates the OperationNode that describes how to compile this expression into SQL. * * If you are creating a custom expression, it's often easiest to use the {@link sql} * template tag to build the node: * * ```ts * class SomeExpression implements Expression { * toOperationNode(): OperationNode { * return sql`some sql here`.toOperationNode() * } * } * ``` */ toOperationNode(): OperationNode; } export declare class AliasedExpressionWrapper implements AliasedExpression { #private; constructor(expr: Expression, alias: A | Expression); /** @private */ /** * Returns the aliased expression. */ get expression(): Expression; /** @private */ /** * Returns the alias. */ get alias(): A | Expression; /** * Creates the OperationNode that describes how to compile this expression into SQL. */ toOperationNode(): AliasNode; } export declare class OrWrapper implements AliasableExpression { #private; constructor(node: OrNode); /** @private */ /** * All expressions need to have this getter for complicated type-related reasons. * Simply add this getter for your expression and always return `undefined` from it: * * ```ts * class SomeExpression implements Expression { * get expressionType(): T | undefined { * return undefined * } * } * ``` * * The getter is needed to make the expression assignable to another expression only * if the types `T` are assignable. Without this property (or some other property * that references `T`), you could assing `Expression` to `Expression`. */ get expressionType(): T | undefined; /** * Returns an aliased version of the expression. * * In addition to slapping `as "the_alias"` to the end of the SQL, * this method also provides strict typing: * * ```ts * const result = await db * .selectFrom('person') * .select(eb => * eb('first_name', '=', 'Jennifer') * .or('first_name', '=', 'Sylvester') * .as('is_jennifer_or_sylvester') * ) * .executeTakeFirstOrThrow() * * // `is_jennifer_or_sylvester: SqlBool` field exists in the result type. * console.log(result.is_jennifer_or_sylvester) * ``` * * The generated SQL (PostgreSQL): * * ```ts * select "first_name" = $1 or "first_name" = $2 as "is_jennifer_or_sylvester" * from "person" * ``` */ as(alias: A): AliasedExpression; /** * Returns an aliased version of the expression. * * In addition to slapping `as "the_alias"` at the end of the expression, * this method also provides strict typing: * * ```ts * const result = await db * .selectFrom('person') * .select((eb) => * // `eb.fn` returns an AliasableExpression * eb.fn('concat', ['first_name' eb.val(' '), 'last_name']).as('full_name') * ) * .executeTakeFirstOrThrow() * * // `full_name: string` field exists in the result type. * console.log(result.full_name) * ``` * * The generated SQL (PostgreSQL): * * ```ts * select * concat("first_name", $1, "last_name") as "full_name" * from * "person" * ``` * * You can also pass in a raw SQL snippet (or any expression) but in that case you must * provide the alias as the only type argument: * * ```ts * const values = sql<{ a: number, b: string }>`(values (1, 'foo'))` * * // The alias is `t(a, b)` which specifies the column names * // in addition to the table name. We must tell kysely that * // columns of the table can be referenced through `t` * // by providing an explicit type argument. * const aliasedValues = values.as<'t'>(sql`t(a, b)`) * * await db * .insertInto('person') * .columns(['first_name', 'last_name']) * .expression( * db.selectFrom(aliasedValues).select(['t.a', 't.b']) * ) * ``` * * The generated SQL (PostgreSQL): * * ```ts * insert into "person" ("first_name", "last_name") * from (values (1, 'foo')) as t(a, b) * select "t"."a", "t"."b" * ``` */ as(alias: Expression): AliasedExpression; /** * Combines `this` and another expression using `OR`. * * See {@link ExpressionWrapper.or} for examples. */ or, VE extends OperandValueExpressionOrList>(lhs: RE, op: ComparisonOperatorExpression, rhs: VE): OrWrapper; or>(expression: E): OrWrapper; /** * Change the output type of the expression. * * This method call doesn't change the SQL in any way. This methods simply * returns a copy of this `OrWrapper` with a new output type. */ $castTo(): OrWrapper; /** * Creates the OperationNode that describes how to compile this expression into SQL. * * If you are creating a custom expression, it's often easiest to use the {@link sql} * template tag to build the node: * * ```ts * class SomeExpression implements Expression { * toOperationNode(): OperationNode { * return sql`some sql here`.toOperationNode() * } * } * ``` */ toOperationNode(): ParensNode; } export declare class AndWrapper implements AliasableExpression { #private; constructor(node: AndNode); /** @private */ /** * All expressions need to have this getter for complicated type-related reasons. * Simply add this getter for your expression and always return `undefined` from it: * * ```ts * class SomeExpression implements Expression { * get expressionType(): T | undefined { * return undefined * } * } * ``` * * The getter is needed to make the expression assignable to another expression only * if the types `T` are assignable. Without this property (or some other property * that references `T`), you could assing `Expression` to `Expression`. */ get expressionType(): T | undefined; /** * Returns an aliased version of the expression. * * In addition to slapping `as "the_alias"` to the end of the SQL, * this method also provides strict typing: * * ```ts * const result = await db * .selectFrom('person') * .select(eb => * eb('first_name', '=', 'Jennifer') * .and('last_name', '=', 'Aniston') * .as('is_jennifer_aniston') * ) * .executeTakeFirstOrThrow() * * // `is_jennifer_aniston: SqlBool` field exists in the result type. * console.log(result.is_jennifer_or_sylvester) * ``` * * The generated SQL (PostgreSQL): * * ```ts * select "first_name" = $1 and "first_name" = $2 as "is_jennifer_aniston" * from "person" * ``` */ as(alias: A): AliasedExpression; /** * Returns an aliased version of the expression. * * In addition to slapping `as "the_alias"` at the end of the expression, * this method also provides strict typing: * * ```ts * const result = await db * .selectFrom('person') * .select((eb) => * // `eb.fn` returns an AliasableExpression * eb.fn('concat', ['first_name' eb.val(' '), 'last_name']).as('full_name') * ) * .executeTakeFirstOrThrow() * * // `full_name: string` field exists in the result type. * console.log(result.full_name) * ``` * * The generated SQL (PostgreSQL): * * ```ts * select * concat("first_name", $1, "last_name") as "full_name" * from * "person" * ``` * * You can also pass in a raw SQL snippet (or any expression) but in that case you must * provide the alias as the only type argument: * * ```ts * const values = sql<{ a: number, b: string }>`(values (1, 'foo'))` * * // The alias is `t(a, b)` which specifies the column names * // in addition to the table name. We must tell kysely that * // columns of the table can be referenced through `t` * // by providing an explicit type argument. * const aliasedValues = values.as<'t'>(sql`t(a, b)`) * * await db * .insertInto('person') * .columns(['first_name', 'last_name']) * .expression( * db.selectFrom(aliasedValues).select(['t.a', 't.b']) * ) * ``` * * The generated SQL (PostgreSQL): * * ```ts * insert into "person" ("first_name", "last_name") * from (values (1, 'foo')) as t(a, b) * select "t"."a", "t"."b" * ``` */ as(alias: Expression): AliasedExpression; /** * Combines `this` and another expression using `AND`. * * See {@link ExpressionWrapper.and} for examples. */ and, VE extends OperandValueExpressionOrList>(lhs: RE, op: ComparisonOperatorExpression, rhs: VE): AndWrapper; and>(expression: E): AndWrapper; /** * Change the output type of the expression. * * This method call doesn't change the SQL in any way. This methods simply * returns a copy of this `AndWrapper` with a new output type. */ $castTo(): AndWrapper; /** * Creates the OperationNode that describes how to compile this expression into SQL. * * If you are creating a custom expression, it's often easiest to use the {@link sql} * template tag to build the node: * * ```ts * class SomeExpression implements Expression { * toOperationNode(): OperationNode { * return sql`some sql here`.toOperationNode() * } * } * ``` */ toOperationNode(): ParensNode; }