Interface: ModelQueryBuilderContract<Model, Result>

Model query builder will have extras methods on top of the Database query builder

Extends

• ChainableContract.ExcutableQueryBuilderContract<Result[]>

Type Parameters

Type Parameter	Default type
Model extends LucidModel	-
Result	InstanceType<Model>

Properties

Property	Modifier	Type	Description	Inherited from
[toStringTag]	readonly	string	-	ExcutableQueryBuilderContract.[toStringTag]
andDoesntHave	public	Has<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	-	-
andHas	public	Has<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	-	-
andHaving	public	Having<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andHaving
andHavingBetween	public	HavingBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andHavingBetween
andHavingExists	public	HavingExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andHavingExists
andHavingIn	public	HavingIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andHavingIn
andHavingNotBetween	public	HavingBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andHavingNotBetween
andHavingNotExists	public	HavingExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andHavingNotExists
andHavingNotIn	public	HavingIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andHavingNotIn
andHavingNotNull	public	HavingNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andHavingNotNull
andHavingNull	public	HavingNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andHavingNull
andHavingRaw	public	RawQueryFn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andHavingRaw
andWhere	public	Where<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhere
andWhereBetween	public	WhereBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereBetween
andWhereColumn	public	WhereColumn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereColumn
andWhereDoesntHave	public	WhereHas<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	-	-
andWhereExists	public	WhereExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereExists
andWhereHas	public	WhereHas<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	-	-
andWhereILike	public	WhereLike<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereILike
andWhereIn	public	WhereIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereIn
andWhereJson	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereJson
andWhereJsonPath	public	WhereJsonPath<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereJsonPath
andWhereJsonSubset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereJsonSubset
andWhereJsonSuperset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereJsonSuperset
andWhereLike	public	WhereLike<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereLike
andWhereNot	public	Where<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereNot
andWhereNotBetween	public	WhereBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereNotBetween
andWhereNotColumn	public	WhereColumn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereNotColumn
andWhereNotExists	public	WhereExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereNotExists
andWhereNotIn	public	WhereIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereNotIn
andWhereNotJson	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereNotJson
andWhereNotJsonSubset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereNotJsonSubset
andWhereNotJsonSuperset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereNotJsonSuperset
andWhereNotNull	public	WhereNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereNotNull
andWhereNull	public	WhereNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereNull
andWhereRaw	public	RawQueryFn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.andWhereRaw
avg	public	Aggregate<ModelQueryBuilderContract<Model, Result>>	-	-
avgDistinct	public	Aggregate<ModelQueryBuilderContract<Model, Result>>	-	-
client	public	QueryClientContract	Reference to query client used for making queries	-
clientOptions	readonly	ModelAdapterOptions	A copy of client options.	-
columns	public	( | string | QueryBuilder<any, any> | RawQueryBuilder<any, unknown[]>)[]	-	ModelQueryBuilderContract.columns
count	public	Aggregate<ModelQueryBuilderContract<Model, Result>>	Aggregates	-
countDistinct	public	Aggregate<ModelQueryBuilderContract<Model, Result>>	-	-
crossJoin	public	Join<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.crossJoin
decrement	public	Counter<ModelQueryBuilderContract<Model, any>>	-	-
distinct	public	Distinct<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.distinct
distinctOn	public	Distinct<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.distinctOn
doesntHave	public	Has<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	-	-
from	public	FromTable<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.from
fullOuterJoin	public	Join<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.fullOuterJoin
groupBy	public	GroupBy<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.groupBy
groupByRaw	public	RawQueryFn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.groupByRaw
has	public	Has<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	Add where constraint using the relationship	-
hasAggregates	public	boolean	-	ChainableContract.hasAggregates
hasGroupBy	public	boolean	-	ChainableContract.hasGroupBy
hasUnion	public	boolean	-	ChainableContract.hasUnion
having	public	Having<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.having
havingBetween	public	HavingBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.havingBetween
havingExists	public	HavingExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.havingExists
havingIn	public	HavingIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.havingIn
havingNotBetween	public	HavingBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.havingNotBetween
havingNotExists	public	HavingExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.havingNotExists
havingNotIn	public	HavingIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.havingNotIn
havingNotNull	public	HavingNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.havingNotNull
havingNull	public	HavingNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.havingNull
havingRaw	public	RawQueryFn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.havingRaw
increment	public	Counter<ModelQueryBuilderContract<Model, any>>	-	-
innerJoin	public	Join<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.innerJoin
intersect	public	Intersect<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.intersect
isChildQuery	public	boolean	Whether or not the query is a child query generated for .where callbacks	-
join	public	Join<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.join
joinRaw	public	RawQueryFn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.joinRaw
keysResolver?	public	(columnName: string) => string	-	ChainableContract.keysResolver
knexQuery	public	QueryBuilder	-	ChainableContract.knexQuery
leftJoin	public	Join<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.leftJoin
leftOuterJoin	public	Join<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.leftOuterJoin
max	public	Aggregate<ModelQueryBuilderContract<Model, Result>>	-	-
min	public	Aggregate<ModelQueryBuilderContract<Model, Result>>	-	-
model	public	Model	-	-
orderBy	public	OrderBy<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orderBy
orderByRaw	public	RawQueryFn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orderByRaw
orDoesntHave	public	Has<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	-	-
orHas	public	Has<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	-	-
orHaving	public	Having<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orHaving
orHavingBetween	public	HavingBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orHavingBetween
orHavingExists	public	HavingExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orHavingExists
orHavingIn	public	HavingIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orHavingIn
orHavingNotBetween	public	HavingBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orHavingNotBetween
orHavingNotExists	public	HavingExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orHavingNotExists
orHavingNotIn	public	HavingIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orHavingNotIn
orHavingNotNull	public	HavingNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orHavingNotNull
orHavingNull	public	HavingNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orHavingNull
orHavingRaw	public	RawQueryFn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orHavingRaw
orWhere	public	Where<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhere
orWhereBetween	public	WhereBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereBetween
orWhereColumn	public	WhereColumn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereColumn
orWhereDoesntHave	public	WhereHas<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	-	-
orWhereExists	public	WhereExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereExists
orWhereHas	public	WhereHas<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	-	-
orWhereILike	public	WhereLike<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereILike
orWhereIn	public	WhereIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereIn
orWhereJson	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereJson
orWhereJsonPath	public	WhereJsonPath<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereJsonPath
orWhereJsonSubset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereJsonSubset
orWhereJsonSuperset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereJsonSuperset
orWhereLike	public	WhereLike<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereLike
orWhereNot	public	Where<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereNot
orWhereNotBetween	public	WhereBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereNotBetween
orWhereNotColumn	public	WhereColumn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereNotColumn
orWhereNotExists	public	WhereExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereNotExists
orWhereNotIn	public	WhereIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereNotIn
orWhereNotJson	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereNotJson
orWhereNotJsonSubset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereNotJsonSubset
orWhereNotJsonSuperset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereNotJsonSuperset
orWhereNotNull	public	WhereNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereNotNull
orWhereNull	public	WhereNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereNull
orWhereRaw	public	RawQueryFn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.orWhereRaw
preload	public	Preload<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	Define relationships to be preloaded	-
preloadOnce	public	PreloadOnce<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	-	-
returning	public	Returning<ModelQueryBuilderContract<Model, Result>>	-	-
rightJoin	public	Join<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.rightJoin
rightOuterJoin	public	Join<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.rightOuterJoin
select	public	DatabaseQueryBuilderSelect<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.select
sideloaded	public	InstanceType<Model>["$sideloaded"]	-	-
subQueryAlias?	public	string	-	ChainableContract.subQueryAlias
sum	public	Aggregate<ModelQueryBuilderContract<Model, Result>>	-	-
sumDistinct	public	Aggregate<ModelQueryBuilderContract<Model, Result>>	-	-
union	public	Union<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.union
unionAll	public	UnionAll<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.unionAll
update	public	Update<ModelQueryBuilderContract<Model, any>>	Mutations (update and increment can be one query aswell)	-
where	public	Where<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.where
whereBetween	public	WhereBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereBetween
whereColumn	public	WhereColumn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereColumn
whereDoesntHave	public	WhereHas<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	-	-
whereExists	public	WhereExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereExists
whereHas	public	WhereHas<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	Add where constraint using the relationship with a custom callback	-
whereILike	public	WhereLike<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereILike
whereIn	public	WhereIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereIn
whereJson	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereJson
whereJsonPath	public	WhereJsonPath<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereJsonPath
whereJsonSubset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereJsonSubset
whereJsonSuperset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereJsonSuperset
whereLike	public	WhereLike<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereLike
whereNot	public	Where<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereNot
whereNotBetween	public	WhereBetween<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereNotBetween
whereNotColumn	public	WhereColumn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereNotColumn
whereNotExists	public	WhereExists<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereNotExists
whereNotIn	public	WhereIn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereNotIn
whereNotJson	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereNotJson
whereNotJsonSubset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereNotJsonSubset
whereNotJsonSuperset	public	WhereJson<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereNotJsonSuperset
whereNotNull	public	WhereNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereNotNull
whereNull	public	WhereNull<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereNull
whereRaw	public	RawQueryFn<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.whereRaw
with	public	With<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.with
withAggregate	public	WithAggregate<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	Fetch aggregate value for a given relationship	-
withCount	public	WithCount<InstanceType<Model>, ModelQueryBuilderContract<Model, Result>>	Fetch relationship count	-
withMaterialized	public	With<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.withMaterialized
withNotMaterialized	public	With<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.withNotMaterialized
withRecursive	public	With<ModelQueryBuilderContract<Model, Result>>	-	ChainableContract.withRecursive

