Interface: DatabaseQueryBuilderContract<Result>

Database query builder exposes the API to construct SQL query using fluent chainable API

Extends

ChainableContract.ExcutableQueryBuilderContract<Result[]>

Type Parameters

Type Parameter	Default type
`Result`	`Dictionary`<`any`, `string`>

Properties

Property	Modifier	Type	Description	Inherited from
`[toStringTag]`	`readonly`	`string`	-	`ExcutableQueryBuilderContract.[toStringTag]`
`andHaving`	`public`	`Having`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andHaving`
`andHavingBetween`	`public`	`HavingBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andHavingBetween`
`andHavingExists`	`public`	`HavingExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andHavingExists`
`andHavingIn`	`public`	`HavingIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andHavingIn`
`andHavingNotBetween`	`public`	`HavingBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andHavingNotBetween`
`andHavingNotExists`	`public`	`HavingExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andHavingNotExists`
`andHavingNotIn`	`public`	`HavingIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andHavingNotIn`
`andHavingNotNull`	`public`	`HavingNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andHavingNotNull`
`andHavingNull`	`public`	`HavingNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andHavingNull`
`andHavingRaw`	`public`	`RawQueryFn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andHavingRaw`
`andWhere`	`public`	`Where`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhere`
`andWhereBetween`	`public`	`WhereBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereBetween`
`andWhereColumn`	`public`	`WhereColumn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereColumn`
`andWhereExists`	`public`	`WhereExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereExists`
`andWhereILike`	`public`	`WhereLike`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereILike`
`andWhereIn`	`public`	`WhereIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereIn`
`andWhereJson`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereJson`
`andWhereJsonPath`	`public`	`WhereJsonPath`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereJsonPath`
`andWhereJsonSubset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereJsonSubset`
`andWhereJsonSuperset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereJsonSuperset`
`andWhereLike`	`public`	`WhereLike`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereLike`
`andWhereNot`	`public`	`Where`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereNot`
`andWhereNotBetween`	`public`	`WhereBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereNotBetween`
`andWhereNotColumn`	`public`	`WhereColumn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereNotColumn`
`andWhereNotExists`	`public`	`WhereExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereNotExists`
`andWhereNotIn`	`public`	`WhereIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereNotIn`
`andWhereNotJson`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereNotJson`
`andWhereNotJsonSubset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereNotJsonSubset`
`andWhereNotJsonSuperset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereNotJsonSuperset`
`andWhereNotNull`	`public`	`WhereNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereNotNull`
`andWhereNull`	`public`	`WhereNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereNull`
`andWhereRaw`	`public`	`RawQueryFn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.andWhereRaw`
`avg`	`public`	`Aggregate`<`DatabaseQueryBuilderContract`<`Result`>>	-	-
`avgDistinct`	`public`	`Aggregate`<`DatabaseQueryBuilderContract`<`Result`>>	-	-
`client`	`public`	`QueryClientContract`	-	-
`columns`	`public`	( \| `string` \| `QueryBuilder`<`any`, `any`> \| `RawQueryBuilder`<`any`, `unknown`[]>)[]	-	`ChainableContract.columns`
`count`	`public`	`Aggregate`<`DatabaseQueryBuilderContract`<`Result`>>	Aggregates	-
`countDistinct`	`public`	`Aggregate`<`DatabaseQueryBuilderContract`<`Result`>>	-	-
`crossJoin`	`public`	`Join`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.crossJoin`
`decrement`	`public`	`Counter`<`DatabaseQueryBuilderContract`<`Result`>>	-	-
`distinct`	`public`	`Distinct`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.distinct`
`distinctOn`	`public`	`Distinct`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.distinctOn`
`from`	`public`	`FromTable`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.from`
`fullOuterJoin`	`public`	`Join`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.fullOuterJoin`
`groupBy`	`public`	`GroupBy`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.groupBy`
`groupByRaw`	`public`	`RawQueryFn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.groupByRaw`
`hasAggregates`	`public`	`boolean`	-	`ChainableContract.hasAggregates`
`hasGroupBy`	`public`	`boolean`	-	`ChainableContract.hasGroupBy`
`hasUnion`	`public`	`boolean`	-	`ChainableContract.hasUnion`
`having`	`public`	`Having`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.having`
`havingBetween`	`public`	`HavingBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.havingBetween`
`havingExists`	`public`	`HavingExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.havingExists`
`havingIn`	`public`	`HavingIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.havingIn`
`havingNotBetween`	`public`	`HavingBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.havingNotBetween`
`havingNotExists`	`public`	`HavingExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.havingNotExists`
`havingNotIn`	`public`	`HavingIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.havingNotIn`
`havingNotNull`	`public`	`HavingNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.havingNotNull`
`havingNull`	`public`	`HavingNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.havingNull`
`havingRaw`	`public`	`RawQueryFn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.havingRaw`
`increment`	`public`	`Counter`<`DatabaseQueryBuilderContract`<`Result`>>	-	-
`innerJoin`	`public`	`Join`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.innerJoin`
`intersect`	`public`	`Intersect`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.intersect`
`join`	`public`	`Join`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.join`
`joinRaw`	`public`	`RawQueryFn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.joinRaw`
`keysResolver?`	`public`	(`columnName`: `string`) => `string`	-	`ChainableContract.keysResolver`
`knexQuery`	`public`	`QueryBuilder`	-	`ChainableContract.knexQuery`
`leftJoin`	`public`	`Join`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.leftJoin`
`leftOuterJoin`	`public`	`Join`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.leftOuterJoin`
`max`	`public`	`Aggregate`<`DatabaseQueryBuilderContract`<`Result`>>	-	-
`min`	`public`	`Aggregate`<`DatabaseQueryBuilderContract`<`Result`>>	-	-
`orderBy`	`public`	`OrderBy`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orderBy`
`orderByRaw`	`public`	`RawQueryFn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orderByRaw`
`orHaving`	`public`	`Having`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orHaving`
`orHavingBetween`	`public`	`HavingBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orHavingBetween`
`orHavingExists`	`public`	`HavingExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orHavingExists`
`orHavingIn`	`public`	`HavingIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orHavingIn`
`orHavingNotBetween`	`public`	`HavingBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orHavingNotBetween`
`orHavingNotExists`	`public`	`HavingExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orHavingNotExists`
`orHavingNotIn`	`public`	`HavingIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orHavingNotIn`
`orHavingNotNull`	`public`	`HavingNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orHavingNotNull`
`orHavingNull`	`public`	`HavingNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orHavingNull`
`orHavingRaw`	`public`	`RawQueryFn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orHavingRaw`
`orWhere`	`public`	`Where`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhere`
`orWhereBetween`	`public`	`WhereBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereBetween`
`orWhereColumn`	`public`	`WhereColumn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereColumn`
`orWhereExists`	`public`	`WhereExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereExists`
`orWhereILike`	`public`	`WhereLike`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereILike`
`orWhereIn`	`public`	`WhereIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereIn`
`orWhereJson`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereJson`
`orWhereJsonPath`	`public`	`WhereJsonPath`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereJsonPath`
`orWhereJsonSubset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereJsonSubset`
`orWhereJsonSuperset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereJsonSuperset`
`orWhereLike`	`public`	`WhereLike`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereLike`
`orWhereNot`	`public`	`Where`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereNot`
`orWhereNotBetween`	`public`	`WhereBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereNotBetween`
`orWhereNotColumn`	`public`	`WhereColumn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereNotColumn`
`orWhereNotExists`	`public`	`WhereExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereNotExists`
`orWhereNotIn`	`public`	`WhereIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereNotIn`
`orWhereNotJson`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereNotJson`
`orWhereNotJsonSubset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereNotJsonSubset`
`orWhereNotJsonSuperset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereNotJsonSuperset`
`orWhereNotNull`	`public`	`WhereNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereNotNull`
`orWhereNull`	`public`	`WhereNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereNull`
`orWhereRaw`	`public`	`RawQueryFn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.orWhereRaw`
`returning`	`public`	`Returning`<`DatabaseQueryBuilderContract`<`Result`>>	-	-
`rightJoin`	`public`	`Join`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.rightJoin`
`rightOuterJoin`	`public`	`Join`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.rightOuterJoin`
`select`	`public`	`DatabaseQueryBuilderSelect`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.select`
`subQueryAlias?`	`public`	`string`	-	`ChainableContract.subQueryAlias`
`sum`	`public`	`Aggregate`<`DatabaseQueryBuilderContract`<`Result`>>	-	-
`sumDistinct`	`public`	`Aggregate`<`DatabaseQueryBuilderContract`<`Result`>>	-	-
`union`	`public`	`Union`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.union`
`unionAll`	`public`	`UnionAll`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.unionAll`
`update`	`public`	`Update`<`DatabaseQueryBuilderContract`<`Result`>>	Mutations (update and increment can be one query aswell)	-
`where`	`public`	`Where`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.where`
`whereBetween`	`public`	`WhereBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereBetween`
`whereColumn`	`public`	`WhereColumn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereColumn`
`whereExists`	`public`	`WhereExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereExists`
`whereILike`	`public`	`WhereLike`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereILike`
`whereIn`	`public`	`WhereIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereIn`
`whereJson`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereJson`
`whereJsonPath`	`public`	`WhereJsonPath`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereJsonPath`
`whereJsonSubset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereJsonSubset`
`whereJsonSuperset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereJsonSuperset`
`whereLike`	`public`	`WhereLike`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereLike`
`whereNot`	`public`	`Where`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereNot`
`whereNotBetween`	`public`	`WhereBetween`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereNotBetween`
`whereNotColumn`	`public`	`WhereColumn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereNotColumn`
`whereNotExists`	`public`	`WhereExists`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereNotExists`
`whereNotIn`	`public`	`WhereIn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereNotIn`
`whereNotJson`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereNotJson`
`whereNotJsonSubset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereNotJsonSubset`
`whereNotJsonSuperset`	`public`	`WhereJson`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereNotJsonSuperset`
`whereNotNull`	`public`	`WhereNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereNotNull`
`whereNull`	`public`	`WhereNull`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereNull`
`whereRaw`	`public`	`RawQueryFn`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.whereRaw`
`with`	`public`	`With`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.with`
`withMaterialized`	`public`	`With`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.withMaterialized`
`withNotMaterialized`	`public`	`With`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.withNotMaterialized`
`withRecursive`	`public`	`With`<`DatabaseQueryBuilderContract`<`Result`>>	-	`ChainableContract.withRecursive`

Methods

as()

as(name: string): this;

Parameters

Parameter	Type
`name`	`string`

Returns

this

Inherited from

ChainableContract.as;

catch()

catch<TResult>(onrejected?: (reason: any) => TResult | PromiseLike<TResult> | null): Promise<Result[] | TResult>;

Attaches a callback for only the rejection of the Promise.

Type Parameters

Type Parameter	Default type
`TResult`	`never`

Parameters

Parameter	Type	Description
`onrejected?`	(`reason`: `any`) => `TResult` \| `PromiseLike`<`TResult`> \| `null`	The callback to execute when the Promise is rejected.

Returns

Promise<Result[] | TResult>

A Promise for the completion of the callback.

Inherited from

ExcutableQueryBuilderContract.catch;

clearHaving()

clearHaving(): this;

Returns

this

Inherited from

ChainableContract.clearHaving;

clearLimit()

clearLimit(): this;

Returns

this

Inherited from

ChainableContract.clearLimit;

clearOffset()

clearOffset(): this;

Returns

this

Inherited from

ChainableContract.clearOffset;

clearOrder()

clearOrder(): this;

Returns

this

Inherited from

ChainableContract.clearOrder;

clearSelect()

clearSelect(): this;

Returns

this

Inherited from

ChainableContract.clearSelect;

clearWhere()

clearWhere(): this;

Returns

this

Inherited from

ChainableContract.clearWhere;

clone()

clone<ClonedResult>(): DatabaseQueryBuilderContract<ClonedResult>;

Clone current query

Type Parameters

Type Parameter	Default type
`ClonedResult`	`Result`

Returns

DatabaseQueryBuilderContract<ClonedResult>

debug()

debug(debug: boolean): this;

Parameters

Parameter	Type
`debug`	`boolean`

Returns

this

Inherited from

ExcutableQueryBuilderContract.debug;

del()

del(returning?: OneOrMany<string>): this;

Perform delete operation

Parameters

Parameter	Type
`returning?`	`OneOrMany`<`string`>

Returns

this

delete()

delete(returning?: OneOrMany<string>): this;

Parameters

Parameter	Type
`returning?`	`OneOrMany`<`string`>

Returns

this

exec()

exec(): Promise<Result[]>;

Returns

Promise<Result[]>

Inherited from

ExcutableQueryBuilderContract.exec;

finally()

finally(onfinally?: () => void | null): Promise<Result[]>;

Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

Parameters

Parameter	Type	Description
`onfinally?`	() => `void` \| `null`	The callback to execute when the Promise is settled (fulfilled or rejected).

Returns

Promise<Result[]>

A Promise for the completion of the callback.

Inherited from

ExcutableQueryBuilderContract.finally;

first()

first(): Promise<Result | null>;

Execute and get first result

Returns

Promise<Result | null>

firstOrFail()

firstOrFail(): Promise<Result>;

Execute and get first result or fail

Returns

Promise<Result>

forPage()

forPage(page: number, perPage?: number): this;

A shorthand to define limit and offset based upon the current page

Parameters

Parameter	Type
`page`	`number`
`perPage?`	`number`

Returns

this

forShare()

forShare(...tableNames: string[]): this;

Parameters

Parameter	Type
...`tableNames`	`string`[]

Returns

this

Inherited from

ChainableContract.forShare;

forUpdate()

forUpdate(...tableNames: string[]): this;

Parameters

Parameter	Type
...`tableNames`	`string`[]

Returns

this

Inherited from

ChainableContract.forUpdate;

if()

if(
   condition: any,
   matchCallback: (query: this) => any,
   noMatchCallback?: (query: this) => any): this;

Executes the callback when condition is truthy

Parameters

Parameter	Type
`condition`	`any`
`matchCallback`	(`query`: `this`) => `any`
`noMatchCallback?`	(`query`: `this`) => `any`

Returns

this

Inherited from

ChainableContract.if;

ifDialect()

ifDialect(
   dialect:
  | "mssql"
  | "mysql"
  | "oracledb"
  | "postgres"
  | "redshift"
  | "sqlite3"
  | "libsql"
  | "better-sqlite3"
  | (
  | "mssql"
  | "mysql"
  | "oracledb"
  | "postgres"
  | "redshift"
  | "sqlite3"
  | "libsql"
  | "better-sqlite3")[],
   matchCallback: (query: this) => any,
   noMatchCallback?: (query: this) => any): this;

Executes the callback when dialect matches one of the mentioned dialects

Parameters

Parameter	Type
`dialect`	\| `"mssql"` \| `"mysql"` \| `"oracledb"` \| `"postgres"` \| `"redshift"` \| `"sqlite3"` \| `"libsql"` \| `"better-sqlite3"` \| ( \| `"mssql"` \| `"mysql"` \| `"oracledb"` \| `"postgres"` \| `"redshift"` \| `"sqlite3"` \| `"libsql"` \| `"better-sqlite3"`)[]
`matchCallback`	(`query`: `this`) => `any`
`noMatchCallback?`	(`query`: `this`) => `any`

Returns

this

limit()

limit(limit: number): this;

Parameters

Parameter	Type
`limit`	`number`

Returns

this

Inherited from

ChainableContract.limit;

match()

match(...blocks: ([any, (query: this) => any] | (query: this) => any)[]): this;

Write blocks to match from

Parameters

Parameter	Type
...`blocks`	([`any`, (`query`: `this`) => `any`] \| (`query`: `this`) => `any`)[]

Returns

this

Inherited from

ChainableContract.match;

noWait()

noWait(): this;

Returns

this

Inherited from

ChainableContract.noWait;

offset()

offset(offset: number): this;

Parameters

Parameter	Type
`offset`	`number`

Returns

this

Inherited from

ChainableContract.offset;

paginate()

paginate(page: number, perPage?: number): Promise<SimplePaginatorContract<Result>>;

Execute query with pagination

Parameters

Parameter	Type
`page`	`number`
`perPage?`	`number`

Returns

Promise<SimplePaginatorContract<Result>>

reporterData()

reporterData(data: any): this;

Parameters

Parameter	Type
`data`	`any`

Returns

this

Inherited from

ExcutableQueryBuilderContract.reporterData;

skipLocked()

skipLocked(): this;

Returns

this

Inherited from

ChainableContract.skipLocked;

then()

then<TResult1, TResult2>(onfulfilled?:
  | (value: Result[]) => TResult1 | PromiseLike<TResult1>
| null, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2> | null): Promise<TResult1 | TResult2>;

Attaches callbacks for the resolution and/or rejection of the Promise.

Type Parameters

Type Parameter	Default type
`TResult1`	`Result`[]
`TResult2`	`never`

Parameters

Parameter	Type	Description
`onfulfilled?`	\| (`value`: `Result`[]) => `TResult1` \| `PromiseLike`<`TResult1`> \| `null`	The callback to execute when the Promise is resolved.
`onrejected?`	(`reason`: `any`) => `TResult2` \| `PromiseLike`<`TResult2`> \| `null`	The callback to execute when the Promise is rejected.

Returns

Promise<TResult1 | TResult2>

A Promise for the completion of which ever callback is executed.

Inherited from

ExcutableQueryBuilderContract.then;

timeout()

timeout(time: number, options?: {
  cancel: boolean;
}): this;

Parameters

Parameter	Type
`time`	`number`
`options?`	{ `cancel`: `boolean`; }
`options.cancel?`	`boolean`

Returns

this

Inherited from

ExcutableQueryBuilderContract.timeout;

toQuery()

toQuery(): string;

Returns

string

Inherited from

ExcutableQueryBuilderContract.toQuery;

toSQL()

toSQL(): Sql;

Returns

Sql

Inherited from

ExcutableQueryBuilderContract.toSQL;

unless()

unless(
   condition: any,
   matchCallback: (query: this) => any,
   noMatchCallback?: (query: this) => any): this;

Executes the callback when condition is falsy

Parameters

Parameter	Type
`condition`	`any`
`matchCallback`	(`query`: `this`) => `any`
`noMatchCallback?`	(`query`: `this`) => `any`

Returns

this

Inherited from

ChainableContract.unless;

unlessDialect()

unlessDialect(
   dialect:
  | "mssql"
  | "mysql"
  | "oracledb"
  | "postgres"
  | "redshift"
  | "sqlite3"
  | "libsql"
  | "better-sqlite3"
  | (
  | "mssql"
  | "mysql"
  | "oracledb"
  | "postgres"
  | "redshift"
  | "sqlite3"
  | "libsql"
  | "better-sqlite3")[],
   matchCallback: (query: this) => any,
   noMatchCallback?: (query: this) => any): this;

Executes the callback when dialect matches doesn't all the mentioned dialects

Parameters

Parameter	Type
`dialect`	\| `"mssql"` \| `"mysql"` \| `"oracledb"` \| `"postgres"` \| `"redshift"` \| `"sqlite3"` \| `"libsql"` \| `"better-sqlite3"` \| ( \| `"mssql"` \| `"mysql"` \| `"oracledb"` \| `"postgres"` \| `"redshift"` \| `"sqlite3"` \| `"libsql"` \| `"better-sqlite3"`)[]
`matchCallback`	(`query`: `this`) => `any`
`noMatchCallback?`	(`query`: `this`) => `any`

Returns

this

useTransaction()

useTransaction(trx: TransactionClientContract): this;

Parameters

Parameter	Type
`trx`	`TransactionClientContract`

Returns

this

Deprecated

Do not use this method. Instead create a query with options.client

Model.query({ client: trx });
Database.query({ client: trx });

Inherited from

ExcutableQueryBuilderContract.useTransaction;

withSchema()

withSchema(schema: string): this;

Parameters

Parameter	Type
`schema`	`string`

Returns

this

Inherited from

ChainableContract.withSchema;

wrapExisting()

wrapExisting(): this;

Returns

this

Inherited from

ChainableContract.wrapExisting;

Interfaces

Variables

Functions

Namespaces

Options

Classes

Interfaces

Variables

Functions

Interfaces

Interface: DatabaseQueryBuilderContract<Result> ​

Extends ​

Type Parameters ​

Properties ​

Methods ​

as() ​

Parameters ​

Returns ​

Inherited from ​

catch() ​

Type Parameters ​

Parameters ​

Returns ​

Inherited from ​

clearHaving() ​

Returns ​

Inherited from ​

clearLimit() ​

Returns ​

Inherited from ​

clearOffset() ​

Returns ​

Inherited from ​

clearOrder() ​

Returns ​

Inherited from ​

clearSelect() ​

Returns ​

Inherited from ​

clearWhere() ​

Returns ​

Inherited from ​

clone() ​

Type Parameters ​

Returns ​

debug() ​

Parameters ​

Returns ​

Inherited from ​

del() ​

Parameters ​

Returns ​

delete() ​

Parameters ​

Returns ​

exec() ​

Returns ​

Inherited from ​

finally() ​

Parameters ​

Returns ​

Inherited from ​

first() ​

Returns ​

firstOrFail() ​

Returns ​

forPage() ​

Parameters ​

Returns ​

forShare() ​

Parameters ​

Returns ​

Inherited from ​

forUpdate() ​

Parameters ​

Returns ​

Inherited from ​

if() ​

Parameters ​

Returns ​

Interface: DatabaseQueryBuilderContract<Result>

Extends

Type Parameters

Properties

Methods

as()

Parameters

Returns

Inherited from

catch()

Type Parameters

Parameters

Returns

Inherited from

clearHaving()

Returns

Inherited from

clearLimit()

Returns

Inherited from

clearOffset()

Returns

Inherited from

clearOrder()

Returns

Inherited from

clearSelect()

Returns

Inherited from

clearWhere()

Returns

Inherited from

clone()

Type Parameters

Returns

debug()

Parameters

Returns

Inherited from

del()

Parameters

Returns

delete()

Parameters

Returns

exec()

Returns

Inherited from

finally()

Parameters

Returns

Inherited from

first()

Returns

firstOrFail()

Returns

forPage()

Parameters

Returns

forShare()

Parameters

Returns

Inherited from

forUpdate()

Parameters

Returns

Inherited from

if()

Parameters

Returns

Inherited from

ifDialect()

Parameters

Returns

limit()

Parameters

Returns

Inherited from

match()

Parameters