Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 | import { BaseModel } from '../models/BaseModel';
import { QueryCondition, SortConfig } from '../types/queries';
import { QueryExecutor } from './QueryExecutor';
export class QueryBuilder<T extends BaseModel> {
private model: typeof BaseModel;
private conditions: QueryCondition[] = [];
private relations: string[] = [];
private sorting: SortConfig[] = [];
private limitation?: number;
private offsetValue?: number;
private groupByFields: string[] = [];
private havingConditions: QueryCondition[] = [];
private distinctFields: string[] = [];
constructor(model: typeof BaseModel) {
this.model = model;
}
// Basic filtering
where(field: string, operator: string, value: any): this {
this.conditions.push({ field, operator, value });
return this;
}
whereIn(field: string, values: any[]): this {
return this.where(field, 'in', values);
}
whereNotIn(field: string, values: any[]): this {
return this.where(field, 'not_in', values);
}
whereNull(field: string): this {
return this.where(field, 'is_null', null);
}
whereNotNull(field: string): this {
return this.where(field, 'is_not_null', null);
}
whereBetween(field: string, min: any, max: any): this {
return this.where(field, 'between', [min, max]);
}
whereNot(field: string, operator: string, value: any): this {
return this.where(field, `not_${operator}`, value);
}
whereLike(field: string, pattern: string): this {
return this.where(field, 'like', pattern);
}
whereILike(field: string, pattern: string): this {
return this.where(field, 'ilike', pattern);
}
// Date filtering
whereDate(field: string, operator: string, date: Date | string | number): this {
return this.where(field, `date_${operator}`, date);
}
whereDateBetween(
field: string,
startDate: Date | string | number,
endDate: Date | string | number,
): this {
return this.where(field, 'date_between', [startDate, endDate]);
}
whereYear(field: string, year: number): this {
return this.where(field, 'year', year);
}
whereMonth(field: string, month: number): this {
return this.where(field, 'month', month);
}
whereDay(field: string, day: number): this {
return this.where(field, 'day', day);
}
// User-specific filtering (for user-scoped queries)
whereUser(userId: string): this {
return this.where('userId', '=', userId);
}
whereUserIn(userIds: string[]): this {
this.conditions.push({
field: 'userId',
operator: 'userIn',
value: userIds,
});
return this;
}
// Advanced filtering with OR conditions
orWhere(callback: (query: QueryBuilder<T>) => void): this {
const subQuery = new QueryBuilder<T>(this.model);
callback(subQuery);
this.conditions.push({
field: '__or__',
operator: 'or',
value: subQuery.getConditions(),
});
return this;
}
// Array and object field queries
whereArrayContains(field: string, value: any): this {
return this.where(field, 'array_contains', value);
}
whereArrayLength(field: string, operator: string, length: number): this {
return this.where(field, `array_length_${operator}`, length);
}
whereObjectHasKey(field: string, key: string): this {
return this.where(field, 'object_has_key', key);
}
whereObjectPath(field: string, path: string, operator: string, value: any): this {
return this.where(field, `object_path_${operator}`, { path, value });
}
// Sorting
orderBy(field: string, direction: 'asc' | 'desc' = 'asc'): this {
this.sorting.push({ field, direction });
return this;
}
orderByDesc(field: string): this {
return this.orderBy(field, 'desc');
}
orderByRaw(expression: string): this {
this.sorting.push({ field: expression, direction: 'asc' });
return this;
}
// Multiple field sorting
orderByMultiple(sorts: Array<{ field: string; direction: 'asc' | 'desc' }>): this {
sorts.forEach((sort) => this.orderBy(sort.field, sort.direction));
return this;
}
// Pagination
limit(count: number): this {
this.limitation = count;
return this;
}
offset(count: number): this {
this.offsetValue = count;
return this;
}
skip(count: number): this {
return this.offset(count);
}
take(count: number): this {
return this.limit(count);
}
// Pagination helpers
page(pageNumber: number, pageSize: number): this {
this.limitation = pageSize;
this.offsetValue = (pageNumber - 1) * pageSize;
return this;
}
// Relationship loading
load(relationships: string[]): this {
this.relations = [...this.relations, ...relationships];
return this;
}
with(relationships: string[]): this {
return this.load(relationships);
}
loadNested(relationship: string, _callback: (query: QueryBuilder<any>) => void): this {
// For nested relationship loading with constraints
this.relations.push(relationship);
// Store callback for nested query (implementation in QueryExecutor)
return this;
}
// Aggregation
groupBy(...fields: string[]): this {
this.groupByFields.push(...fields);
return this;
}
having(field: string, operator: string, value: any): this {
this.havingConditions.push({ field, operator, value });
return this;
}
// Distinct
distinct(...fields: string[]): this {
this.distinctFields.push(...fields);
return this;
}
// Execution methods
async exec(): Promise<T[]> {
const executor = new QueryExecutor<T>(this.model, this);
return await executor.execute();
}
async get(): Promise<T[]> {
return await this.exec();
}
async first(): Promise<T | null> {
const results = await this.limit(1).exec();
return results[0] || null;
}
async firstOrFail(): Promise<T> {
const result = await this.first();
if (!result) {
throw new Error(`No ${this.model.name} found matching the query`);
}
return result;
}
async find(id: string): Promise<T | null> {
return await this.where('id', '=', id).first();
}
async findOrFail(id: string): Promise<T> {
const result = await this.find(id);
if (!result) {
throw new Error(`${this.model.name} with id ${id} not found`);
}
return result;
}
async count(): Promise<number> {
const executor = new QueryExecutor<T>(this.model, this);
return await executor.count();
}
async exists(): Promise<boolean> {
const count = await this.count();
return count > 0;
}
async sum(field: string): Promise<number> {
const executor = new QueryExecutor<T>(this.model, this);
return await executor.sum(field);
}
async avg(field: string): Promise<number> {
const executor = new QueryExecutor<T>(this.model, this);
return await executor.avg(field);
}
async min(field: string): Promise<any> {
const executor = new QueryExecutor<T>(this.model, this);
return await executor.min(field);
}
async max(field: string): Promise<any> {
const executor = new QueryExecutor<T>(this.model, this);
return await executor.max(field);
}
// Pagination with metadata
async paginate(
page: number = 1,
perPage: number = 15,
): Promise<{
data: T[];
total: number;
perPage: number;
currentPage: number;
lastPage: number;
hasNextPage: boolean;
hasPrevPage: boolean;
}> {
const total = await this.count();
const lastPage = Math.ceil(total / perPage);
const data = await this.page(page, perPage).exec();
return {
data,
total,
perPage,
currentPage: page,
lastPage,
hasNextPage: page < lastPage,
hasPrevPage: page > 1,
};
}
// Chunked processing
async chunk(
size: number,
callback: (items: T[], page: number) => Promise<void | boolean>,
): Promise<void> {
let page = 1;
let hasMore = true;
while (hasMore) {
const items = await this.page(page, size).exec();
if (items.length === 0) {
break;
}
const result = await callback(items, page);
// If callback returns false, stop processing
if (result === false) {
break;
}
hasMore = items.length === size;
page++;
}
}
// Query optimization hints
useIndex(indexName: string): this {
// Hint for query optimizer (implementation in QueryExecutor)
(this as any)._indexHint = indexName;
return this;
}
preferShard(shardIndex: number): this {
// Force query to specific shard (for global sharded models)
(this as any)._preferredShard = shardIndex;
return this;
}
// Raw queries (for advanced users)
whereRaw(expression: string, bindings: any[] = []): this {
this.conditions.push({
field: '__raw__',
operator: 'raw',
value: { expression, bindings },
});
return this;
}
// Getters for query configuration (used by QueryExecutor)
getConditions(): QueryCondition[] {
return [...this.conditions];
}
getRelations(): string[] {
return [...this.relations];
}
getSorting(): SortConfig[] {
return [...this.sorting];
}
getLimit(): number | undefined {
return this.limitation;
}
getOffset(): number | undefined {
return this.offsetValue;
}
getGroupBy(): string[] {
return [...this.groupByFields];
}
getHaving(): QueryCondition[] {
return [...this.havingConditions];
}
getDistinct(): string[] {
return [...this.distinctFields];
}
getModel(): typeof BaseModel {
return this.model;
}
// Clone query for reuse
clone(): QueryBuilder<T> {
const cloned = new QueryBuilder<T>(this.model);
cloned.conditions = [...this.conditions];
cloned.relations = [...this.relations];
cloned.sorting = [...this.sorting];
cloned.limitation = this.limitation;
cloned.offsetValue = this.offsetValue;
cloned.groupByFields = [...this.groupByFields];
cloned.havingConditions = [...this.havingConditions];
cloned.distinctFields = [...this.distinctFields];
return cloned;
}
// Debug methods
toSQL(): string {
// Generate SQL-like representation for debugging
let sql = `SELECT * FROM ${this.model.name}`;
if (this.conditions.length > 0) {
const whereClause = this.conditions
.map((c) => `${c.field} ${c.operator} ${JSON.stringify(c.value)}`)
.join(' AND ');
sql += ` WHERE ${whereClause}`;
}
if (this.sorting.length > 0) {
const orderClause = this.sorting
.map((s) => `${s.field} ${s.direction.toUpperCase()}`)
.join(', ');
sql += ` ORDER BY ${orderClause}`;
}
if (this.limitation) {
sql += ` LIMIT ${this.limitation}`;
}
if (this.offsetValue) {
sql += ` OFFSET ${this.offsetValue}`;
}
return sql;
}
explain(): any {
return {
model: this.model.name,
scope: this.model.scope,
conditions: this.conditions,
relations: this.relations,
sorting: this.sorting,
limit: this.limitation,
offset: this.offsetValue,
sql: this.toSQL(),
};
}
}
|