Class OverBuilder<DB, TB>

Simply calls the provided function passing this as the only argument. $call returns what the provided function returns.

Clears the order by clause from the query.

See orderBy for adding an order by clause or item to a query.

Examples

const query = db
  .selectFrom('person')
  .selectAll()
  .orderBy('id', 'desc')

const results = await query
  .clearOrderBy()
  .execute()
Copy

The generated SQL (PostgreSQL):

select * from "person"
Copy

Adds an order by clause or item inside the over function.

const result = await db
  .selectFrom('person')
  .select(
    (eb) => eb.fn.avg<number>('age').over(
      ob => ob.orderBy('first_name', 'asc').orderBy('last_name', 'asc')
    ).as('average_age')
  )
  .execute()
Copy

The generated SQL (PostgreSQL):

select avg("age") over(order by "first_name" asc, "last_name" asc) as "average_age"
from "person"
Copy

Adds partition by clause item/s inside the over function.

const result = await db
  .selectFrom('person')
  .select(
    (eb) => eb.fn.avg<number>('age').over(
      ob => ob.partitionBy(['last_name', 'first_name'])
    ).as('average_age')
  )
  .execute()
Copy

The generated SQL (PostgreSQL):

select avg("age") over(partition by "last_name", "first_name") as "average_age"
from "person"
Copy

Adds partition by clause item/s inside the over function.

const result = await db
  .selectFrom('person')
  .select(
    (eb) => eb.fn.avg<number>('age').over(
      ob => ob.partitionBy(['last_name', 'first_name'])
    ).as('average_age')
  )
  .execute()
Copy

The generated SQL (PostgreSQL):

select avg("age") over(partition by "last_name", "first_name") as "average_age"
from "person"
Copy