Methods

apply()

apply<Scopes>(callback: (scopes: Scopes) => void): this;

Alias for the

Type Parameters

Type Parameter
Scopes extends ExtractScopes<Model>

Parameters

Parameter	Type
callback	(scopes: Scopes) => void

Returns

this

With Scopes

method

---

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>(): ModelQueryBuilderContract<Model, ClonedResult>;

Clone query builder instance

Type Parameters

Type Parameter	Default type
ClonedResult	Result

Returns

ModelQueryBuilderContract<Model, ClonedResult>

---

debug()

debug(debug: boolean): this;

Parameters

Parameter	Type
debug	boolean

Returns

this

Inherited from

ExcutableQueryBuilderContract.debug;

---

del()

del(returning?: OneOrMany<string>): ModelQueryBuilderContract<Model, any>;

Perform delete operation

Parameters

Parameter	Type
returning?	OneOrMany<string>

Returns

ModelQueryBuilderContract<Model, any>

---

delete()

delete(returning?: OneOrMany<string>): ModelQueryBuilderContract<Model, any>;

Parameters

Parameter	Type
returning?	OneOrMany<string>

Returns

ModelQueryBuilderContract<Model, any>

---

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>;

Return the first matching row 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<Result extends LucidRow ? ModelPaginatorContract<Result<Result>> : SimplePaginatorContract<Result>>;

