Interface ModelQueryBuilder<TData, TVirtual, TInstance, TRelations>
interface ModelQueryBuilder< TData extends JsonObject, TVirtual extends JsonObject, TInstance extends ModelInstance<TData, TVirtual>, TRelations extends string = string,> { aggregateGrouped( func: "COUNT" | "AVG" | "SUM" | "MIN" | "MAX", options?: { aggregateField?: string }, ): Promise<Map<string, number>>; average(field: string): Promise<number>; between( startDate: Date, endDate: Date, options?: JsonObject, ): ModelQueryBuilder<TData, TVirtual, TInstance, TRelations>; contains( field: string, value: unknown, ): ModelQueryBuilder<TData, TVirtual, TInstance, TRelations>; count(): Promise<number>; delete(): Promise<number>; deleteById(id: string): Promise<number>; first(): Promise<TInstance>; getJoin( joinSpec: Partial<Record<TRelations, boolean | JsonObject>>, ): ModelQueryBuilder<TData, TVirtual, TInstance, TRelations>; groupBy( fields: string | string[], ): ModelQueryBuilder<TData, TVirtual, TInstance, TRelations>; includeSensitive( fields: string | string[], ): ModelQueryBuilder<TData, TVirtual, TInstance, TRelations>; limit( count: number, ): ModelQueryBuilder<TData, TVirtual, TInstance, TRelations>; orderBy( field: string, direction?: "ASC" | "DESC", ): ModelQueryBuilder<TData, TVirtual, TInstance, TRelations>; orderByRelation( relation: TRelations, field: string, direction?: "ASC" | "DESC", ): ModelQueryBuilder<TData, TVirtual, TInstance, TRelations>; run(): Promise<TInstance[]>; [key: string]: unknown;} Methods
aggregateGrouped
aggregateGrouped( func: "COUNT" | "AVG" | "SUM" | "MIN" | "MAX", options?: { aggregateField?: string },): Promise<Map<string, number>> Parameters
- func: "COUNT" | "AVG" | "SUM" | "MIN" | "MAX"
Optionaloptions: { aggregateField?: string }
Returns Promise<Map<string, number>>
average
average(field: string): Promise<number>
between
Parameters
- startDate: Date
- endDate: Date
Optionaloptions: JsonObject
contains
Parameters
- field: string
- value: unknown
delete
delete(): Promise<number>
deleteById
deleteById(id: string): Promise<number>
groupBy
Parameters
- fields: string | string[]
includeSensitive
Parameters
- fields: string | string[]
orderBy
Parameters
- field: string
Optionaldirection: "ASC" | "DESC"
orderByRelation
Parameters
- relation: TRelations
- field: string
Optionaldirection: "ASC" | "DESC"