/opt/canhelp/node_modules/kysely/dist/cjs/query-builder
Edit: /opt/canhelp/node_modules/kysely/dist/cjs/query-builder/over-builder.d.ts (3755B)
import type { Expression } from '../expression/expression.js';
import type { OperationNodeSource } from '../operation-node/operation-node-source.js';
import { OverNode } from '../operation-node/over-node.js';
import { type DirectedOrderByStringReference, type OrderByExpression, type OrderByModifiers } from '../parser/order-by-parser.js';
import { type PartitionByExpression } from '../parser/partition-by-parser.js';
import type { OrderByInterface } from './order-by-interface.js';
export declare class OverBuilder
implements OrderByInterface, OperationNodeSource {
#private;
constructor(props: OverBuilderProps);
/**
* Adds an `order by` clause or item inside the `over` function.
*
* ```ts
* const result = await db
* .selectFrom('person')
* .select(
* (eb) => eb.fn.avg('age').over(
* ob => ob.orderBy('first_name', 'asc').orderBy('last_name', 'asc')
* ).as('average_age')
* )
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select avg("age") over(order by "first_name" asc, "last_name" asc) as "average_age"
* from "person"
* ```
*/
orderBy>(expr: OE, modifiers?: OrderByModifiers): OverBuilder;
/**
* @deprecated It does ~2-2.6x more compile-time instantiations compared to multiple chained `orderBy(expr, modifiers?)` calls (in `order by` clauses with reasonable item counts), and has broken autocompletion.
*/
orderBy | DirectedOrderByStringReference>(exprs: ReadonlyArray): OverBuilder;
/**
* @deprecated It does ~2.9x more compile-time instantiations compared to a `orderBy(expr, direction)` call.
*/
orderBy>(expr: OE): OverBuilder;
/**
* @deprecated Use `orderBy(expr, (ob) => ...)` instead.
*/
orderBy>(expr: OE, modifiers: Expression): OverBuilder;
/**
* Clears the `order by` clause from the query.
*
* See {@link orderBy} for adding an `order by` clause or item to a query.
*
* ### Examples
*
* ```ts
* const query = db
* .selectFrom('person')
* .selectAll()
* .orderBy('id', 'desc')
*
* const results = await query
* .clearOrderBy()
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select * from "person"
* ```
*/
clearOrderBy(): OverBuilder;
/**
* Adds partition by clause item/s inside the over function.
*
* ```ts
* const result = await db
* .selectFrom('person')
* .select(
* (eb) => eb.fn.avg('age').over(
* ob => ob.partitionBy(['last_name', 'first_name'])
* ).as('average_age')
* )
* .execute()
* ```
*
* The generated SQL (PostgreSQL):
*
* ```sql
* select avg("age") over(partition by "last_name", "first_name") as "average_age"
* from "person"
* ```
*/
partitionBy(partitionBy: ReadonlyArray>): OverBuilder;
partitionBy>(partitionBy: PE): OverBuilder;
/**
* Simply calls the provided function passing `this` as the only argument. `$call` returns
* what the provided function returns.
*/
$call(func: (qb: this) => T): T;
toOperationNode(): OverNode;
}
export interface OverBuilderProps {
readonly overNode: OverNode;
}