import { entityKind } from "../../entity.cjs"; import { TypedQueryBuilder } from "../../query-builders/query-builder.cjs"; import type { BuildSubquerySelection, GetSelectTableName, GetSelectTableSelection, JoinNullability, SelectMode, SelectResult } from "../../query-builders/select.types.cjs"; import { QueryPromise } from "../../query-promise.cjs"; import type { SingleStoreColumn } from "../columns/index.cjs"; import type { SingleStoreDialect } from "../dialect.cjs"; import type { PreparedQueryHKTBase, SingleStoreSession } from "../session.cjs"; import type { SubqueryWithSelection } from "../subquery.cjs"; import type { SingleStoreTable } from "../table.cjs"; import type { ColumnsSelection, Query } from "../../sql/sql.cjs"; import { SQL } from "../../sql/sql.cjs"; import { Subquery } from "../../subquery.cjs"; import { type ValueOrArray } from "../../utils.cjs"; import type { CreateSingleStoreSelectFromBuilderMode, GetSingleStoreSetOperators, LockConfig, LockStrength, SelectedFields, SetOperatorRightSelect, SingleStoreCreateSetOperatorFn, SingleStoreJoinFn, SingleStoreSelectConfig, SingleStoreSelectDynamic, SingleStoreSelectHKT, SingleStoreSelectHKTBase, SingleStoreSelectPrepare, SingleStoreSelectWithout, SingleStoreSetOperatorExcludedMethods, SingleStoreSetOperatorWithResult } from "./select.types.cjs"; export declare class SingleStoreSelectBuilder { static readonly [entityKind]: string; private fields; private session; private dialect; private withList; private distinct; constructor(config: { fields: TSelection; session: SingleStoreSession | undefined; dialect: SingleStoreDialect; withList?: Subquery[]; distinct?: boolean; }); from(// | SingleStoreViewBase source: TFrom): CreateSingleStoreSelectFromBuilderMode, TSelection extends undefined ? GetSelectTableSelection : TSelection, TSelection extends undefined ? 'single' : 'partial', TPreparedQueryHKT>; } export declare abstract class SingleStoreSelectQueryBuilderBase = TTableName extends string ? Record : {}, TDynamic extends boolean = false, TExcludedMethods extends string = never, TResult extends any[] = SelectResult[], TSelectedFields extends ColumnsSelection = BuildSubquerySelection> extends TypedQueryBuilder { static readonly [entityKind]: string; readonly _: { readonly hkt: THKT; readonly tableName: TTableName; readonly selection: TSelection; readonly selectMode: TSelectMode; readonly preparedQueryHKT: TPreparedQueryHKT; readonly nullabilityMap: TNullabilityMap; readonly dynamic: TDynamic; readonly excludedMethods: TExcludedMethods; readonly result: TResult; readonly selectedFields: TSelectedFields; }; protected config: SingleStoreSelectConfig; protected joinsNotNullableMap: Record; private tableName; private isPartialSelect; protected dialect: SingleStoreDialect; constructor({ table, fields, isPartialSelect, session, dialect, withList, distinct }: { table: SingleStoreSelectConfig['table']; fields: SingleStoreSelectConfig['fields']; isPartialSelect: boolean; session: SingleStoreSession | undefined; dialect: SingleStoreDialect; withList: Subquery[]; distinct: boolean | undefined; }); private createJoin; /** * Executes a `left join` operation by adding another table to the current query. * * Calling this method associates each row of the table with the corresponding row from the joined table, if a match is found. If no matching row exists, it sets all columns of the joined table to null. * * See docs: {@link https://orm.drizzle.team/docs/joins#left-join} * * @param table the table to join. * @param on the `on` clause. * * @example * * ```ts * // Select all users and their pets * const usersWithPets: { user: User; pets: Pet | null }[] = await db.select() * .from(users) * .leftJoin(pets, eq(users.id, pets.ownerId)) * * // Select userId and petId * const usersIdsAndPetIds: { userId: number; petId: number | null }[] = await db.select({ * userId: users.id, * petId: pets.id, * }) * .from(users) * .leftJoin(pets, eq(users.id, pets.ownerId)) * ``` */ leftJoin: SingleStoreJoinFn; /** * Executes a `right join` operation by adding another table to the current query. * * Calling this method associates each row of the joined table with the corresponding row from the main table, if a match is found. If no matching row exists, it sets all columns of the main table to null. * * See docs: {@link https://orm.drizzle.team/docs/joins#right-join} * * @param table the table to join. * @param on the `on` clause. * * @example * * ```ts * // Select all users and their pets * const usersWithPets: { user: User | null; pets: Pet }[] = await db.select() * .from(users) * .rightJoin(pets, eq(users.id, pets.ownerId)) * * // Select userId and petId * const usersIdsAndPetIds: { userId: number | null; petId: number }[] = await db.select({ * userId: users.id, * petId: pets.id, * }) * .from(users) * .rightJoin(pets, eq(users.id, pets.ownerId)) * ``` */ rightJoin: SingleStoreJoinFn; /** * Executes an `inner join` operation, creating a new table by combining rows from two tables that have matching values. * * Calling this method retrieves rows that have corresponding entries in both joined tables. Rows without matching entries in either table are excluded, resulting in a table that includes only matching pairs. * * See docs: {@link https://orm.drizzle.team/docs/joins#inner-join} * * @param table the table to join. * @param on the `on` clause. * * @example * * ```ts * // Select all users and their pets * const usersWithPets: { user: User; pets: Pet }[] = await db.select() * .from(users) * .innerJoin(pets, eq(users.id, pets.ownerId)) * * // Select userId and petId * const usersIdsAndPetIds: { userId: number; petId: number }[] = await db.select({ * userId: users.id, * petId: pets.id, * }) * .from(users) * .innerJoin(pets, eq(users.id, pets.ownerId)) * ``` */ innerJoin: SingleStoreJoinFn; /** * Executes a `full join` operation by combining rows from two tables into a new table. * * Calling this method retrieves all rows from both main and joined tables, merging rows with matching values and filling in `null` for non-matching columns. * * See docs: {@link https://orm.drizzle.team/docs/joins#full-join} * * @param table the table to join. * @param on the `on` clause. * * @example * * ```ts * // Select all users and their pets * const usersWithPets: { user: User | null; pets: Pet | null }[] = await db.select() * .from(users) * .fullJoin(pets, eq(users.id, pets.ownerId)) * * // Select userId and petId * const usersIdsAndPetIds: { userId: number | null; petId: number | null }[] = await db.select({ * userId: users.id, * petId: pets.id, * }) * .from(users) * .fullJoin(pets, eq(users.id, pets.ownerId)) * ``` */ fullJoin: SingleStoreJoinFn; private createSetOperator; /** * Adds `union` set operator to the query. * * Calling this method will combine the result sets of the `select` statements and remove any duplicate rows that appear across them. * * See docs: {@link https://orm.drizzle.team/docs/set-operations#union} * * @example * * ```ts * // Select all unique names from customers and users tables * await db.select({ name: users.name }) * .from(users) * .union( * db.select({ name: customers.name }).from(customers) * ); * // or * import { union } from 'drizzle-orm/singlestore-core' * * await union( * db.select({ name: users.name }).from(users), * db.select({ name: customers.name }).from(customers) * ); * ``` */ union: >(rightSelection: ((setOperators: GetSingleStoreSetOperators) => SetOperatorRightSelect) | SetOperatorRightSelect) => SingleStoreSelectWithout; /** * Adds `union all` set operator to the query. * * Calling this method will combine the result-set of the `select` statements and keep all duplicate rows that appear across them. * * See docs: {@link https://orm.drizzle.team/docs/set-operations#union-all} * * @example * * ```ts * // Select all transaction ids from both online and in-store sales * await db.select({ transaction: onlineSales.transactionId }) * .from(onlineSales) * .unionAll( * db.select({ transaction: inStoreSales.transactionId }).from(inStoreSales) * ); * // or * import { unionAll } from 'drizzle-orm/singlestore-core' * * await unionAll( * db.select({ transaction: onlineSales.transactionId }).from(onlineSales), * db.select({ transaction: inStoreSales.transactionId }).from(inStoreSales) * ); * ``` */ unionAll: >(rightSelection: ((setOperators: GetSingleStoreSetOperators) => SetOperatorRightSelect) | SetOperatorRightSelect) => SingleStoreSelectWithout; /** * Adds `intersect` set operator to the query. * * Calling this method will retain only the rows that are present in both result sets and eliminate duplicates. * * See docs: {@link https://orm.drizzle.team/docs/set-operations#intersect} * * @example * * ```ts * // Select course names that are offered in both departments A and B * await db.select({ courseName: depA.courseName }) * .from(depA) * .intersect( * db.select({ courseName: depB.courseName }).from(depB) * ); * // or * import { intersect } from 'drizzle-orm/singlestore-core' * * await intersect( * db.select({ courseName: depA.courseName }).from(depA), * db.select({ courseName: depB.courseName }).from(depB) * ); * ``` */ intersect: >(rightSelection: ((setOperators: GetSingleStoreSetOperators) => SetOperatorRightSelect) | SetOperatorRightSelect) => SingleStoreSelectWithout; /** * Adds `except` set operator to the query. * * Calling this method will retrieve all unique rows from the left query, except for the rows that are present in the result set of the right query. * * See docs: {@link https://orm.drizzle.team/docs/set-operations#except} * * @example * * ```ts * // Select all courses offered in department A but not in department B * await db.select({ courseName: depA.courseName }) * .from(depA) * .except( * db.select({ courseName: depB.courseName }).from(depB) * ); * // or * import { except } from 'drizzle-orm/singlestore-core' * * await except( * db.select({ courseName: depA.courseName }).from(depA), * db.select({ courseName: depB.courseName }).from(depB) * ); * ``` */ except: >(rightSelection: ((setOperators: GetSingleStoreSetOperators) => SetOperatorRightSelect) | SetOperatorRightSelect) => SingleStoreSelectWithout; /** * Adds `minus` set operator to the query. * * This is an alias of `except` supported by SingleStore. * * @example * * ```ts * // Select all courses offered in department A but not in department B * await db.select({ courseName: depA.courseName }) * .from(depA) * .minus( * db.select({ courseName: depB.courseName }).from(depB) * ); * // or * import { minus } from 'drizzle-orm/singlestore-core' * * await minus( * db.select({ courseName: depA.courseName }).from(depA), * db.select({ courseName: depB.courseName }).from(depB) * ); * ``` */ minus: >(rightSelection: ((setOperators: GetSingleStoreSetOperators) => SetOperatorRightSelect) | SetOperatorRightSelect) => SingleStoreSelectWithout; /** * Adds a `where` clause to the query. * * Calling this method will select only those rows that fulfill a specified condition. * * See docs: {@link https://orm.drizzle.team/docs/select#filtering} * * @param where the `where` clause. * * @example * You can use conditional operators and `sql function` to filter the rows to be selected. * * ```ts * // Select all cars with green color * await db.select().from(cars).where(eq(cars.color, 'green')); * // or * await db.select().from(cars).where(sql`${cars.color} = 'green'`) * ``` * * You can logically combine conditional operators with `and()` and `or()` operators: * * ```ts * // Select all BMW cars with a green color * await db.select().from(cars).where(and(eq(cars.color, 'green'), eq(cars.brand, 'BMW'))); * * // Select all cars with the green or blue color * await db.select().from(cars).where(or(eq(cars.color, 'green'), eq(cars.color, 'blue'))); * ``` */ where(where: ((aliases: this['_']['selection']) => SQL | undefined) | SQL | undefined): SingleStoreSelectWithout; /** * Adds a `having` clause to the query. * * Calling this method will select only those rows that fulfill a specified condition. It is typically used with aggregate functions to filter the aggregated data based on a specified condition. * * See docs: {@link https://orm.drizzle.team/docs/select#aggregations} * * @param having the `having` clause. * * @example * * ```ts * // Select all brands with more than one car * await db.select({ * brand: cars.brand, * count: sql`cast(count(${cars.id}) as int)`, * }) * .from(cars) * .groupBy(cars.brand) * .having(({ count }) => gt(count, 1)); * ``` */ having(having: ((aliases: this['_']['selection']) => SQL | undefined) | SQL | undefined): SingleStoreSelectWithout; /** * Adds a `group by` clause to the query. * * Calling this method will group rows that have the same values into summary rows, often used for aggregation purposes. * * See docs: {@link https://orm.drizzle.team/docs/select#aggregations} * * @example * * ```ts * // Group and count people by their last names * await db.select({ * lastName: people.lastName, * count: sql`cast(count(*) as int)` * }) * .from(people) * .groupBy(people.lastName); * ``` */ groupBy(builder: (aliases: this['_']['selection']) => ValueOrArray): SingleStoreSelectWithout; groupBy(...columns: (SingleStoreColumn | SQL | SQL.Aliased)[]): SingleStoreSelectWithout; /** * Adds an `order by` clause to the query. * * Calling this method will sort the result-set in ascending or descending order. By default, the sort order is ascending. * * See docs: {@link https://orm.drizzle.team/docs/select#order-by} * * @example * * ``` * // Select cars ordered by year * await db.select().from(cars).orderBy(cars.year); * ``` * * You can specify whether results are in ascending or descending order with the `asc()` and `desc()` operators. * * ```ts * // Select cars ordered by year in descending order * await db.select().from(cars).orderBy(desc(cars.year)); * * // Select cars ordered by year and price * await db.select().from(cars).orderBy(asc(cars.year), desc(cars.price)); * ``` */ orderBy(builder: (aliases: this['_']['selection']) => ValueOrArray): SingleStoreSelectWithout; orderBy(...columns: (SingleStoreColumn | SQL | SQL.Aliased)[]): SingleStoreSelectWithout; /** * Adds a `limit` clause to the query. * * Calling this method will set the maximum number of rows that will be returned by this query. * * See docs: {@link https://orm.drizzle.team/docs/select#limit--offset} * * @param limit the `limit` clause. * * @example * * ```ts * // Get the first 10 people from this query. * await db.select().from(people).limit(10); * ``` */ limit(limit: number): SingleStoreSelectWithout; /** * Adds an `offset` clause to the query. * * Calling this method will skip a number of rows when returning results from this query. * * See docs: {@link https://orm.drizzle.team/docs/select#limit--offset} * * @param offset the `offset` clause. * * @example * * ```ts * // Get the 10th-20th people from this query. * await db.select().from(people).offset(10).limit(10); * ``` */ offset(offset: number): SingleStoreSelectWithout; /** * Adds a `for` clause to the query. * * Calling this method will specify a lock strength for this query that controls how strictly it acquires exclusive access to the rows being queried. * * @param strength the lock strength. * @param config the lock configuration. */ for(strength: LockStrength, config?: LockConfig): SingleStoreSelectWithout; toSQL(): Query; as(alias: TAlias): SubqueryWithSelection; $dynamic(): SingleStoreSelectDynamic; } export interface SingleStoreSelectBase = TTableName extends string ? Record : {}, TDynamic extends boolean = false, TExcludedMethods extends string = never, TResult extends any[] = SelectResult[], TSelectedFields extends ColumnsSelection = BuildSubquerySelection> extends SingleStoreSelectQueryBuilderBase, QueryPromise { } export declare class SingleStoreSelectBase = TTableName extends string ? Record : {}, TDynamic extends boolean = false, TExcludedMethods extends string = never, TResult = SelectResult[], TSelectedFields = BuildSubquerySelection> extends SingleStoreSelectQueryBuilderBase { static readonly [entityKind]: string; prepare(): SingleStoreSelectPrepare; execute: ReturnType["execute"]; private createIterator; iterator: ReturnType["iterator"]; } /** * Adds `union` set operator to the query. * * Calling this method will combine the result sets of the `select` statements and remove any duplicate rows that appear across them. * * See docs: {@link https://orm.drizzle.team/docs/set-operations#union} * * @example * * ```ts * // Select all unique names from customers and users tables * import { union } from 'drizzle-orm/singlestore-core' * * await union( * db.select({ name: users.name }).from(users), * db.select({ name: customers.name }).from(customers) * ); * // or * await db.select({ name: users.name }) * .from(users) * .union( * db.select({ name: customers.name }).from(customers) * ); * ``` */ export declare const union: SingleStoreCreateSetOperatorFn; /** * Adds `union all` set operator to the query. * * Calling this method will combine the result-set of the `select` statements and keep all duplicate rows that appear across them. * * See docs: {@link https://orm.drizzle.team/docs/set-operations#union-all} * * @example * * ```ts * // Select all transaction ids from both online and in-store sales * import { unionAll } from 'drizzle-orm/singlestore-core' * * await unionAll( * db.select({ transaction: onlineSales.transactionId }).from(onlineSales), * db.select({ transaction: inStoreSales.transactionId }).from(inStoreSales) * ); * // or * await db.select({ transaction: onlineSales.transactionId }) * .from(onlineSales) * .unionAll( * db.select({ transaction: inStoreSales.transactionId }).from(inStoreSales) * ); * ``` */ export declare const unionAll: SingleStoreCreateSetOperatorFn; /** * Adds `intersect` set operator to the query. * * Calling this method will retain only the rows that are present in both result sets and eliminate duplicates. * * See docs: {@link https://orm.drizzle.team/docs/set-operations#intersect} * * @example * * ```ts * // Select course names that are offered in both departments A and B * import { intersect } from 'drizzle-orm/singlestore-core' * * await intersect( * db.select({ courseName: depA.courseName }).from(depA), * db.select({ courseName: depB.courseName }).from(depB) * ); * // or * await db.select({ courseName: depA.courseName }) * .from(depA) * .intersect( * db.select({ courseName: depB.courseName }).from(depB) * ); * ``` */ export declare const intersect: SingleStoreCreateSetOperatorFn; /** * Adds `except` set operator to the query. * * Calling this method will retrieve all unique rows from the left query, except for the rows that are present in the result set of the right query. * * See docs: {@link https://orm.drizzle.team/docs/set-operations#except} * * @example * * ```ts * // Select all courses offered in department A but not in department B * import { except } from 'drizzle-orm/singlestore-core' * * await except( * db.select({ courseName: depA.courseName }).from(depA), * db.select({ courseName: depB.courseName }).from(depB) * ); * // or * await db.select({ courseName: depA.courseName }) * .from(depA) * .except( * db.select({ courseName: depB.courseName }).from(depB) * ); * ``` */ export declare const except: SingleStoreCreateSetOperatorFn; /** * Adds `minus` set operator to the query. * * This is an alias of `except` supported by SingleStore. * * @example * * ```ts * // Select all courses offered in department A but not in department B * import { minus } from 'drizzle-orm/singlestore-core' * * await minus( * db.select({ courseName: depA.courseName }).from(depA), * db.select({ courseName: depB.courseName }).from(depB) * ); * // or * await db.select({ courseName: depA.courseName }) * .from(depA) * .minus( * db.select({ courseName: depB.courseName }).from(depB) * ); * ``` */ export declare const minus: SingleStoreCreateSetOperatorFn;