| 36 | | abstract class Grammar |
| 37 | | { |
| 38 | | use NormalizesInsertRows; |
| 39 | | use QuotesLiterals; |
| 40 | | use ConcatenatesStatements; |
| 41 | | |
| 42 | | |
| 43 | | |
| 44 | | |
| 45 | | |
| 46 | | |
| 47 | | |
| 48 | | abstract protected function wrap(string $value): string; |
| 49 | | |
| 50 | | |
| 51 | | |
| 52 | | |
| 53 | | |
| 54 | | |
| 55 | | |
| 56 | | |
| 57 | | |
| 58 | | |
| 59 | | |
| 60 | | |
| 61 | | protected function wrapSegments(string|Expression $value): string |
| 62 | | { |
| 63 | | if ($value instanceof Expression) { |
| 64 | | return $value->value; |
| 65 | | } |
| 66 | | return implode('.', array_map( |
| 67 | | fn($segment) => $segment === '*' ? '*' : $this->wrap($segment), |
| 68 | | explode('.', $value) |
| 69 | | )); |
| 70 | | } |
| 71 | | |
| 72 | | |
| 73 | | |
| 74 | | |
| 75 | | |
| 76 | | |
| 77 | | |
| 78 | | protected function wrapTable(string|Expression $table): string |
| 79 | | { |
| 80 | | if ($table instanceof Expression) { |
| 81 | | return $table->value; |
| 82 | | } |
| 83 | | if (preg_match('/^(.+?)(?:\s+as\s+)(.+)$/i', $table, $m)) { |
| 84 | | return $this->wrapSegments($m[1]) . ' AS ' . $this->wrapSegments($m[2]); |
| 85 | | } |
| 86 | | return $this->wrapSegments($table); |
| 87 | | } |
| 88 | | |
| 89 | | |
| 90 | | |
| 91 | | |
| 92 | | |
| 93 | | |
| 94 | | |
| 95 | | |
| 96 | | |
| 97 | | |
| 98 | | |
| 99 | | protected function wrapColumn(string|Expression|Aggregate|SubquerySelect $column): string |
| 100 | | { |
| 101 | | if ($column instanceof Expression) { |
| 102 | | return $column->value; |
| 103 | | } |
| 104 | | |
| 105 | | if ($column instanceof SubquerySelect) { |
| 106 | | return '(' . $this->compileSelect($column->query) . ') AS ' |
| 107 | | . $this->wrapSegments($column->alias); |
| 108 | | } |
| 109 | | |
| 110 | | if ($column instanceof Aggregate) { |
| 111 | | $rendered = $column->function . '(' . $this->wrapAggregateInner($column->column) . ')'; |
| 112 | | |
| 113 | | |
| 114 | | |
| 115 | | return $column->alias === null |
| 116 | | ? $rendered |
| 117 | | : $rendered . ' AS ' . $this->wrapSegments($column->alias); |
| 118 | | } |
| 119 | | |
| 120 | | if (preg_match('/^(.+?)(?:\s+as\s+)(.+)$/i', $column, $m)) { |
| 121 | | return $this->wrapSegments($m[1]) . ' AS ' . $this->wrapSegments($m[2]); |
| 122 | | } |
| 123 | | |
| 124 | | return $this->wrapSegments($column); |
| 125 | | } |
| 126 | | |
| 127 | | |
| 128 | | |
| 129 | | |
| 130 | | |
| 131 | | |
| 132 | | |
| 133 | | |
| 134 | | |
| 135 | | |
| 136 | | |
| 137 | | |
| 138 | | |
| 139 | | protected function wrapAggregateInner(string|Expression $inner): string |
| 140 | | { |
| 141 | | if ($inner instanceof Expression) { |
| 142 | | return $inner->value; |
| 143 | | } |
| 144 | | if (preg_match('/^distinct\s+(.+)$/i', $inner, $m)) { |
| 145 | | return 'DISTINCT ' . $this->wrapSegments($m[1]); |
| 146 | | } |
| 147 | | if ($inner === '*') { |
| 148 | | return '*'; |
| 149 | | } |
| 150 | | |
| 151 | | |
| 152 | | |
| 153 | | |
| 154 | | if (preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z_][a-zA-Z0-9_]*|\.\*)?$/', $inner) !== 1) { |
| 155 | | throw new UnsupportedFeatureException( |
| 156 | | 'Aggregate arguments support only a single column (optionally schema-qualified ' |
| 157 | | . "or `distinct col`); got [{$inner}]. Use a raw Expression for complex arguments.", |
| 158 | | ); |
| 159 | | } |
| 160 | | |
| 161 | | return $this->wrapSegments($inner); |
| 162 | | } |
| 163 | | |
| 164 | | |
| 165 | | |
| 166 | | |
| 167 | | |
| 168 | | |
| 169 | | |
| 170 | | protected function columnize(array $columns): string |
| 171 | | { |
| 172 | | return implode(', ', array_map(fn($column) => $this->wrapColumn($column), $columns)); |
| 173 | | } |
| 174 | | |
| 175 | | |
| 176 | | |
| 177 | | |
| 178 | | |
| 179 | | |
| 180 | | |
| 181 | | |
| 182 | | |
| 183 | | |
| 184 | | |
| 185 | | |
| 186 | | protected function parameter(mixed $value): string |
| 187 | | { |
| 188 | | if ($value instanceof Expression) { |
| 189 | | return $value->value; |
| 190 | | } |
| 191 | | if ($value instanceof ToSqlValue) { |
| 192 | | return $this->quoteLiteral($value->toSqlValue()); |
| 193 | | } |
| 194 | | return '?'; |
| 195 | | } |
| 196 | | |
| 197 | | |
| 198 | | |
| 199 | | |
| 200 | | |
| 201 | | |
| 202 | | |
| 203 | | protected function parameterize(array $values): string |
| 204 | | { |
| 205 | | return implode(', ', array_map(fn($value) => $this->parameter($value), $values)); |
| 206 | | } |
| 207 | | |
| 208 | | |
| 209 | | |
| 210 | | |
| 211 | | |
| 212 | | |
| 213 | | |
| 214 | | |
| 215 | | |
| 216 | | |
| 217 | | |
| 218 | | final public function compileSelect(QueryBuilder $builder): string |
| 219 | | { |
| 220 | | $sql = $this->concatenate([ |
| 221 | | 'SELECT', |
| 222 | | $builder->isDistinct() ? 'DISTINCT' : '', |
| 223 | | $this->compileColumns($builder), |
| 224 | | 'FROM', |
| 225 | | $this->compileFrom($builder), |
| 226 | | $this->compileJoins($builder), |
| 227 | | $this->compileWheres($builder), |
| 228 | | $this->compileGroups($builder), |
| 229 | | $this->compileHavings($builder), |
| 230 | | $this->compileOrders($builder), |
| 231 | | $this->compileLimit($builder), |
| 232 | | $this->compileOffset($builder), |
| 233 | | $this->compileLock($builder), |
| 234 | | ]); |
| 235 | | |
| 236 | | return $this->compileUnions($builder, $sql); |
| 237 | | } |
| 238 | | |
| 239 | | |
| 240 | | |
| 241 | | |
| 242 | | |
| 243 | | |
| 244 | | |
| 245 | | |
| 246 | | |
| 247 | | |
| 248 | | |
| 249 | | final public function compileInsert(QueryBuilder $builder, array $values, ?string $pk = null): string |
| 250 | | { |
| 251 | | $rows = $this->normalizeInsertRows($values); |
| 252 | | |
| 253 | | |
| 254 | | |
| 255 | | |
| 256 | | $this->assertUniformInsertRows($rows); |
| 257 | | |
| 258 | | |
| 259 | | |
| 260 | | |
| 261 | | |
| 262 | | |
| 263 | | |
| 264 | | if (isset($rows[0]) && $rows[0] === []) { |
| 265 | | return $this->withReturning( |
| 266 | | $this->compileEmptyInsert($builder), |
| 267 | | $pk, |
| 268 | | ); |
| 269 | | } |
| 270 | | |
| 271 | | $columns = implode(', ', array_map(fn($column) => $this->wrapSegments($column), array_keys($rows[0]))); |
| 272 | | $placeholders = implode(', ', array_map( |
| 273 | | fn($row) => '(' . implode(', ', array_fill(0, count($row), '?')) . ')', |
| 274 | | $rows |
| 275 | | )); |
| 276 | | $sql = "INSERT INTO {$this->wrapFromTable($builder)} ({$columns}) VALUES {$placeholders}"; |
| 277 | | |
| 278 | | return $this->withReturning($sql, $pk); |
| 279 | | } |
| 280 | | |
| 281 | | |
| 282 | | |
| 283 | | |
| 284 | | |
| 285 | | |
| 286 | | |
| 287 | | |
| 288 | | |
| 289 | | |
| 290 | | |
| 291 | | protected function compileEmptyInsert(QueryBuilder $builder): string |
| 292 | | { |
| 293 | | return "INSERT INTO {$this->wrapFromTable($builder)} DEFAULT VALUES"; |
| 294 | | } |
| 295 | | |
| 296 | | |
| 297 | | |
| 298 | | |
| 299 | | |
| 300 | | |
| 301 | | protected function usesReturning(): bool |
| 302 | | { |
| 303 | | return false; |
| 304 | | } |
| 305 | | |
| 306 | | |
| 307 | | |
| 308 | | |
| 309 | | |
| 310 | | |
| 311 | | |
| 312 | | |
| 313 | | |
| 314 | | protected function withReturning(string $sql, ?string $pk): string |
| 315 | | { |
| 316 | | if ($pk !== null && $this->usesReturning()) { |
| 317 | | return $sql . ' RETURNING ' . $this->wrapSegments($pk); |
| 318 | | } |
| 319 | | |
| 320 | | return $sql; |
| 321 | | } |
| 322 | | |
| 323 | | |
| 324 | | |
| 325 | | |
| 326 | | |
| 327 | | |
| 328 | | |
| 329 | | |
| 330 | | |
| 331 | | |
| 332 | | |
| 333 | | |
| 334 | | final public function compileInsertForId(QueryBuilder $builder, array $values, string $pk): array |
| 335 | | { |
| 336 | | return [ |
| 337 | | 'sql' => $this->compileInsert($builder, $values, $pk), |
| 338 | | 'returnsKey' => $this->usesReturning(), |
| 339 | | ]; |
| 340 | | } |
| 341 | | |
| 342 | | |
| 343 | | |
| 344 | | |
| 345 | | |
| 346 | | |
| 347 | | |
| 348 | | |
| 349 | | |
| 350 | | |
| 351 | | final public function compileUpdate(QueryBuilder $builder, array $values): string |
| 352 | | { |
| 353 | | $sets = implode(', ', array_map( |
| 354 | | fn($column) => $this->wrapSegments($column) . ' = ?', |
| 355 | | array_keys($values) |
| 356 | | )); |
| 357 | | $sql = "UPDATE {$this->wrapFromTable($builder)} SET {$sets}"; |
| 358 | | $wheres = $this->compileWheres($builder); |
| 359 | | if ($wheres !== '') { |
| 360 | | $sql .= ' ' . $wheres; |
| 361 | | } |
| 362 | | return $sql; |
| 363 | | } |
| 364 | | |
| 365 | | |
| 366 | | |
| 367 | | |
| 368 | | |
| 369 | | |
| 370 | | |
| 371 | | |
| 372 | | |
| 373 | | final public function compileDelete(QueryBuilder $builder): string |
| 374 | | { |
| 375 | | $sql = "DELETE FROM {$this->wrapFromTable($builder)}"; |
| 376 | | $wheres = $this->compileWheres($builder); |
| 377 | | if ($wheres !== '') { |
| 378 | | $sql .= ' ' . $wheres; |
| 379 | | } |
| 380 | | return $sql; |
| 381 | | } |
| 382 | | |
| 383 | | |
| 384 | | |
| 385 | | |
| 386 | | |
| 387 | | |
| 388 | | |
| 389 | | |
| 390 | | |
| 391 | | protected function compileColumns(QueryBuilder $builder): string |
| 392 | | { |
| 393 | | $columns = $builder->getColumns(); |
| 394 | | if ($columns === ['*']) { |
| 395 | | return '*'; |
| 396 | | } |
| 397 | | return $this->columnize($columns); |
| 398 | | } |
| 399 | | |
| 400 | | |
| 401 | | |
| 402 | | |
| 403 | | |
| 404 | | |
| 405 | | |
| 406 | | protected function compileFrom(QueryBuilder $builder): string |
| 407 | | { |
| 408 | | $from = $builder->getFrom(); |
| 409 | | if ($from instanceof QueryBuilder) { |
| 410 | | $alias = $builder->getFromAlias(); |
| 411 | | $subSql = $this->compileSelect($from); |
| 412 | | return '(' . $subSql . ') AS ' . $this->wrapSegments($alias ?? ''); |
| 413 | | } |
| 414 | | return $this->wrapTable($from); |
| 415 | | } |
| 416 | | |
| 417 | | |
| 418 | | |
| 419 | | |
| 420 | | |
| 421 | | |
| 422 | | |
| 423 | | protected function compileJoins(QueryBuilder $builder): string |
| 424 | | { |
| 425 | | $segments = []; |
| 426 | | foreach ($builder->getJoins() as $join) { |
| 427 | | $keyword = match ($join['type']) { |
| 428 | | JoinType::Inner => 'INNER JOIN', |
| 429 | | JoinType::Left => 'LEFT JOIN', |
| 430 | | JoinType::Right => 'RIGHT JOIN', |
| 431 | | JoinType::Cross => 'CROSS JOIN', |
| 432 | | }; |
| 433 | | $on = $this->compileJoinWheres($join['wheres']); |
| 434 | | $segments[] = $keyword . ' ' . $this->wrapTable($join['table']) . ($on !== '' ? ' ON ' . $on : ''); |
| 435 | | } |
| 436 | | return implode(' ', $segments); |
| 437 | | } |
| 438 | | |
| 439 | | |
| 440 | | |
| 441 | | |
| 442 | | |
| 443 | | |
| 444 | | |
| 445 | | protected function compileJoinWheres(array $wheres): string |
| 446 | | { |
| 447 | | $segments = []; |
| 448 | | foreach ($wheres as $i => $where) { |
| 449 | | $boolean = $i === 0 ? '' : strtoupper($where['boolean']->value) . ' '; |
| 450 | | $segments[] = $boolean . $this->wrapSegments($where['first']) . ' ' . $where['operator']->value . ' ' . $this->wrapSegments($where['second']); |
| 451 | | } |
| 452 | | return implode(' ', $segments); |
| 453 | | } |
| 454 | | |
| 455 | | |
| 456 | | |
| 457 | | |
| 458 | | |
| 459 | | |
| 460 | | |
| 461 | | protected function compileWheres(QueryBuilder $builder): string |
| 462 | | { |
| 463 | | $wheres = $builder->getWheres(); |
| 464 | | if ($wheres === []) { |
| 465 | | return ''; |
| 466 | | } |
| 467 | | return 'WHERE ' . $this->compileWhereGroup($wheres); |
| 468 | | } |
| 469 | | |
| 470 | | |
| 471 | | |
| 472 | | |
| 473 | | |
| 474 | | |
| 475 | | |
| 476 | | protected function compileWhereGroup(array $wheres): string |
| 477 | | { |
| 478 | | $segments = []; |
| 479 | | foreach ($wheres as $i => $where) { |
| 480 | | $boolean = $i === 0 ? '' : strtoupper($where['boolean']->value) . ' '; |
| 481 | | $segments[] = $boolean . $this->compileWhere($where); |
| 482 | | } |
| 483 | | return implode(' ', $segments); |
| 484 | | } |
| 485 | | |
| 486 | | |
| 487 | | |
| 488 | | |
| 489 | | |
| 490 | | |
| 491 | | |
| 492 | | protected function compileWhere(array $where): string |
| 493 | | { |
| 494 | | return match ($where['type']) { |
| 495 | | WhereType::Basic => $this->compileBasicWhere($where), |
| 496 | | WhereType::Between => $this->compileBetweenWhere($where), |
| 497 | | WhereType::Null => $this->compileNullWhere($where), |
| 498 | | WhereType::Raw => $where['sql'], |
| 499 | | WhereType::Column => $this->wrapSegments($where['first']) . ' ' . $where['operator']->value . ' ' . $this->wrapSegments($where['second']), |
| 500 | | WhereType::Nested => '(' . $this->compileWhereGroup($where['group']->wheres) . ')', |
| 501 | | WhereType::Exists => ($where['negated'] ? 'NOT ' : '') |
| 502 | | . 'EXISTS (' . $this->compileSelect($where['query']) . ')', |
| 503 | | WhereType::InSub => $this->wrapSegments($where['column']) |
| 504 | | . ($where['negated'] ? ' NOT' : '') . ' IN (' |
| 505 | | . $this->compileSelect($where['query']) . ')', |
| 506 | | }; |
| 507 | | } |
| 508 | | |
| 509 | | |
| 510 | | |
| 511 | | |
| 512 | | |
| 513 | | |
| 514 | | |
| 515 | | protected function compileBasicWhere(array $where): string |
| 516 | | { |
| 517 | | $column = $this->wrapSegments($where['column']); |
| 518 | | $operator = $where['operator']; |
| 519 | | return match ($operator) { |
| 520 | | WhereOperator::Null => "{$column} IS NULL", |
| 521 | | WhereOperator::NotNull => "{$column} IS NOT NULL", |
| 522 | | WhereOperator::In => "{$column} IN (" . $this->parameterize($where['value']) . ')', |
| 523 | | WhereOperator::NotIn => "{$column} NOT IN (" . $this->parameterize($where['value']) . ')', |
| 524 | | WhereOperator::Between => "{$column} BETWEEN " . $this->parameterize($where['value']), |
| 525 | | WhereOperator::NotBetween => "{$column} NOT BETWEEN " . $this->parameterize($where['value']), |
| 526 | | WhereOperator::Eq, WhereOperator::NotEq, WhereOperator::Lt, WhereOperator::LtEq, |
| 527 | | WhereOperator::Gt, WhereOperator::GtEq, WhereOperator::Like, WhereOperator::NotLike, |
| 528 | | WhereOperator::Is, WhereOperator::IsNot => "{$column} {$operator->value} " . $this->parameter($where['value']), |
| 529 | | }; |
| 530 | | } |
| 531 | | |
| 532 | | |
| 533 | | |
| 534 | | |
| 535 | | |
| 536 | | |
| 537 | | |
| 538 | | protected function compileBetweenWhere(array $where): string |
| 539 | | { |
| 540 | | $column = $this->wrapSegments($where['column']); |
| 541 | | $operator = $where['operator']; |
| 542 | | return "{$column} {$operator->value} " . $this->parameter($where['value'][0]) . ' AND ' . $this->parameter($where['value'][1]); |
| 543 | | } |
| 544 | | |
| 545 | | |
| 546 | | |
| 547 | | |
| 548 | | |
| 549 | | |
| 550 | | |
| 551 | | protected function compileNullWhere(array $where): string |
| 552 | | { |
| 553 | | $column = $this->wrapSegments($where['column']); |
| 554 | | $operator = $where['operator']; |
| 555 | | return "{$column} IS {$operator->value}"; |
| 556 | | } |
| 557 | | |
| 558 | | |
| 559 | | |
| 560 | | |
| 561 | | |
| 562 | | |
| 563 | | |
| 564 | | protected function compileGroups(QueryBuilder $builder): string |
| 565 | | { |
| 566 | | $groups = $builder->getGroups(); |
| 567 | | if ($groups === []) { |
| 568 | | return ''; |
| 569 | | } |
| 570 | | return 'GROUP BY ' . implode(', ', array_map(fn($group) => $this->wrapSegments($group), $groups)); |
| 571 | | } |
| 572 | | |
| 573 | | |
| 574 | | |
| 575 | | |
| 576 | | |
| 577 | | |
| 578 | | |
| 579 | | protected function compileHavings(QueryBuilder $builder): string |
| 580 | | { |
| 581 | | $havings = $builder->getHavings(); |
| 582 | | if ($havings === []) { |
| 583 | | return ''; |
| 584 | | } |
| 585 | | $segments = []; |
| 586 | | foreach ($havings as $i => $having) { |
| 587 | | $boolean = $i === 0 ? '' : 'AND '; |
| 588 | | $column = $this->wrapColumn($having['column']); |
| 589 | | $segments[] = $boolean . $column . ' ' . $having['operator']->value . ' ' . $this->parameter($having['value']); |
| 590 | | } |
| 591 | | return 'HAVING ' . implode(' ', $segments); |
| 592 | | } |
| 593 | | |
| 594 | | |
| 595 | | |
| 596 | | |
| 597 | | |
| 598 | | |
| 599 | | |
| 600 | | protected function compileOrders(QueryBuilder $builder): string |
| 601 | | { |
| 602 | | $orders = $builder->getOrders(); |
| 603 | | if ($orders === []) { |
| 604 | | return ''; |
| 605 | | } |
| 606 | | $segments = []; |
| 607 | | foreach ($orders as $order) { |
| 608 | | $column = $this->wrapColumn($order['column']); |
| 609 | | $segments[] = $order['direction'] !== null ? $column . ' ' . $order['direction']->value : $column; |
| 610 | | } |
| 611 | | return 'ORDER BY ' . implode(', ', $segments); |
| 612 | | } |
| 613 | | |
| 614 | | |
| 615 | | |
| 616 | | |
| 617 | | |
| 618 | | |
| 619 | | |
| 620 | | protected function compileLimit(QueryBuilder $builder): string |
| 621 | | { |
| 622 | | return $builder->getLimit() !== null ? 'LIMIT ' . $builder->getLimit() : ''; |
| 623 | | } |
| 624 | | |
| 625 | | |
| 626 | | |
| 627 | | |
| 628 | | |
| 629 | | |
| 630 | | |
| 631 | | protected function compileOffset(QueryBuilder $builder): string |
| 632 | | { |
| 633 | | return $builder->getOffset() !== null ? 'OFFSET ' . $builder->getOffset() : ''; |
| 634 | | } |
| 635 | | |
| 636 | | |
| 637 | | |
| 638 | | |
| 639 | | |
| 640 | | |
| 641 | | |
| 642 | | |
| 643 | | |
| 644 | | |
| 645 | | |
| 646 | | |
| 647 | | protected function compileLock(QueryBuilder $builder): string |
| 648 | | { |
| 649 | | if ($builder->getLock() === null) { |
| 650 | | return ''; |
| 651 | | } |
| 652 | | throw new UnsupportedFeatureException('This dialect does not support row locks.'); |
| 653 | | } |
| 654 | | |
| 655 | | |
| 656 | | |
| 657 | | |
| 658 | | |
| 659 | | |
| 660 | | |
| 661 | | |
| 662 | | protected function compileUnions(QueryBuilder $builder, string $sql): string |
| 663 | | { |
| 664 | | foreach ($builder->getUnions() as $union) { |
| 665 | | $keyword = $union['all'] ? 'UNION ALL' : 'UNION'; |
| 666 | | $sub = $union['query']; |
| 667 | | $unionSql = $this->compileSelect($sub); |
| 668 | | $sql .= ' ' . $keyword . ' (' . $unionSql . ')'; |
| 669 | | } |
| 670 | | return $sql; |
| 671 | | } |
| 672 | | |
| 673 | | |
| 674 | | |
| 675 | | |
| 676 | | |
| 677 | | |
| 678 | | |
| 679 | | |
| 680 | | protected function wrapFromTable(QueryBuilder $builder): string |
| 681 | | { |
| 682 | | $from = $builder->getFrom(); |
| 683 | | if ($from instanceof QueryBuilder) { |
| 684 | | throw new UnsupportedFeatureException('Insert/update/delete cannot target a subquery.'); |
| 685 | | } |
| 686 | | return $this->wrapTable($from); |
| 687 | | } |
| 688 | | } |