Execute query with pagination

Parameters

Parameter	Type
page	number
perPage?	number

Returns

Promise<Result extends LucidRow ? ModelPaginatorContract<Result<Result>> : SimplePaginatorContract<Result>>

---

pojo()

pojo<T>(): ModelQueryBuilderContract<Model, T>;

Get rows back as a plain javascript object and not an array of model instances

Type Parameters

Type Parameter
T

Returns

ModelQueryBuilderContract<Model, T>

---

preloadCached()

Call Signature

preloadCached(
   name: string,
   options?: RelationCacheCallOptions,
   callback?: (query: ModelQueryBuilderContract<LucidModel>) => void): this;

Preloads a 1:1 relation with explicit cache controls (e.g. forceLoad) and optional per-call cache entry overrides, then delegates to the native preload. Present on cache-enabled resourceful models.

Parameters

Parameter	Type	Description
name	string	The relation name to preload.
options?	RelationCacheCallOptions	Cache call options (forceLoad + entry overrides).
callback?	(query: ModelQueryBuilderContract<LucidModel>) => void	Optional Lucid preload callback.

Returns

this

Call Signature

preloadCached(
   name: string,
   options?: RelationCacheCallOptions,
   callback?: (query: ModelQueryBuilderContract<LucidModel>) => void): this;

Preloads a 1:1 relation with explicit cache controls (e.g. forceLoad) and optional per-call cache entry overrides, then delegates to the native preload. Present on cache-enabled resourceful models.

Parameters

Parameter	Type	Description
name	string	The relation name to preload.
options?	RelationCacheCallOptions	Cache call options (forceLoad + entry overrides).
callback?	(query: ModelQueryBuilderContract<LucidModel>) => void	Optional Lucid preload callback.

Returns

this

---

reporterData()

reporterData(data: any): this;

Parameters

Parameter	Type
data	any

Returns

this

Inherited from

ExcutableQueryBuilderContract.reporterData;

---

rowTransformer()

rowTransformer(callback: (row: LucidRow) => void): this;

Define a callback to transform a row

Parameters

Parameter	Type
callback	(row: LucidRow) => void

Returns

this

---

sideload()

sideload<Sideloaded, Merge>(value: Merge extends true ? Partial<Sideloaded> : Sideloaded, merge?: Merge): this;

A custom set of sideloaded properties defined on the query builder, this will be passed to the model instance created by the query builder

Type Parameters

Type Parameter	Default type
Sideloaded extends ModelObject	-
Merge extends boolean	false

Parameters

Parameter	Type
value	Merge extends true ? Partial<Sideloaded> : Sideloaded
merge?	Merge

Returns

this

---

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

---

usePreloader()

usePreloader(preloader: PreloaderContract<LucidRow>): this;

Define a custom preloader for the current query

Parameters

Parameter	Type
preloader	PreloaderContract<LucidRow>

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;

---

withScopes()

withScopes<Scopes>(callback: (scopes: Scopes) => void): this;

Apply model query scopes on the query bulder

Type Parameters

Type Parameter
Scopes extends ExtractScopes<Model>

Parameters

Parameter	Type
callback	(scopes: Scopes) => void

Returns

this

---

wrapExisting()

wrapExisting(): this;

Returns

this

Inherited from

ChainableContract.wrapExisting;