import {query, QueryResult} from "./MysqlConnectionManager"; import {Connection} from "mysql"; import Model from "./Model"; import Pagination from "../Pagination"; import ModelRelation, {RelationDatabaseProperties} from "./ModelRelation"; import ModelFactory from "./ModelFactory"; export default class ModelQuery implements WhereFieldConsumer { public static select(factory: ModelFactory, ...fields: SelectFields): ModelQuery { fields = fields.map(v => v === '' ? new SelectFieldValue('none', 1, true) : v); return new ModelQuery(QueryType.SELECT, factory, fields.length > 0 ? fields : ['*']); } public static update(factory: ModelFactory, data: { [key: string]: any }): ModelQuery { const fields = []; for (let key in data) { if (data.hasOwnProperty(key)) { fields.push(new UpdateFieldValue(inputToFieldOrValue(key, factory.table), data[key], false)); } } return new ModelQuery(QueryType.UPDATE, factory, fields); } public static delete(factory: ModelFactory): ModelQuery { return new ModelQuery(QueryType.DELETE, factory); } private readonly type: QueryType; private readonly factory: ModelFactory; private readonly table: string; private readonly fields: SelectFields; private _leftJoin?: string; private _leftJoinAlias?: string; private _leftJoinOn: WhereFieldValue[] = []; private _where: (WhereFieldValue | WhereFieldValueGroup)[] = []; private _limit?: number; private _offset?: number; private _sortBy?: string; private _sortDirection?: 'ASC' | 'DESC'; private readonly relations: string[] = []; private readonly subRelations: { [relation: string]: string[] } = {}; private _pivot?: string[]; private _union?: ModelQueryUnion; private _recursiveRelation?: RelationDatabaseProperties; private constructor(type: QueryType, factory: ModelFactory, fields?: SelectFields) { this.type = type; this.factory = factory; this.table = factory.table; this.fields = fields || []; } public leftJoin(table: string, alias?: string): this { this._leftJoin = table; this._leftJoinAlias = alias; return this; } public on(field1: string, field2: string, test: WhereTest = WhereTest.EQ, operator: WhereOperator = WhereOperator.AND): this { this._leftJoinOn.push(new WhereFieldValue(inputToFieldOrValue(field1), inputToFieldOrValue(field2), true, test, operator)); return this; } public where(field: string, value: string | Date | ModelQuery | any, test: WhereTest = WhereTest.EQ, operator: WhereOperator = WhereOperator.AND): this { this._where.push(new WhereFieldValue(field, value, false, test, operator)); return this; } public groupWhere(setter: (query: WhereFieldConsumer) => void, operator: WhereOperator = WhereOperator.AND): this { this._where.push(new WhereFieldValueGroup(this.collectWheres(setter), operator)); return this; } private collectWheres(setter: (query: WhereFieldConsumer) => void): (WhereFieldValue | WhereFieldValueGroup)[] { const query = this; const wheres: (WhereFieldValue | WhereFieldValueGroup)[] = []; setter({ where(field: string, value: string | Date | ModelQuery | any, test: WhereTest = WhereTest.EQ, operator: WhereOperator = WhereOperator.AND) { wheres.push(new WhereFieldValue(field, value, false, test, operator)); return this; }, groupWhere(setter: (query: WhereFieldConsumer) => void, operator: WhereOperator = WhereOperator.AND) { wheres.push(new WhereFieldValueGroup(query.collectWheres(setter), operator)) return this; } }); return wheres; } public limit(limit: number, offset: number = 0): this { this._limit = limit; this._offset = offset; return this; } public sortBy(field: string, direction: SortDirection = 'ASC', raw: boolean = false): this { this._sortBy = raw ? field : inputToFieldOrValue(field); this._sortDirection = direction; return this; } /** * @param relations The relations field names to eagerload. To load nested relations, separate fields with '.' * (i.e.: "author.roles.permissions" loads authors, their roles, and the permissions of these roles) */ public with(...relations: string[]): this { relations.forEach(relation => { const parts = relation.split('.'); this.relations.push(parts[0]); if (parts.length > 1) { if (!this.subRelations[parts[0]]) this.subRelations[parts[0]] = []; this.subRelations[parts[0]].push(parts.slice(1).join('.')); } }); return this; } public pivot(...fields: string[]): this { this._pivot = fields; return this; } public union(query: ModelQuery, sortBy: string, direction: SortDirection = 'ASC', raw: boolean = false, limit?: number): this { if (this.type !== QueryType.SELECT) throw new Error('Union queries are only implemented with SELECT.'); this._union = { query: query, sortBy: raw ? sortBy : inputToFieldOrValue(sortBy), direction: direction, limit: limit, }; return this; } public recursive(relation: RelationDatabaseProperties): this { if (this.type !== QueryType.SELECT) throw new Error('Recursive queries are only implemented with SELECT.'); this._recursiveRelation = relation; return this; } public toString(final: boolean = false): string { let query = ''; if (this._pivot) this.fields.push(...this._pivot); // Prevent wildcard and fields from conflicting let fields = this.fields.map(f => { const field = f.toString(); if (field.startsWith('(')) return f; // Skip sub-queries return inputToFieldOrValue(field, this.table); }).join(','); let join = ''; if (this._leftJoin) { join = ` LEFT JOIN \`${this._leftJoin}\`` + (this._leftJoinAlias ? ` AS \`${this._leftJoinAlias}\`` : '') + ` ON ${this._leftJoinOn[0]}`; for (let i = 1; i < this._leftJoinOn.length; i++) { join += this._leftJoinOn[i].toString(false); } } let where = ''; if (this._where.length > 0) { where = ` WHERE ${this._where[0]}`; for (let i = 1; i < this._where.length; i++) { where += this._where[i].toString(false); } } let limit = ''; if (typeof this._limit === 'number') { limit = ` LIMIT ${this._limit}`; if (typeof this._offset === 'number' && this._offset !== 0) { limit += ` OFFSET ${this._offset}`; } } let orderBy = ''; if (typeof this._sortBy === 'string') { orderBy = ` ORDER BY ${this._sortBy} ${this._sortDirection!}`; } const table = `\`${this.table}\``; switch (this.type) { case QueryType.SELECT: if (this._recursiveRelation) { const cteFields = fields.replace(RegExp(`${table}`, 'g'), 'o'); query = `WITH RECURSIVE cte AS (` + `SELECT ${fields} FROM ${table}${where}` + ` UNION ` + `SELECT ${cteFields} FROM ${table} AS o, cte AS c WHERE o.\`${this._recursiveRelation.foreignKey}\`=c.\`${this._recursiveRelation.localKey}\`` + `) SELECT * FROM cte${join}${orderBy}${limit}`; } else { query = `SELECT ${fields} FROM ${table}${join}${where}${orderBy}${limit}`; } if (this._union) { const unionOrderBy = this._union.sortBy ? ` ORDER BY ${this._union.sortBy} ${this._union.direction}` : ''; const unionLimit = typeof this._union.limit === 'number' ? ` LIMIT ${this._union.limit}` : ''; query = `(${query}) UNION ${this._union.query.toString(false)}${unionOrderBy}${unionLimit}`; } break; case QueryType.UPDATE: query = `UPDATE ${table} SET ${fields}${where}${orderBy}${limit}`; break; case QueryType.DELETE: query = `DELETE FROM ${table}${where}${orderBy}${limit}`; break; } return final ? query : `(${query})`; } public build(): string { return this.toString(true); } public get variables(): any[] { const variables: any[] = []; this.fields?.filter(v => v instanceof FieldValue) .flatMap(v => (v).variables) .forEach(v => variables.push(v)); this._where.flatMap(v => this.getVariables(v)) .forEach(v => variables.push(v)); this._union?.query.variables.forEach(v => variables.push(v)); return variables; } private getVariables(where: WhereFieldValue | WhereFieldValueGroup): any[] { return where instanceof WhereFieldValueGroup ? where.fields.flatMap(v => this.getVariables(v)) : where.variables; } public async execute(connection?: Connection): Promise { return await query(this.build(), this.variables, connection); } public async get(connection?: Connection): Promise> { const queryResult = await this.execute(connection); const models: ModelQueryResult = []; models.originalData = []; if (this._pivot) models.pivot = []; // Eager loading init const relationMap: { [p: string]: ModelRelation[] } = {}; for (const relation of this.relations) { relationMap[relation] = []; } for (const result of queryResult.results) { const modelData: any = {}; for (const field of Object.keys(result)) { modelData[field.split('.')[1] || field] = result[field]; } const model = this.factory.create(modelData, false); models.push(model); models.originalData.push(modelData); if (this._pivot) { const pivotData: any = {}; for (const field of this._pivot) { pivotData[field] = result[field.split('.')[1]]; } models.pivot!.push(pivotData); } // Eager loading init map for (const relation of this.relations) { if (model[relation] === undefined) throw new Error(`Relation ${relation} doesn't exist on ${model.constructor.name}.`); relationMap[relation].push(model[relation]); } } // Eager loading execute for (const relationName of this.relations) { const relations = relationMap[relationName]; if (relations.length > 0) { const allModels = await relations[0].eagerLoad(relations, this.subRelations[relationName]); await Promise.all(relations.map(r => r.populate(allModels))); } } return models; } public async paginate(page: number, perPage: number, connection?: Connection): Promise> { this.limit(perPage, (page - 1) * perPage); const result = await this.get(connection); result.pagination = new Pagination(result, page, perPage, await this.count(true, connection)); return result; } public async first(): Promise { const models = await this.limit(1).get(); return models.length > 0 ? models[0] : null; } public async count(removeLimit: boolean = false, connection?: Connection): Promise { if (removeLimit) { this._limit = undefined; this._offset = undefined; } this._sortBy = undefined; this._sortDirection = undefined; this.fields.splice(0, this.fields.length); this.fields.push(new SelectFieldValue('_count', 'COUNT(*)', true)); let queryResult = await this.execute(connection); return queryResult.results[0]['_count']; } } function inputToFieldOrValue(input: string, addTable?: string): string { if (input.startsWith('`') || input.startsWith('"') || input.startsWith("'")) { return input; } let parts = input.split('.'); if (addTable && parts.length === 1) parts = [addTable, input]; // Add table disambiguation return parts.map(v => v === '*' ? v : `\`${v}\``).join('.'); } export interface ModelQueryResult extends Array { originalData?: any[]; pagination?: Pagination; pivot?: { [p: string]: any }[]; } export enum QueryType { SELECT, UPDATE, DELETE, } export enum WhereOperator { AND = 'AND', OR = 'OR', } export enum WhereTest { EQ = '=', NE = '!=', GT = '>', GE = '>=', LT = '<', LE = '<=', IN = ' IN ', } class FieldValue { protected readonly field: string; protected value: any; protected raw: boolean; constructor(field: string, value: any, raw: boolean) { this.field = field; this.value = value; this.raw = raw; } public toString(first: boolean = true): string { const valueStr = (this.raw || this.value === null || this.value instanceof ModelQuery) ? this.value : (Array.isArray(this.value) ? `(${'?'.repeat(this.value.length).split('').join(',')})` : '?'); let field = inputToFieldOrValue(this.field); return `${first ? '' : ','}${field}${this.test}${valueStr}`; } protected get test(): string { return '='; } public get variables(): any[] { if (this.value instanceof ModelQuery) return this.value.variables; if (this.raw || this.value === null) return []; if (Array.isArray(this.value)) return this.value; return [this.value]; } } export class SelectFieldValue extends FieldValue { public toString(first: boolean = true): string { return `(${this.value instanceof ModelQuery ? this.value : (this.raw ? this.value : '?')}) AS \`${this.field}\``; } } class UpdateFieldValue extends FieldValue { } class WhereFieldValue extends FieldValue { private readonly _test: WhereTest; private readonly operator: WhereOperator; constructor(field: string, value: any, raw: boolean, test: WhereTest, operator: WhereOperator) { super(field, value, raw); this._test = test; this.operator = operator; } public toString(first: boolean = true): string { return (!first ? ` ${this.operator} ` : '') + super.toString(true); } protected get test(): string { if (this.value === null) { if (this._test === WhereTest.EQ) { return ' IS '; } else if (this._test === WhereTest.NE) { return ' IS NOT '; } } return this._test; } } class WhereFieldValueGroup { public readonly fields: (WhereFieldValue | WhereFieldValueGroup)[]; public readonly operator: WhereOperator; public constructor(fields: (WhereFieldValue | WhereFieldValueGroup)[], operator: WhereOperator) { this.fields = fields; this.operator = operator; } public toString(first: boolean = true): string { let str = `${first ? '' : ` ${this.operator} `}(`; let firstField = true; for (const field of this.fields) { str += field.toString(firstField); firstField = false; } str += ')'; return str; } } interface WhereFieldConsumer { where(field: string, value: string | Date | ModelQuery | any, test?: WhereTest, operator?: WhereOperator): this; groupWhere(setter: (query: WhereFieldConsumer) => void, operator?: WhereOperator): this; } export type SelectFields = (string | SelectFieldValue | UpdateFieldValue)[]; export type SortDirection = 'ASC' | 'DESC'; type ModelQueryUnion = { query: ModelQuery, sortBy: string, direction: SortDirection, limit?: number, };