| Total Complexity | 386 |
| Total Lines | 3571 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like AbstractPlatform often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use AbstractPlatform, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 66 | abstract class AbstractPlatform |
||
| 67 | { |
||
| 68 | public const CREATE_INDEXES = 1; |
||
| 69 | |||
| 70 | public const CREATE_FOREIGNKEYS = 2; |
||
| 71 | |||
| 72 | /** |
||
| 73 | * @deprecated Use DateIntervalUnit::INTERVAL_UNIT_SECOND. |
||
| 74 | */ |
||
| 75 | public const DATE_INTERVAL_UNIT_SECOND = DateIntervalUnit::SECOND; |
||
| 76 | |||
| 77 | /** |
||
| 78 | * @deprecated Use DateIntervalUnit::MINUTE. |
||
| 79 | */ |
||
| 80 | public const DATE_INTERVAL_UNIT_MINUTE = DateIntervalUnit::MINUTE; |
||
| 81 | |||
| 82 | /** |
||
| 83 | * @deprecated Use DateIntervalUnit::HOUR. |
||
| 84 | */ |
||
| 85 | public const DATE_INTERVAL_UNIT_HOUR = DateIntervalUnit::HOUR; |
||
| 86 | |||
| 87 | /** |
||
| 88 | * @deprecated Use DateIntervalUnit::DAY. |
||
| 89 | */ |
||
| 90 | public const DATE_INTERVAL_UNIT_DAY = DateIntervalUnit::DAY; |
||
| 91 | |||
| 92 | /** |
||
| 93 | * @deprecated Use DateIntervalUnit::WEEK. |
||
| 94 | */ |
||
| 95 | public const DATE_INTERVAL_UNIT_WEEK = DateIntervalUnit::WEEK; |
||
| 96 | |||
| 97 | /** |
||
| 98 | * @deprecated Use DateIntervalUnit::MONTH. |
||
| 99 | */ |
||
| 100 | public const DATE_INTERVAL_UNIT_MONTH = DateIntervalUnit::MONTH; |
||
| 101 | |||
| 102 | /** |
||
| 103 | * @deprecated Use DateIntervalUnit::QUARTER. |
||
| 104 | */ |
||
| 105 | public const DATE_INTERVAL_UNIT_QUARTER = DateIntervalUnit::QUARTER; |
||
| 106 | |||
| 107 | /** |
||
| 108 | * @deprecated Use DateIntervalUnit::QUARTER. |
||
| 109 | */ |
||
| 110 | public const DATE_INTERVAL_UNIT_YEAR = DateIntervalUnit::YEAR; |
||
| 111 | |||
| 112 | /** |
||
| 113 | * @deprecated Use TrimMode::UNSPECIFIED. |
||
| 114 | */ |
||
| 115 | public const TRIM_UNSPECIFIED = TrimMode::UNSPECIFIED; |
||
| 116 | |||
| 117 | /** |
||
| 118 | * @deprecated Use TrimMode::LEADING. |
||
| 119 | */ |
||
| 120 | public const TRIM_LEADING = TrimMode::LEADING; |
||
| 121 | |||
| 122 | /** |
||
| 123 | * @deprecated Use TrimMode::TRAILING. |
||
| 124 | */ |
||
| 125 | public const TRIM_TRAILING = TrimMode::TRAILING; |
||
| 126 | |||
| 127 | /** |
||
| 128 | * @deprecated Use TrimMode::BOTH. |
||
| 129 | */ |
||
| 130 | public const TRIM_BOTH = TrimMode::BOTH; |
||
| 131 | |||
| 132 | /** @var string[]|null */ |
||
| 133 | protected $doctrineTypeMapping = null; |
||
| 134 | |||
| 135 | /** |
||
| 136 | * Contains a list of all columns that should generate parseable column comments for type-detection |
||
| 137 | * in reverse engineering scenarios. |
||
| 138 | * |
||
| 139 | * @var string[]|null |
||
| 140 | */ |
||
| 141 | protected $doctrineTypeComments = null; |
||
| 142 | |||
| 143 | /** @var EventManager|null */ |
||
| 144 | protected $_eventManager; |
||
| 145 | |||
| 146 | /** |
||
| 147 | * Holds the KeywordList instance for the current platform. |
||
| 148 | * |
||
| 149 | * @var KeywordList|null |
||
| 150 | */ |
||
| 151 | protected $_keywords; |
||
| 152 | |||
| 153 | public function __construct() |
||
| 155 | } |
||
| 156 | |||
| 157 | /** |
||
| 158 | * Sets the EventManager used by the Platform. |
||
| 159 | * |
||
| 160 | * @return void |
||
| 161 | */ |
||
| 162 | public function setEventManager(EventManager $eventManager) |
||
| 163 | { |
||
| 164 | $this->_eventManager = $eventManager; |
||
| 165 | } |
||
| 166 | |||
| 167 | /** |
||
| 168 | * Gets the EventManager used by the Platform. |
||
| 169 | * |
||
| 170 | * @return EventManager|null |
||
| 171 | */ |
||
| 172 | public function getEventManager() |
||
| 175 | } |
||
| 176 | |||
| 177 | /** |
||
| 178 | * Returns the SQL snippet that declares a boolean column. |
||
| 179 | * |
||
| 180 | * @param mixed[] $columnDef |
||
| 181 | * |
||
| 182 | * @return string |
||
| 183 | */ |
||
| 184 | abstract public function getBooleanTypeDeclarationSQL(array $columnDef); |
||
| 185 | |||
| 186 | /** |
||
| 187 | * Returns the SQL snippet that declares a 4 byte integer column. |
||
| 188 | * |
||
| 189 | * @param mixed[] $columnDef |
||
| 190 | * |
||
| 191 | * @return string |
||
| 192 | */ |
||
| 193 | abstract public function getIntegerTypeDeclarationSQL(array $columnDef); |
||
| 194 | |||
| 195 | /** |
||
| 196 | * Returns the SQL snippet that declares an 8 byte integer column. |
||
| 197 | * |
||
| 198 | * @param mixed[] $columnDef |
||
| 199 | * |
||
| 200 | * @return string |
||
| 201 | */ |
||
| 202 | abstract public function getBigIntTypeDeclarationSQL(array $columnDef); |
||
| 203 | |||
| 204 | /** |
||
| 205 | * Returns the SQL snippet that declares a 2 byte integer column. |
||
| 206 | * |
||
| 207 | * @param mixed[] $columnDef |
||
| 208 | * |
||
| 209 | * @return string |
||
| 210 | */ |
||
| 211 | abstract public function getSmallIntTypeDeclarationSQL(array $columnDef); |
||
| 212 | |||
| 213 | /** |
||
| 214 | * Returns the SQL snippet that declares common properties of an integer column. |
||
| 215 | * |
||
| 216 | * @param mixed[] $columnDef |
||
| 217 | * |
||
| 218 | * @return string |
||
| 219 | */ |
||
| 220 | abstract protected function _getCommonIntegerTypeDeclarationSQL(array $columnDef); |
||
| 221 | |||
| 222 | /** |
||
| 223 | * Lazy load Doctrine Type Mappings. |
||
| 224 | * |
||
| 225 | * @return void |
||
| 226 | */ |
||
| 227 | abstract protected function initializeDoctrineTypeMappings(); |
||
| 228 | |||
| 229 | /** |
||
| 230 | * Initializes Doctrine Type Mappings with the platform defaults |
||
| 231 | * and with all additional type mappings. |
||
| 232 | * |
||
| 233 | * @return void |
||
| 234 | */ |
||
| 235 | private function initializeAllDoctrineTypeMappings() |
||
| 236 | { |
||
| 237 | $this->initializeDoctrineTypeMappings(); |
||
| 238 | |||
| 239 | foreach (Type::getTypesMap() as $typeName => $className) { |
||
| 240 | foreach (Type::getType($typeName)->getMappedDatabaseTypes($this) as $dbType) { |
||
| 241 | $this->doctrineTypeMapping[$dbType] = $typeName; |
||
| 242 | } |
||
| 243 | } |
||
| 244 | } |
||
| 245 | |||
| 246 | /** |
||
| 247 | * Returns the SQL snippet used to declare a VARCHAR column type. |
||
| 248 | * |
||
| 249 | * @param mixed[] $field |
||
| 250 | * |
||
| 251 | * @return string |
||
| 252 | */ |
||
| 253 | public function getVarcharTypeDeclarationSQL(array $field) |
||
| 254 | { |
||
| 255 | if (! isset($field['length'])) { |
||
| 256 | $field['length'] = $this->getVarcharDefaultLength(); |
||
| 257 | } |
||
| 258 | |||
| 259 | $fixed = $field['fixed'] ?? false; |
||
| 260 | |||
| 261 | $maxLength = $fixed |
||
| 262 | ? $this->getCharMaxLength() |
||
| 263 | : $this->getVarcharMaxLength(); |
||
| 264 | |||
| 265 | if ($field['length'] > $maxLength) { |
||
| 266 | return $this->getClobTypeDeclarationSQL($field); |
||
| 267 | } |
||
| 268 | |||
| 269 | return $this->getVarcharTypeDeclarationSQLSnippet($field['length'], $fixed); |
||
| 270 | } |
||
| 271 | |||
| 272 | /** |
||
| 273 | * Returns the SQL snippet used to declare a BINARY/VARBINARY column type. |
||
| 274 | * |
||
| 275 | * @param mixed[] $field The column definition. |
||
| 276 | * |
||
| 277 | * @return string |
||
| 278 | */ |
||
| 279 | public function getBinaryTypeDeclarationSQL(array $field) |
||
| 280 | { |
||
| 281 | if (! isset($field['length'])) { |
||
| 282 | $field['length'] = $this->getBinaryDefaultLength(); |
||
| 283 | } |
||
| 284 | |||
| 285 | $fixed = $field['fixed'] ?? false; |
||
| 286 | |||
| 287 | $maxLength = $this->getBinaryMaxLength(); |
||
| 288 | |||
| 289 | if ($field['length'] > $maxLength) { |
||
| 290 | if ($maxLength > 0) { |
||
| 291 | @trigger_error(sprintf( |
||
| 292 | 'Binary field length %d is greater than supported by the platform (%d). Reduce the field length or use a BLOB field instead.', |
||
| 293 | $field['length'], |
||
| 294 | $maxLength |
||
| 295 | ), E_USER_DEPRECATED); |
||
| 296 | } |
||
| 297 | |||
| 298 | return $this->getBlobTypeDeclarationSQL($field); |
||
| 299 | } |
||
| 300 | |||
| 301 | return $this->getBinaryTypeDeclarationSQLSnippet($field['length'], $fixed); |
||
| 302 | } |
||
| 303 | |||
| 304 | /** |
||
| 305 | * Returns the SQL snippet to declare a GUID/UUID field. |
||
| 306 | * |
||
| 307 | * By default this maps directly to a CHAR(36) and only maps to more |
||
| 308 | * special datatypes when the underlying databases support this datatype. |
||
| 309 | * |
||
| 310 | * @param mixed[] $field |
||
| 311 | * |
||
| 312 | * @return string |
||
| 313 | */ |
||
| 314 | public function getGuidTypeDeclarationSQL(array $field) |
||
| 315 | { |
||
| 316 | $field['length'] = 36; |
||
| 317 | $field['fixed'] = true; |
||
| 318 | |||
| 319 | return $this->getVarcharTypeDeclarationSQL($field); |
||
| 320 | } |
||
| 321 | |||
| 322 | /** |
||
| 323 | * Returns the SQL snippet to declare a JSON field. |
||
| 324 | * |
||
| 325 | * By default this maps directly to a CLOB and only maps to more |
||
| 326 | * special datatypes when the underlying databases support this datatype. |
||
| 327 | * |
||
| 328 | * @param mixed[] $field |
||
| 329 | * |
||
| 330 | * @return string |
||
| 331 | */ |
||
| 332 | public function getJsonTypeDeclarationSQL(array $field) |
||
| 333 | { |
||
| 334 | return $this->getClobTypeDeclarationSQL($field); |
||
| 335 | } |
||
| 336 | |||
| 337 | /** |
||
| 338 | * @param int|false $length |
||
| 339 | * @param bool $fixed |
||
| 340 | * |
||
| 341 | * @return string |
||
| 342 | * |
||
| 343 | * @throws DBALException If not supported on this platform. |
||
| 344 | */ |
||
| 345 | protected function getVarcharTypeDeclarationSQLSnippet($length, $fixed) |
||
|
|
|||
| 346 | { |
||
| 347 | throw DBALException::notSupported('VARCHARs not supported by Platform.'); |
||
| 348 | } |
||
| 349 | |||
| 350 | /** |
||
| 351 | * Returns the SQL snippet used to declare a BINARY/VARBINARY column type. |
||
| 352 | * |
||
| 353 | * @param int|false $length The length of the column. |
||
| 354 | * @param bool $fixed Whether the column length is fixed. |
||
| 355 | * |
||
| 356 | * @return string |
||
| 357 | * |
||
| 358 | * @throws DBALException If not supported on this platform. |
||
| 359 | */ |
||
| 360 | protected function getBinaryTypeDeclarationSQLSnippet($length, $fixed) |
||
| 361 | { |
||
| 362 | throw DBALException::notSupported('BINARY/VARBINARY column types are not supported by this platform.'); |
||
| 363 | } |
||
| 364 | |||
| 365 | /** |
||
| 366 | * Returns the SQL snippet used to declare a CLOB column type. |
||
| 367 | * |
||
| 368 | * @param mixed[] $field |
||
| 369 | * |
||
| 370 | * @return string |
||
| 371 | */ |
||
| 372 | abstract public function getClobTypeDeclarationSQL(array $field); |
||
| 373 | |||
| 374 | /** |
||
| 375 | * Returns the SQL Snippet used to declare a BLOB column type. |
||
| 376 | * |
||
| 377 | * @param mixed[] $field |
||
| 378 | * |
||
| 379 | * @return string |
||
| 380 | */ |
||
| 381 | abstract public function getBlobTypeDeclarationSQL(array $field); |
||
| 382 | |||
| 383 | /** |
||
| 384 | * Gets the name of the platform. |
||
| 385 | * |
||
| 386 | * @return string |
||
| 387 | */ |
||
| 388 | abstract public function getName(); |
||
| 389 | |||
| 390 | /** |
||
| 391 | * Registers a doctrine type to be used in conjunction with a column type of this platform. |
||
| 392 | * |
||
| 393 | * @param string $dbType |
||
| 394 | * @param string $doctrineType |
||
| 395 | * |
||
| 396 | * @return void |
||
| 397 | * |
||
| 398 | * @throws DBALException If the type is not found. |
||
| 399 | */ |
||
| 400 | public function registerDoctrineTypeMapping($dbType, $doctrineType) |
||
| 401 | { |
||
| 402 | if ($this->doctrineTypeMapping === null) { |
||
| 403 | $this->initializeAllDoctrineTypeMappings(); |
||
| 404 | } |
||
| 405 | |||
| 406 | if (! Types\Type::hasType($doctrineType)) { |
||
| 407 | throw DBALException::typeNotFound($doctrineType); |
||
| 408 | } |
||
| 409 | |||
| 410 | $dbType = strtolower($dbType); |
||
| 411 | $this->doctrineTypeMapping[$dbType] = $doctrineType; |
||
| 412 | |||
| 413 | $doctrineType = Type::getType($doctrineType); |
||
| 414 | |||
| 415 | if (! $doctrineType->requiresSQLCommentHint($this)) { |
||
| 416 | return; |
||
| 417 | } |
||
| 418 | |||
| 419 | $this->markDoctrineTypeCommented($doctrineType); |
||
| 420 | } |
||
| 421 | |||
| 422 | /** |
||
| 423 | * Gets the Doctrine type that is mapped for the given database column type. |
||
| 424 | * |
||
| 425 | * @param string $dbType |
||
| 426 | * |
||
| 427 | * @return string |
||
| 428 | * |
||
| 429 | * @throws DBALException |
||
| 430 | */ |
||
| 431 | public function getDoctrineTypeMapping($dbType) |
||
| 432 | { |
||
| 433 | if ($this->doctrineTypeMapping === null) { |
||
| 434 | $this->initializeAllDoctrineTypeMappings(); |
||
| 435 | } |
||
| 436 | |||
| 437 | $dbType = strtolower($dbType); |
||
| 438 | |||
| 439 | if (! isset($this->doctrineTypeMapping[$dbType])) { |
||
| 440 | throw new DBALException('Unknown database type ' . $dbType . ' requested, ' . static::class . ' may not support it.'); |
||
| 441 | } |
||
| 442 | |||
| 443 | return $this->doctrineTypeMapping[$dbType]; |
||
| 444 | } |
||
| 445 | |||
| 446 | /** |
||
| 447 | * Checks if a database type is currently supported by this platform. |
||
| 448 | * |
||
| 449 | * @param string $dbType |
||
| 450 | * |
||
| 451 | * @return bool |
||
| 452 | */ |
||
| 453 | public function hasDoctrineTypeMappingFor($dbType) |
||
| 454 | { |
||
| 455 | if ($this->doctrineTypeMapping === null) { |
||
| 456 | $this->initializeAllDoctrineTypeMappings(); |
||
| 457 | } |
||
| 458 | |||
| 459 | $dbType = strtolower($dbType); |
||
| 460 | |||
| 461 | return isset($this->doctrineTypeMapping[$dbType]); |
||
| 462 | } |
||
| 463 | |||
| 464 | /** |
||
| 465 | * Initializes the Doctrine Type comments instance variable for in_array() checks. |
||
| 466 | * |
||
| 467 | * @return void |
||
| 468 | */ |
||
| 469 | protected function initializeCommentedDoctrineTypes() |
||
| 470 | { |
||
| 471 | $this->doctrineTypeComments = []; |
||
| 472 | |||
| 473 | foreach (Type::getTypesMap() as $typeName => $className) { |
||
| 474 | $type = Type::getType($typeName); |
||
| 475 | |||
| 476 | if (! $type->requiresSQLCommentHint($this)) { |
||
| 477 | continue; |
||
| 478 | } |
||
| 479 | |||
| 480 | $this->doctrineTypeComments[] = $typeName; |
||
| 481 | } |
||
| 482 | } |
||
| 483 | |||
| 484 | /** |
||
| 485 | * Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type? |
||
| 486 | * |
||
| 487 | * @return bool |
||
| 488 | */ |
||
| 489 | public function isCommentedDoctrineType(Type $doctrineType) |
||
| 490 | { |
||
| 491 | if ($this->doctrineTypeComments === null) { |
||
| 492 | $this->initializeCommentedDoctrineTypes(); |
||
| 493 | } |
||
| 494 | |||
| 495 | assert(is_array($this->doctrineTypeComments)); |
||
| 496 | |||
| 497 | return in_array($doctrineType->getName(), $this->doctrineTypeComments, true); |
||
| 498 | } |
||
| 499 | |||
| 500 | /** |
||
| 501 | * Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements. |
||
| 502 | * |
||
| 503 | * @param string|Type $doctrineType |
||
| 504 | * |
||
| 505 | * @return void |
||
| 506 | */ |
||
| 507 | public function markDoctrineTypeCommented($doctrineType) |
||
| 508 | { |
||
| 509 | if ($this->doctrineTypeComments === null) { |
||
| 510 | $this->initializeCommentedDoctrineTypes(); |
||
| 511 | } |
||
| 512 | |||
| 513 | assert(is_array($this->doctrineTypeComments)); |
||
| 514 | |||
| 515 | $this->doctrineTypeComments[] = $doctrineType instanceof Type ? $doctrineType->getName() : $doctrineType; |
||
| 516 | } |
||
| 517 | |||
| 518 | /** |
||
| 519 | * Gets the comment to append to a column comment that helps parsing this type in reverse engineering. |
||
| 520 | * |
||
| 521 | * @return string |
||
| 522 | */ |
||
| 523 | public function getDoctrineTypeComment(Type $doctrineType) |
||
| 524 | { |
||
| 525 | return '(DC2Type:' . $doctrineType->getName() . ')'; |
||
| 526 | } |
||
| 527 | |||
| 528 | /** |
||
| 529 | * Gets the comment of a passed column modified by potential doctrine type comment hints. |
||
| 530 | * |
||
| 531 | * @return string|null |
||
| 532 | */ |
||
| 533 | protected function getColumnComment(Column $column) |
||
| 534 | { |
||
| 535 | $comment = $column->getComment(); |
||
| 536 | |||
| 537 | if ($this->isCommentedDoctrineType($column->getType())) { |
||
| 538 | $comment .= $this->getDoctrineTypeComment($column->getType()); |
||
| 539 | } |
||
| 540 | |||
| 541 | return $comment; |
||
| 542 | } |
||
| 543 | |||
| 544 | /** |
||
| 545 | * Gets the character used for identifier quoting. |
||
| 546 | * |
||
| 547 | * @return string |
||
| 548 | */ |
||
| 549 | public function getIdentifierQuoteCharacter() |
||
| 550 | { |
||
| 551 | return '"'; |
||
| 552 | } |
||
| 553 | |||
| 554 | /** |
||
| 555 | * Gets the string portion that starts an SQL comment. |
||
| 556 | * |
||
| 557 | * @return string |
||
| 558 | */ |
||
| 559 | public function getSqlCommentStartString() |
||
| 560 | { |
||
| 561 | return '--'; |
||
| 562 | } |
||
| 563 | |||
| 564 | /** |
||
| 565 | * Gets the string portion that ends an SQL comment. |
||
| 566 | * |
||
| 567 | * @return string |
||
| 568 | */ |
||
| 569 | public function getSqlCommentEndString() |
||
| 570 | { |
||
| 571 | return "\n"; |
||
| 572 | } |
||
| 573 | |||
| 574 | /** |
||
| 575 | * Gets the maximum length of a char field. |
||
| 576 | */ |
||
| 577 | public function getCharMaxLength() : int |
||
| 578 | { |
||
| 579 | return $this->getVarcharMaxLength(); |
||
| 580 | } |
||
| 581 | |||
| 582 | /** |
||
| 583 | * Gets the maximum length of a varchar field. |
||
| 584 | * |
||
| 585 | * @return int |
||
| 586 | */ |
||
| 587 | public function getVarcharMaxLength() |
||
| 588 | { |
||
| 589 | return 4000; |
||
| 590 | } |
||
| 591 | |||
| 592 | /** |
||
| 593 | * Gets the default length of a varchar field. |
||
| 594 | * |
||
| 595 | * @return int |
||
| 596 | */ |
||
| 597 | public function getVarcharDefaultLength() |
||
| 598 | { |
||
| 599 | return 255; |
||
| 600 | } |
||
| 601 | |||
| 602 | /** |
||
| 603 | * Gets the maximum length of a binary field. |
||
| 604 | * |
||
| 605 | * @return int |
||
| 606 | */ |
||
| 607 | public function getBinaryMaxLength() |
||
| 608 | { |
||
| 609 | return 4000; |
||
| 610 | } |
||
| 611 | |||
| 612 | /** |
||
| 613 | * Gets the default length of a binary field. |
||
| 614 | * |
||
| 615 | * @return int |
||
| 616 | */ |
||
| 617 | public function getBinaryDefaultLength() |
||
| 618 | { |
||
| 619 | return 255; |
||
| 620 | } |
||
| 621 | |||
| 622 | /** |
||
| 623 | * Gets all SQL wildcard characters of the platform. |
||
| 624 | * |
||
| 625 | * @return string[] |
||
| 626 | */ |
||
| 627 | public function getWildcards() |
||
| 628 | { |
||
| 629 | return ['%', '_']; |
||
| 630 | } |
||
| 631 | |||
| 632 | /** |
||
| 633 | * Returns the regular expression operator. |
||
| 634 | * |
||
| 635 | * @return string |
||
| 636 | * |
||
| 637 | * @throws DBALException If not supported on this platform. |
||
| 638 | */ |
||
| 639 | public function getRegexpExpression() |
||
| 640 | { |
||
| 641 | throw DBALException::notSupported(__METHOD__); |
||
| 642 | } |
||
| 643 | |||
| 644 | /** |
||
| 645 | * Returns the global unique identifier expression. |
||
| 646 | * |
||
| 647 | * @deprecated Use application-generated UUIDs instead |
||
| 648 | * |
||
| 649 | * @return string |
||
| 650 | * |
||
| 651 | * @throws DBALException If not supported on this platform. |
||
| 652 | */ |
||
| 653 | public function getGuidExpression() |
||
| 654 | { |
||
| 655 | throw DBALException::notSupported(__METHOD__); |
||
| 656 | } |
||
| 657 | |||
| 658 | /** |
||
| 659 | * Returns the SQL snippet to get the average value of a column. |
||
| 660 | * |
||
| 661 | * @param string $column The column to use. |
||
| 662 | * |
||
| 663 | * @return string Generated SQL including an AVG aggregate function. |
||
| 664 | */ |
||
| 665 | public function getAvgExpression($column) |
||
| 666 | { |
||
| 667 | return 'AVG(' . $column . ')'; |
||
| 668 | } |
||
| 669 | |||
| 670 | /** |
||
| 671 | * Returns the SQL snippet to get the number of rows (without a NULL value) of a column. |
||
| 672 | * |
||
| 673 | * If a '*' is used instead of a column the number of selected rows is returned. |
||
| 674 | * |
||
| 675 | * @param string|int $column The column to use. |
||
| 676 | * |
||
| 677 | * @return string Generated SQL including a COUNT aggregate function. |
||
| 678 | */ |
||
| 679 | public function getCountExpression($column) |
||
| 680 | { |
||
| 681 | return 'COUNT(' . $column . ')'; |
||
| 682 | } |
||
| 683 | |||
| 684 | /** |
||
| 685 | * Returns the SQL snippet to get the highest value of a column. |
||
| 686 | * |
||
| 687 | * @param string $column The column to use. |
||
| 688 | * |
||
| 689 | * @return string Generated SQL including a MAX aggregate function. |
||
| 690 | */ |
||
| 691 | public function getMaxExpression($column) |
||
| 692 | { |
||
| 693 | return 'MAX(' . $column . ')'; |
||
| 694 | } |
||
| 695 | |||
| 696 | /** |
||
| 697 | * Returns the SQL snippet to get the lowest value of a column. |
||
| 698 | * |
||
| 699 | * @param string $column The column to use. |
||
| 700 | * |
||
| 701 | * @return string Generated SQL including a MIN aggregate function. |
||
| 702 | */ |
||
| 703 | public function getMinExpression($column) |
||
| 704 | { |
||
| 705 | return 'MIN(' . $column . ')'; |
||
| 706 | } |
||
| 707 | |||
| 708 | /** |
||
| 709 | * Returns the SQL snippet to get the total sum of a column. |
||
| 710 | * |
||
| 711 | * @param string $column The column to use. |
||
| 712 | * |
||
| 713 | * @return string Generated SQL including a SUM aggregate function. |
||
| 714 | */ |
||
| 715 | public function getSumExpression($column) |
||
| 716 | { |
||
| 717 | return 'SUM(' . $column . ')'; |
||
| 718 | } |
||
| 719 | |||
| 720 | // scalar functions |
||
| 721 | |||
| 722 | /** |
||
| 723 | * Returns the SQL snippet to get the md5 sum of a field. |
||
| 724 | * |
||
| 725 | * Note: Not SQL92, but common functionality. |
||
| 726 | * |
||
| 727 | * @param string $column |
||
| 728 | * |
||
| 729 | * @return string |
||
| 730 | */ |
||
| 731 | public function getMd5Expression($column) |
||
| 732 | { |
||
| 733 | return 'MD5(' . $column . ')'; |
||
| 734 | } |
||
| 735 | |||
| 736 | /** |
||
| 737 | * Returns the SQL snippet to get the length of a text field. |
||
| 738 | * |
||
| 739 | * @param string $column |
||
| 740 | * |
||
| 741 | * @return string |
||
| 742 | */ |
||
| 743 | public function getLengthExpression($column) |
||
| 744 | { |
||
| 745 | return 'LENGTH(' . $column . ')'; |
||
| 746 | } |
||
| 747 | |||
| 748 | /** |
||
| 749 | * Returns the SQL snippet to get the squared value of a column. |
||
| 750 | * |
||
| 751 | * @param string $column The column to use. |
||
| 752 | * |
||
| 753 | * @return string Generated SQL including an SQRT aggregate function. |
||
| 754 | */ |
||
| 755 | public function getSqrtExpression($column) |
||
| 756 | { |
||
| 757 | return 'SQRT(' . $column . ')'; |
||
| 758 | } |
||
| 759 | |||
| 760 | /** |
||
| 761 | * Returns the SQL snippet to round a numeric field to the number of decimals specified. |
||
| 762 | * |
||
| 763 | * @param string $column |
||
| 764 | * @param int $decimals |
||
| 765 | * |
||
| 766 | * @return string |
||
| 767 | */ |
||
| 768 | public function getRoundExpression($column, $decimals = 0) |
||
| 769 | { |
||
| 770 | return 'ROUND(' . $column . ', ' . $decimals . ')'; |
||
| 771 | } |
||
| 772 | |||
| 773 | /** |
||
| 774 | * Returns the SQL snippet to get the remainder of the division operation $expression1 / $expression2. |
||
| 775 | * |
||
| 776 | * @param string $expression1 |
||
| 777 | * @param string $expression2 |
||
| 778 | * |
||
| 779 | * @return string |
||
| 780 | */ |
||
| 781 | public function getModExpression($expression1, $expression2) |
||
| 782 | { |
||
| 783 | return 'MOD(' . $expression1 . ', ' . $expression2 . ')'; |
||
| 784 | } |
||
| 785 | |||
| 786 | /** |
||
| 787 | * Returns the SQL snippet to trim a string. |
||
| 788 | * |
||
| 789 | * @param string $str The expression to apply the trim to. |
||
| 790 | * @param int $mode The position of the trim (leading/trailing/both). |
||
| 791 | * @param string|bool $char The char to trim, has to be quoted already. Defaults to space. |
||
| 792 | * |
||
| 793 | * @return string |
||
| 794 | */ |
||
| 795 | public function getTrimExpression($str, $mode = TrimMode::UNSPECIFIED, $char = false) |
||
| 796 | { |
||
| 797 | $expression = ''; |
||
| 798 | |||
| 799 | switch ($mode) { |
||
| 800 | case TrimMode::LEADING: |
||
| 801 | $expression = 'LEADING '; |
||
| 802 | break; |
||
| 803 | |||
| 804 | case TrimMode::TRAILING: |
||
| 805 | $expression = 'TRAILING '; |
||
| 806 | break; |
||
| 807 | |||
| 808 | case TrimMode::BOTH: |
||
| 809 | $expression = 'BOTH '; |
||
| 810 | break; |
||
| 811 | } |
||
| 812 | |||
| 813 | if ($char !== false) { |
||
| 814 | $expression .= $char . ' '; |
||
| 815 | } |
||
| 816 | |||
| 817 | if ($mode !== TrimMode::UNSPECIFIED || $char !== false) { |
||
| 818 | $expression .= 'FROM '; |
||
| 819 | } |
||
| 820 | |||
| 821 | return 'TRIM(' . $expression . $str . ')'; |
||
| 822 | } |
||
| 823 | |||
| 824 | /** |
||
| 825 | * Returns the SQL snippet to trim trailing space characters from the expression. |
||
| 826 | * |
||
| 827 | * @param string $str Literal string or column name. |
||
| 828 | * |
||
| 829 | * @return string |
||
| 830 | */ |
||
| 831 | public function getRtrimExpression($str) |
||
| 832 | { |
||
| 833 | return 'RTRIM(' . $str . ')'; |
||
| 834 | } |
||
| 835 | |||
| 836 | /** |
||
| 837 | * Returns the SQL snippet to trim leading space characters from the expression. |
||
| 838 | * |
||
| 839 | * @param string $str Literal string or column name. |
||
| 840 | * |
||
| 841 | * @return string |
||
| 842 | */ |
||
| 843 | public function getLtrimExpression($str) |
||
| 844 | { |
||
| 845 | return 'LTRIM(' . $str . ')'; |
||
| 846 | } |
||
| 847 | |||
| 848 | /** |
||
| 849 | * Returns the SQL snippet to change all characters from the expression to uppercase, |
||
| 850 | * according to the current character set mapping. |
||
| 851 | * |
||
| 852 | * @param string $str Literal string or column name. |
||
| 853 | * |
||
| 854 | * @return string |
||
| 855 | */ |
||
| 856 | public function getUpperExpression($str) |
||
| 857 | { |
||
| 858 | return 'UPPER(' . $str . ')'; |
||
| 859 | } |
||
| 860 | |||
| 861 | /** |
||
| 862 | * Returns the SQL snippet to change all characters from the expression to lowercase, |
||
| 863 | * according to the current character set mapping. |
||
| 864 | * |
||
| 865 | * @param string $str Literal string or column name. |
||
| 866 | * |
||
| 867 | * @return string |
||
| 868 | */ |
||
| 869 | public function getLowerExpression($str) |
||
| 870 | { |
||
| 871 | return 'LOWER(' . $str . ')'; |
||
| 872 | } |
||
| 873 | |||
| 874 | /** |
||
| 875 | * Returns the SQL snippet to get the position of the first occurrence of substring $substr in string $str. |
||
| 876 | * |
||
| 877 | * @param string $str Literal string. |
||
| 878 | * @param string $substr Literal string to find. |
||
| 879 | * @param int|false $startPos Position to start at, beginning of string by default. |
||
| 880 | * |
||
| 881 | * @return string |
||
| 882 | * |
||
| 883 | * @throws DBALException If not supported on this platform. |
||
| 884 | */ |
||
| 885 | public function getLocateExpression($str, $substr, $startPos = false) |
||
| 886 | { |
||
| 887 | throw DBALException::notSupported(__METHOD__); |
||
| 888 | } |
||
| 889 | |||
| 890 | /** |
||
| 891 | * Returns the SQL snippet to get the current system date. |
||
| 892 | * |
||
| 893 | * @return string |
||
| 894 | */ |
||
| 895 | public function getNowExpression() |
||
| 896 | { |
||
| 897 | return 'NOW()'; |
||
| 898 | } |
||
| 899 | |||
| 900 | /** |
||
| 901 | * Returns a SQL snippet to get a substring inside an SQL statement. |
||
| 902 | * |
||
| 903 | * Note: Not SQL92, but common functionality. |
||
| 904 | * |
||
| 905 | * SQLite only supports the 2 parameter variant of this function. |
||
| 906 | * |
||
| 907 | * @param string $value An sql string literal or column name/alias. |
||
| 908 | * @param int $from Where to start the substring portion. |
||
| 909 | * @param int|null $length The substring portion length. |
||
| 910 | * |
||
| 911 | * @return string |
||
| 912 | */ |
||
| 913 | public function getSubstringExpression($value, $from, $length = null) |
||
| 914 | { |
||
| 915 | if ($length === null) { |
||
| 916 | return 'SUBSTRING(' . $value . ' FROM ' . $from . ')'; |
||
| 917 | } |
||
| 918 | |||
| 919 | return 'SUBSTRING(' . $value . ' FROM ' . $from . ' FOR ' . $length . ')'; |
||
| 920 | } |
||
| 921 | |||
| 922 | /** |
||
| 923 | * Returns a SQL snippet to concatenate the given expressions. |
||
| 924 | * |
||
| 925 | * Accepts an arbitrary number of string parameters. Each parameter must contain an expression. |
||
| 926 | * |
||
| 927 | * @return string |
||
| 928 | */ |
||
| 929 | public function getConcatExpression() |
||
| 930 | { |
||
| 931 | return implode(' || ', func_get_args()); |
||
| 932 | } |
||
| 933 | |||
| 934 | /** |
||
| 935 | * Returns the SQL for a logical not. |
||
| 936 | * |
||
| 937 | * Example: |
||
| 938 | * <code> |
||
| 939 | * $q = new Doctrine_Query(); |
||
| 940 | * $e = $q->expr; |
||
| 941 | * $q->select('*')->from('table') |
||
| 942 | * ->where($e->eq('id', $e->not('null')); |
||
| 943 | * </code> |
||
| 944 | * |
||
| 945 | * @param string $expression |
||
| 946 | * |
||
| 947 | * @return string The logical expression. |
||
| 948 | */ |
||
| 949 | public function getNotExpression($expression) |
||
| 950 | { |
||
| 951 | return 'NOT(' . $expression . ')'; |
||
| 952 | } |
||
| 953 | |||
| 954 | /** |
||
| 955 | * Returns the SQL that checks if an expression is null. |
||
| 956 | * |
||
| 957 | * @param string $expression The expression that should be compared to null. |
||
| 958 | * |
||
| 959 | * @return string The logical expression. |
||
| 960 | */ |
||
| 961 | public function getIsNullExpression($expression) |
||
| 962 | { |
||
| 963 | return $expression . ' IS NULL'; |
||
| 964 | } |
||
| 965 | |||
| 966 | /** |
||
| 967 | * Returns the SQL that checks if an expression is not null. |
||
| 968 | * |
||
| 969 | * @param string $expression The expression that should be compared to null. |
||
| 970 | * |
||
| 971 | * @return string The logical expression. |
||
| 972 | */ |
||
| 973 | public function getIsNotNullExpression($expression) |
||
| 974 | { |
||
| 975 | return $expression . ' IS NOT NULL'; |
||
| 976 | } |
||
| 977 | |||
| 978 | /** |
||
| 979 | * Returns the SQL that checks if an expression evaluates to a value between two values. |
||
| 980 | * |
||
| 981 | * The parameter $expression is checked if it is between $value1 and $value2. |
||
| 982 | * |
||
| 983 | * Note: There is a slight difference in the way BETWEEN works on some databases. |
||
| 984 | * http://www.w3schools.com/sql/sql_between.asp. If you want complete database |
||
| 985 | * independence you should avoid using between(). |
||
| 986 | * |
||
| 987 | * @param string $expression The value to compare to. |
||
| 988 | * @param string $value1 The lower value to compare with. |
||
| 989 | * @param string $value2 The higher value to compare with. |
||
| 990 | * |
||
| 991 | * @return string The logical expression. |
||
| 992 | */ |
||
| 993 | public function getBetweenExpression($expression, $value1, $value2) |
||
| 994 | { |
||
| 995 | return $expression . ' BETWEEN ' . $value1 . ' AND ' . $value2; |
||
| 996 | } |
||
| 997 | |||
| 998 | /** |
||
| 999 | * Returns the SQL to get the arccosine of a value. |
||
| 1000 | * |
||
| 1001 | * @param string $value |
||
| 1002 | * |
||
| 1003 | * @return string |
||
| 1004 | */ |
||
| 1005 | public function getAcosExpression($value) |
||
| 1006 | { |
||
| 1007 | return 'ACOS(' . $value . ')'; |
||
| 1008 | } |
||
| 1009 | |||
| 1010 | /** |
||
| 1011 | * Returns the SQL to get the sine of a value. |
||
| 1012 | * |
||
| 1013 | * @param string $value |
||
| 1014 | * |
||
| 1015 | * @return string |
||
| 1016 | */ |
||
| 1017 | public function getSinExpression($value) |
||
| 1018 | { |
||
| 1019 | return 'SIN(' . $value . ')'; |
||
| 1020 | } |
||
| 1021 | |||
| 1022 | /** |
||
| 1023 | * Returns the SQL to get the PI value. |
||
| 1024 | * |
||
| 1025 | * @return string |
||
| 1026 | */ |
||
| 1027 | public function getPiExpression() |
||
| 1028 | { |
||
| 1029 | return 'PI()'; |
||
| 1030 | } |
||
| 1031 | |||
| 1032 | /** |
||
| 1033 | * Returns the SQL to get the cosine of a value. |
||
| 1034 | * |
||
| 1035 | * @param string $value |
||
| 1036 | * |
||
| 1037 | * @return string |
||
| 1038 | */ |
||
| 1039 | public function getCosExpression($value) |
||
| 1040 | { |
||
| 1041 | return 'COS(' . $value . ')'; |
||
| 1042 | } |
||
| 1043 | |||
| 1044 | /** |
||
| 1045 | * Returns the SQL to calculate the difference in days between the two passed dates. |
||
| 1046 | * |
||
| 1047 | * Computes diff = date1 - date2. |
||
| 1048 | * |
||
| 1049 | * @param string $date1 |
||
| 1050 | * @param string $date2 |
||
| 1051 | * |
||
| 1052 | * @return string |
||
| 1053 | * |
||
| 1054 | * @throws DBALException If not supported on this platform. |
||
| 1055 | */ |
||
| 1056 | public function getDateDiffExpression($date1, $date2) |
||
| 1057 | { |
||
| 1058 | throw DBALException::notSupported(__METHOD__); |
||
| 1059 | } |
||
| 1060 | |||
| 1061 | /** |
||
| 1062 | * Returns the SQL to add the number of given seconds to a date. |
||
| 1063 | * |
||
| 1064 | * @param string $date |
||
| 1065 | * @param int $seconds |
||
| 1066 | * |
||
| 1067 | * @return string |
||
| 1068 | * |
||
| 1069 | * @throws DBALException If not supported on this platform. |
||
| 1070 | */ |
||
| 1071 | public function getDateAddSecondsExpression($date, $seconds) |
||
| 1072 | { |
||
| 1073 | return $this->getDateArithmeticIntervalExpression($date, '+', $seconds, DateIntervalUnit::SECOND); |
||
| 1074 | } |
||
| 1075 | |||
| 1076 | /** |
||
| 1077 | * Returns the SQL to subtract the number of given seconds from a date. |
||
| 1078 | * |
||
| 1079 | * @param string $date |
||
| 1080 | * @param int $seconds |
||
| 1081 | * |
||
| 1082 | * @return string |
||
| 1083 | * |
||
| 1084 | * @throws DBALException If not supported on this platform. |
||
| 1085 | */ |
||
| 1086 | public function getDateSubSecondsExpression($date, $seconds) |
||
| 1087 | { |
||
| 1088 | return $this->getDateArithmeticIntervalExpression($date, '-', $seconds, DateIntervalUnit::SECOND); |
||
| 1089 | } |
||
| 1090 | |||
| 1091 | /** |
||
| 1092 | * Returns the SQL to add the number of given minutes to a date. |
||
| 1093 | * |
||
| 1094 | * @param string $date |
||
| 1095 | * @param int $minutes |
||
| 1096 | * |
||
| 1097 | * @return string |
||
| 1098 | * |
||
| 1099 | * @throws DBALException If not supported on this platform. |
||
| 1100 | */ |
||
| 1101 | public function getDateAddMinutesExpression($date, $minutes) |
||
| 1102 | { |
||
| 1103 | return $this->getDateArithmeticIntervalExpression($date, '+', $minutes, DateIntervalUnit::MINUTE); |
||
| 1104 | } |
||
| 1105 | |||
| 1106 | /** |
||
| 1107 | * Returns the SQL to subtract the number of given minutes from a date. |
||
| 1108 | * |
||
| 1109 | * @param string $date |
||
| 1110 | * @param int $minutes |
||
| 1111 | * |
||
| 1112 | * @return string |
||
| 1113 | * |
||
| 1114 | * @throws DBALException If not supported on this platform. |
||
| 1115 | */ |
||
| 1116 | public function getDateSubMinutesExpression($date, $minutes) |
||
| 1117 | { |
||
| 1118 | return $this->getDateArithmeticIntervalExpression($date, '-', $minutes, DateIntervalUnit::MINUTE); |
||
| 1119 | } |
||
| 1120 | |||
| 1121 | /** |
||
| 1122 | * Returns the SQL to add the number of given hours to a date. |
||
| 1123 | * |
||
| 1124 | * @param string $date |
||
| 1125 | * @param int $hours |
||
| 1126 | * |
||
| 1127 | * @return string |
||
| 1128 | * |
||
| 1129 | * @throws DBALException If not supported on this platform. |
||
| 1130 | */ |
||
| 1131 | public function getDateAddHourExpression($date, $hours) |
||
| 1132 | { |
||
| 1133 | return $this->getDateArithmeticIntervalExpression($date, '+', $hours, DateIntervalUnit::HOUR); |
||
| 1134 | } |
||
| 1135 | |||
| 1136 | /** |
||
| 1137 | * Returns the SQL to subtract the number of given hours to a date. |
||
| 1138 | * |
||
| 1139 | * @param string $date |
||
| 1140 | * @param int $hours |
||
| 1141 | * |
||
| 1142 | * @return string |
||
| 1143 | * |
||
| 1144 | * @throws DBALException If not supported on this platform. |
||
| 1145 | */ |
||
| 1146 | public function getDateSubHourExpression($date, $hours) |
||
| 1147 | { |
||
| 1148 | return $this->getDateArithmeticIntervalExpression($date, '-', $hours, DateIntervalUnit::HOUR); |
||
| 1149 | } |
||
| 1150 | |||
| 1151 | /** |
||
| 1152 | * Returns the SQL to add the number of given days to a date. |
||
| 1153 | * |
||
| 1154 | * @param string $date |
||
| 1155 | * @param int $days |
||
| 1156 | * |
||
| 1157 | * @return string |
||
| 1158 | * |
||
| 1159 | * @throws DBALException If not supported on this platform. |
||
| 1160 | */ |
||
| 1161 | public function getDateAddDaysExpression($date, $days) |
||
| 1162 | { |
||
| 1163 | return $this->getDateArithmeticIntervalExpression($date, '+', $days, DateIntervalUnit::DAY); |
||
| 1164 | } |
||
| 1165 | |||
| 1166 | /** |
||
| 1167 | * Returns the SQL to subtract the number of given days to a date. |
||
| 1168 | * |
||
| 1169 | * @param string $date |
||
| 1170 | * @param int $days |
||
| 1171 | * |
||
| 1172 | * @return string |
||
| 1173 | * |
||
| 1174 | * @throws DBALException If not supported on this platform. |
||
| 1175 | */ |
||
| 1176 | public function getDateSubDaysExpression($date, $days) |
||
| 1177 | { |
||
| 1178 | return $this->getDateArithmeticIntervalExpression($date, '-', $days, DateIntervalUnit::DAY); |
||
| 1179 | } |
||
| 1180 | |||
| 1181 | /** |
||
| 1182 | * Returns the SQL to add the number of given weeks to a date. |
||
| 1183 | * |
||
| 1184 | * @param string $date |
||
| 1185 | * @param int $weeks |
||
| 1186 | * |
||
| 1187 | * @return string |
||
| 1188 | * |
||
| 1189 | * @throws DBALException If not supported on this platform. |
||
| 1190 | */ |
||
| 1191 | public function getDateAddWeeksExpression($date, $weeks) |
||
| 1192 | { |
||
| 1193 | return $this->getDateArithmeticIntervalExpression($date, '+', $weeks, DateIntervalUnit::WEEK); |
||
| 1194 | } |
||
| 1195 | |||
| 1196 | /** |
||
| 1197 | * Returns the SQL to subtract the number of given weeks from a date. |
||
| 1198 | * |
||
| 1199 | * @param string $date |
||
| 1200 | * @param int $weeks |
||
| 1201 | * |
||
| 1202 | * @return string |
||
| 1203 | * |
||
| 1204 | * @throws DBALException If not supported on this platform. |
||
| 1205 | */ |
||
| 1206 | public function getDateSubWeeksExpression($date, $weeks) |
||
| 1207 | { |
||
| 1208 | return $this->getDateArithmeticIntervalExpression($date, '-', $weeks, DateIntervalUnit::WEEK); |
||
| 1209 | } |
||
| 1210 | |||
| 1211 | /** |
||
| 1212 | * Returns the SQL to add the number of given months to a date. |
||
| 1213 | * |
||
| 1214 | * @param string $date |
||
| 1215 | * @param int $months |
||
| 1216 | * |
||
| 1217 | * @return string |
||
| 1218 | * |
||
| 1219 | * @throws DBALException If not supported on this platform. |
||
| 1220 | */ |
||
| 1221 | public function getDateAddMonthExpression($date, $months) |
||
| 1222 | { |
||
| 1223 | return $this->getDateArithmeticIntervalExpression($date, '+', $months, DateIntervalUnit::MONTH); |
||
| 1224 | } |
||
| 1225 | |||
| 1226 | /** |
||
| 1227 | * Returns the SQL to subtract the number of given months to a date. |
||
| 1228 | * |
||
| 1229 | * @param string $date |
||
| 1230 | * @param int $months |
||
| 1231 | * |
||
| 1232 | * @return string |
||
| 1233 | * |
||
| 1234 | * @throws DBALException If not supported on this platform. |
||
| 1235 | */ |
||
| 1236 | public function getDateSubMonthExpression($date, $months) |
||
| 1237 | { |
||
| 1238 | return $this->getDateArithmeticIntervalExpression($date, '-', $months, DateIntervalUnit::MONTH); |
||
| 1239 | } |
||
| 1240 | |||
| 1241 | /** |
||
| 1242 | * Returns the SQL to add the number of given quarters to a date. |
||
| 1243 | * |
||
| 1244 | * @param string $date |
||
| 1245 | * @param int $quarters |
||
| 1246 | * |
||
| 1247 | * @return string |
||
| 1248 | * |
||
| 1249 | * @throws DBALException If not supported on this platform. |
||
| 1250 | */ |
||
| 1251 | public function getDateAddQuartersExpression($date, $quarters) |
||
| 1252 | { |
||
| 1253 | return $this->getDateArithmeticIntervalExpression($date, '+', $quarters, DateIntervalUnit::QUARTER); |
||
| 1254 | } |
||
| 1255 | |||
| 1256 | /** |
||
| 1257 | * Returns the SQL to subtract the number of given quarters from a date. |
||
| 1258 | * |
||
| 1259 | * @param string $date |
||
| 1260 | * @param int $quarters |
||
| 1261 | * |
||
| 1262 | * @return string |
||
| 1263 | * |
||
| 1264 | * @throws DBALException If not supported on this platform. |
||
| 1265 | */ |
||
| 1266 | public function getDateSubQuartersExpression($date, $quarters) |
||
| 1267 | { |
||
| 1268 | return $this->getDateArithmeticIntervalExpression($date, '-', $quarters, DateIntervalUnit::QUARTER); |
||
| 1269 | } |
||
| 1270 | |||
| 1271 | /** |
||
| 1272 | * Returns the SQL to add the number of given years to a date. |
||
| 1273 | * |
||
| 1274 | * @param string $date |
||
| 1275 | * @param int $years |
||
| 1276 | * |
||
| 1277 | * @return string |
||
| 1278 | * |
||
| 1279 | * @throws DBALException If not supported on this platform. |
||
| 1280 | */ |
||
| 1281 | public function getDateAddYearsExpression($date, $years) |
||
| 1282 | { |
||
| 1283 | return $this->getDateArithmeticIntervalExpression($date, '+', $years, DateIntervalUnit::YEAR); |
||
| 1284 | } |
||
| 1285 | |||
| 1286 | /** |
||
| 1287 | * Returns the SQL to subtract the number of given years from a date. |
||
| 1288 | * |
||
| 1289 | * @param string $date |
||
| 1290 | * @param int $years |
||
| 1291 | * |
||
| 1292 | * @return string |
||
| 1293 | * |
||
| 1294 | * @throws DBALException If not supported on this platform. |
||
| 1295 | */ |
||
| 1296 | public function getDateSubYearsExpression($date, $years) |
||
| 1297 | { |
||
| 1298 | return $this->getDateArithmeticIntervalExpression($date, '-', $years, DateIntervalUnit::YEAR); |
||
| 1299 | } |
||
| 1300 | |||
| 1301 | /** |
||
| 1302 | * Returns the SQL for a date arithmetic expression. |
||
| 1303 | * |
||
| 1304 | * @param string $date The column or literal representing a date to perform the arithmetic operation on. |
||
| 1305 | * @param string $operator The arithmetic operator (+ or -). |
||
| 1306 | * @param int $interval The interval that shall be calculated into the date. |
||
| 1307 | * @param string $unit The unit of the interval that shall be calculated into the date. |
||
| 1308 | * One of the DATE_INTERVAL_UNIT_* constants. |
||
| 1309 | * |
||
| 1310 | * @return string |
||
| 1311 | * |
||
| 1312 | * @throws DBALException If not supported on this platform. |
||
| 1313 | */ |
||
| 1314 | protected function getDateArithmeticIntervalExpression($date, $operator, $interval, $unit) |
||
| 1315 | { |
||
| 1316 | throw DBALException::notSupported(__METHOD__); |
||
| 1317 | } |
||
| 1318 | |||
| 1319 | /** |
||
| 1320 | * Returns the SQL bit AND comparison expression. |
||
| 1321 | * |
||
| 1322 | * @param string $value1 |
||
| 1323 | * @param string $value2 |
||
| 1324 | * |
||
| 1325 | * @return string |
||
| 1326 | */ |
||
| 1327 | public function getBitAndComparisonExpression($value1, $value2) |
||
| 1328 | { |
||
| 1329 | return '(' . $value1 . ' & ' . $value2 . ')'; |
||
| 1330 | } |
||
| 1331 | |||
| 1332 | /** |
||
| 1333 | * Returns the SQL bit OR comparison expression. |
||
| 1334 | * |
||
| 1335 | * @param string $value1 |
||
| 1336 | * @param string $value2 |
||
| 1337 | * |
||
| 1338 | * @return string |
||
| 1339 | */ |
||
| 1340 | public function getBitOrComparisonExpression($value1, $value2) |
||
| 1341 | { |
||
| 1342 | return '(' . $value1 . ' | ' . $value2 . ')'; |
||
| 1343 | } |
||
| 1344 | |||
| 1345 | /** |
||
| 1346 | * Returns the FOR UPDATE expression. |
||
| 1347 | * |
||
| 1348 | * @return string |
||
| 1349 | */ |
||
| 1350 | public function getForUpdateSQL() |
||
| 1351 | { |
||
| 1352 | return 'FOR UPDATE'; |
||
| 1353 | } |
||
| 1354 | |||
| 1355 | /** |
||
| 1356 | * Honors that some SQL vendors such as MsSql use table hints for locking instead of the ANSI SQL FOR UPDATE specification. |
||
| 1357 | * |
||
| 1358 | * @param string $fromClause The FROM clause to append the hint for the given lock mode to. |
||
| 1359 | * @param int|null $lockMode One of the Doctrine\DBAL\LockMode::* constants. If null is given, nothing will |
||
| 1360 | * be appended to the FROM clause. |
||
| 1361 | * |
||
| 1362 | * @return string |
||
| 1363 | */ |
||
| 1364 | public function appendLockHint($fromClause, $lockMode) |
||
| 1365 | { |
||
| 1366 | return $fromClause; |
||
| 1367 | } |
||
| 1368 | |||
| 1369 | /** |
||
| 1370 | * Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock. |
||
| 1371 | * |
||
| 1372 | * This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database |
||
| 1373 | * vendors allow to lighten this constraint up to be a real read lock. |
||
| 1374 | * |
||
| 1375 | * @return string |
||
| 1376 | */ |
||
| 1377 | public function getReadLockSQL() |
||
| 1378 | { |
||
| 1379 | return $this->getForUpdateSQL(); |
||
| 1380 | } |
||
| 1381 | |||
| 1382 | /** |
||
| 1383 | * Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows. |
||
| 1384 | * |
||
| 1385 | * The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard. |
||
| 1386 | * |
||
| 1387 | * @return string |
||
| 1388 | */ |
||
| 1389 | public function getWriteLockSQL() |
||
| 1392 | } |
||
| 1393 | |||
| 1394 | /** |
||
| 1395 | * Returns the SQL snippet to drop an existing database. |
||
| 1396 | * |
||
| 1397 | * @param string $database The name of the database that should be dropped. |
||
| 1398 | * |
||
| 1399 | * @return string |
||
| 1400 | */ |
||
| 1401 | public function getDropDatabaseSQL($database) |
||
| 1402 | { |
||
| 1403 | return 'DROP DATABASE ' . $database; |
||
| 1404 | } |
||
| 1405 | |||
| 1406 | /** |
||
| 1407 | * Returns the SQL snippet to drop an existing table. |
||
| 1408 | * |
||
| 1409 | * @param Table|string $table |
||
| 1410 | * |
||
| 1411 | * @return string |
||
| 1412 | * |
||
| 1413 | * @throws InvalidArgumentException |
||
| 1414 | */ |
||
| 1415 | public function getDropTableSQL($table) |
||
| 1416 | { |
||
| 1417 | $tableArg = $table; |
||
| 1418 | |||
| 1419 | if ($table instanceof Table) { |
||
| 1420 | $table = $table->getQuotedName($this); |
||
| 1421 | } |
||
| 1422 | |||
| 1423 | if (! is_string($table)) { |
||
| 1424 | throw new InvalidArgumentException('getDropTableSQL() expects $table parameter to be string or \Doctrine\DBAL\Schema\Table.'); |
||
| 1425 | } |
||
| 1426 | |||
| 1427 | if ($this->_eventManager !== null && $this->_eventManager->hasListeners(Events::onSchemaDropTable)) { |
||
| 1428 | $eventArgs = new SchemaDropTableEventArgs($tableArg, $this); |
||
| 1429 | $this->_eventManager->dispatchEvent(Events::onSchemaDropTable, $eventArgs); |
||
| 1430 | |||
| 1431 | if ($eventArgs->isDefaultPrevented()) { |
||
| 1432 | $sql = $eventArgs->getSql(); |
||
| 1433 | |||
| 1434 | if ($sql === null) { |
||
| 1435 | throw new UnexpectedValueException('Default implementation of DROP TABLE was overridden with NULL'); |
||
| 1436 | } |
||
| 1437 | |||
| 1438 | return $sql; |
||
| 1439 | } |
||
| 1440 | } |
||
| 1441 | |||
| 1442 | return 'DROP TABLE ' . $table; |
||
| 1443 | } |
||
| 1444 | |||
| 1445 | /** |
||
| 1446 | * Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction. |
||
| 1447 | * |
||
| 1448 | * @param Table|string $table |
||
| 1449 | * |
||
| 1450 | * @return string |
||
| 1451 | */ |
||
| 1452 | public function getDropTemporaryTableSQL($table) |
||
| 1453 | { |
||
| 1454 | return $this->getDropTableSQL($table); |
||
| 1455 | } |
||
| 1456 | |||
| 1457 | /** |
||
| 1458 | * Returns the SQL to drop an index from a table. |
||
| 1459 | * |
||
| 1460 | * @param Index|string $index |
||
| 1461 | * @param Table|string $table |
||
| 1462 | * |
||
| 1463 | * @return string |
||
| 1464 | * |
||
| 1465 | * @throws InvalidArgumentException |
||
| 1466 | */ |
||
| 1467 | public function getDropIndexSQL($index, $table = null) |
||
| 1468 | { |
||
| 1469 | if ($index instanceof Index) { |
||
| 1470 | $index = $index->getQuotedName($this); |
||
| 1471 | } elseif (! is_string($index)) { |
||
| 1472 | throw new InvalidArgumentException('AbstractPlatform::getDropIndexSQL() expects $index parameter to be string or \Doctrine\DBAL\Schema\Index.'); |
||
| 1473 | } |
||
| 1474 | |||
| 1475 | return 'DROP INDEX ' . $index; |
||
| 1476 | } |
||
| 1477 | |||
| 1478 | /** |
||
| 1479 | * Returns the SQL to drop a constraint. |
||
| 1480 | * |
||
| 1481 | * @param Constraint|string $constraint |
||
| 1482 | * @param Table|string $table |
||
| 1483 | * |
||
| 1484 | * @return string |
||
| 1485 | */ |
||
| 1486 | public function getDropConstraintSQL($constraint, $table) |
||
| 1487 | { |
||
| 1488 | if (! $constraint instanceof Constraint) { |
||
| 1489 | $constraint = new Identifier($constraint); |
||
| 1490 | } |
||
| 1491 | |||
| 1492 | if (! $table instanceof Table) { |
||
| 1493 | $table = new Identifier($table); |
||
| 1494 | } |
||
| 1495 | |||
| 1496 | $constraint = $constraint->getQuotedName($this); |
||
| 1497 | $table = $table->getQuotedName($this); |
||
| 1498 | |||
| 1499 | return 'ALTER TABLE ' . $table . ' DROP CONSTRAINT ' . $constraint; |
||
| 1500 | } |
||
| 1501 | |||
| 1502 | /** |
||
| 1503 | * Returns the SQL to drop a foreign key. |
||
| 1504 | * |
||
| 1505 | * @param ForeignKeyConstraint|string $foreignKey |
||
| 1506 | * @param Table|string $table |
||
| 1507 | * |
||
| 1508 | * @return string |
||
| 1509 | */ |
||
| 1510 | public function getDropForeignKeySQL($foreignKey, $table) |
||
| 1511 | { |
||
| 1512 | if (! $foreignKey instanceof ForeignKeyConstraint) { |
||
| 1513 | $foreignKey = new Identifier($foreignKey); |
||
| 1514 | } |
||
| 1515 | |||
| 1516 | if (! $table instanceof Table) { |
||
| 1517 | $table = new Identifier($table); |
||
| 1518 | } |
||
| 1519 | |||
| 1520 | $foreignKey = $foreignKey->getQuotedName($this); |
||
| 1521 | $table = $table->getQuotedName($this); |
||
| 1522 | |||
| 1523 | return 'ALTER TABLE ' . $table . ' DROP FOREIGN KEY ' . $foreignKey; |
||
| 1524 | } |
||
| 1525 | |||
| 1526 | /** |
||
| 1527 | * Returns the SQL statement(s) to create a table with the specified name, columns and constraints |
||
| 1528 | * on this platform. |
||
| 1529 | * |
||
| 1530 | * @param int $createFlags |
||
| 1531 | * |
||
| 1532 | * @return string[] The sequence of SQL statements. |
||
| 1533 | * |
||
| 1534 | * @throws DBALException |
||
| 1535 | * @throws InvalidArgumentException |
||
| 1536 | */ |
||
| 1537 | public function getCreateTableSQL(Table $table, $createFlags = self::CREATE_INDEXES) |
||
| 1538 | { |
||
| 1539 | if (! is_int($createFlags)) { |
||
| 1540 | throw new InvalidArgumentException('Second argument of AbstractPlatform::getCreateTableSQL() has to be integer.'); |
||
| 1541 | } |
||
| 1542 | |||
| 1543 | if (count($table->getColumns()) === 0) { |
||
| 1544 | throw DBALException::noColumnsSpecifiedForTable($table->getName()); |
||
| 1545 | } |
||
| 1546 | |||
| 1547 | $tableName = $table->getQuotedName($this); |
||
| 1548 | $options = $table->getOptions(); |
||
| 1549 | $options['uniqueConstraints'] = []; |
||
| 1550 | $options['indexes'] = []; |
||
| 1551 | $options['primary'] = []; |
||
| 1552 | |||
| 1553 | if (($createFlags&self::CREATE_INDEXES) > 0) { |
||
| 1554 | foreach ($table->getIndexes() as $index) { |
||
| 1555 | /** @var $index Index */ |
||
| 1556 | if ($index->isPrimary()) { |
||
| 1557 | $options['primary'] = $index->getQuotedColumns($this); |
||
| 1558 | $options['primary_index'] = $index; |
||
| 1559 | } else { |
||
| 1560 | $options['indexes'][$index->getQuotedName($this)] = $index; |
||
| 1561 | } |
||
| 1562 | } |
||
| 1563 | } |
||
| 1564 | |||
| 1565 | $columnSql = []; |
||
| 1566 | $columns = []; |
||
| 1567 | |||
| 1568 | foreach ($table->getColumns() as $column) { |
||
| 1569 | if ($this->_eventManager !== null && $this->_eventManager->hasListeners(Events::onSchemaCreateTableColumn)) { |
||
| 1570 | $eventArgs = new SchemaCreateTableColumnEventArgs($column, $table, $this); |
||
| 1571 | $this->_eventManager->dispatchEvent(Events::onSchemaCreateTableColumn, $eventArgs); |
||
| 1572 | |||
| 1573 | $columnSql = array_merge($columnSql, $eventArgs->getSql()); |
||
| 1574 | |||
| 1575 | if ($eventArgs->isDefaultPrevented()) { |
||
| 1576 | continue; |
||
| 1577 | } |
||
| 1578 | } |
||
| 1579 | |||
| 1580 | $columnData = $column->toArray(); |
||
| 1581 | $columnData['name'] = $column->getQuotedName($this); |
||
| 1582 | $columnData['version'] = $column->hasPlatformOption('version') ? $column->getPlatformOption('version') : false; |
||
| 1583 | $columnData['comment'] = $this->getColumnComment($column); |
||
| 1584 | |||
| 1585 | if ($columnData['type'] instanceof Types\StringType && $columnData['length'] === null) { |
||
| 1586 | $columnData['length'] = 255; |
||
| 1587 | } |
||
| 1588 | |||
| 1589 | if (in_array($column->getName(), $options['primary'], true)) { |
||
| 1590 | $columnData['primary'] = true; |
||
| 1591 | } |
||
| 1592 | |||
| 1593 | $columns[$columnData['name']] = $columnData; |
||
| 1594 | } |
||
| 1595 | |||
| 1596 | if (($createFlags&self::CREATE_FOREIGNKEYS) > 0) { |
||
| 1597 | $options['foreignKeys'] = []; |
||
| 1598 | foreach ($table->getForeignKeys() as $fkConstraint) { |
||
| 1599 | $options['foreignKeys'][] = $fkConstraint; |
||
| 1600 | } |
||
| 1601 | } |
||
| 1602 | |||
| 1603 | if ($this->_eventManager !== null && $this->_eventManager->hasListeners(Events::onSchemaCreateTable)) { |
||
| 1604 | $eventArgs = new SchemaCreateTableEventArgs($table, $columns, $options, $this); |
||
| 1605 | $this->_eventManager->dispatchEvent(Events::onSchemaCreateTable, $eventArgs); |
||
| 1606 | |||
| 1607 | if ($eventArgs->isDefaultPrevented()) { |
||
| 1608 | return array_merge($eventArgs->getSql(), $columnSql); |
||
| 1609 | } |
||
| 1610 | } |
||
| 1611 | |||
| 1612 | $sql = $this->_getCreateTableSQL($tableName, $columns, $options); |
||
| 1613 | if ($this->supportsCommentOnStatement()) { |
||
| 1614 | if ($table->hasOption('comment')) { |
||
| 1615 | $sql[] = $this->getCommentOnTableSQL($tableName, $table->getOption('comment')); |
||
| 1616 | } |
||
| 1617 | foreach ($table->getColumns() as $column) { |
||
| 1618 | $comment = $this->getColumnComment($column); |
||
| 1619 | |||
| 1620 | if ($comment === null || $comment === '') { |
||
| 1621 | continue; |
||
| 1622 | } |
||
| 1623 | |||
| 1624 | $sql[] = $this->getCommentOnColumnSQL($tableName, $column->getQuotedName($this), $comment); |
||
| 1625 | } |
||
| 1626 | } |
||
| 1627 | |||
| 1628 | return array_merge($sql, $columnSql); |
||
| 1629 | } |
||
| 1630 | |||
| 1631 | protected function getCommentOnTableSQL(string $tableName, ?string $comment) : string |
||
| 1632 | { |
||
| 1633 | $tableName = new Identifier($tableName); |
||
| 1634 | |||
| 1635 | return sprintf( |
||
| 1636 | 'COMMENT ON TABLE %s IS %s', |
||
| 1637 | $tableName->getQuotedName($this), |
||
| 1638 | $this->quoteStringLiteral((string) $comment) |
||
| 1639 | ); |
||
| 1640 | } |
||
| 1641 | |||
| 1642 | /** |
||
| 1643 | * @param string $tableName |
||
| 1644 | * @param string $columnName |
||
| 1645 | * @param string|null $comment |
||
| 1646 | * |
||
| 1647 | * @return string |
||
| 1648 | */ |
||
| 1649 | public function getCommentOnColumnSQL($tableName, $columnName, $comment) |
||
| 1650 | { |
||
| 1651 | $tableName = new Identifier($tableName); |
||
| 1652 | $columnName = new Identifier($columnName); |
||
| 1653 | |||
| 1654 | return sprintf( |
||
| 1655 | 'COMMENT ON COLUMN %s.%s IS %s', |
||
| 1656 | $tableName->getQuotedName($this), |
||
| 1657 | $columnName->getQuotedName($this), |
||
| 1658 | $this->quoteStringLiteral((string) $comment) |
||
| 1659 | ); |
||
| 1660 | } |
||
| 1661 | |||
| 1662 | /** |
||
| 1663 | * Returns the SQL to create inline comment on a column. |
||
| 1664 | * |
||
| 1665 | * @param string $comment |
||
| 1666 | * |
||
| 1667 | * @return string |
||
| 1668 | * |
||
| 1669 | * @throws DBALException If not supported on this platform. |
||
| 1670 | */ |
||
| 1671 | public function getInlineColumnCommentSQL($comment) |
||
| 1672 | { |
||
| 1673 | if (! $this->supportsInlineColumnComments()) { |
||
| 1674 | throw DBALException::notSupported(__METHOD__); |
||
| 1675 | } |
||
| 1676 | |||
| 1677 | return 'COMMENT ' . $this->quoteStringLiteral($comment); |
||
| 1678 | } |
||
| 1679 | |||
| 1680 | /** |
||
| 1681 | * Returns the SQL used to create a table. |
||
| 1682 | * |
||
| 1683 | * @param string $tableName |
||
| 1684 | * @param mixed[][] $columns |
||
| 1685 | * @param mixed[] $options |
||
| 1686 | * |
||
| 1687 | * @return string[] |
||
| 1688 | */ |
||
| 1689 | protected function _getCreateTableSQL($tableName, array $columns, array $options = []) |
||
| 1690 | { |
||
| 1691 | $columnListSql = $this->getColumnDeclarationListSQL($columns); |
||
| 1692 | |||
| 1693 | if (isset($options['uniqueConstraints']) && ! empty($options['uniqueConstraints'])) { |
||
| 1694 | foreach ($options['uniqueConstraints'] as $name => $definition) { |
||
| 1695 | $columnListSql .= ', ' . $this->getUniqueConstraintDeclarationSQL($name, $definition); |
||
| 1696 | } |
||
| 1697 | } |
||
| 1698 | |||
| 1699 | if (isset($options['primary']) && ! empty($options['primary'])) { |
||
| 1700 | $columnListSql .= ', PRIMARY KEY(' . implode(', ', array_unique(array_values($options['primary']))) . ')'; |
||
| 1701 | } |
||
| 1702 | |||
| 1703 | if (isset($options['indexes']) && ! empty($options['indexes'])) { |
||
| 1704 | foreach ($options['indexes'] as $index => $definition) { |
||
| 1705 | $columnListSql .= ', ' . $this->getIndexDeclarationSQL($index, $definition); |
||
| 1706 | } |
||
| 1707 | } |
||
| 1708 | |||
| 1709 | $query = 'CREATE TABLE ' . $tableName . ' (' . $columnListSql; |
||
| 1710 | |||
| 1711 | $check = $this->getCheckDeclarationSQL($columns); |
||
| 1712 | if (! empty($check)) { |
||
| 1713 | $query .= ', ' . $check; |
||
| 1714 | } |
||
| 1715 | $query .= ')'; |
||
| 1716 | |||
| 1717 | $sql = [$query]; |
||
| 1718 | |||
| 1719 | if (isset($options['foreignKeys'])) { |
||
| 1720 | foreach ((array) $options['foreignKeys'] as $definition) { |
||
| 1721 | $sql[] = $this->getCreateForeignKeySQL($definition, $tableName); |
||
| 1722 | } |
||
| 1723 | } |
||
| 1724 | |||
| 1725 | return $sql; |
||
| 1726 | } |
||
| 1727 | |||
| 1728 | /** |
||
| 1729 | * @return string |
||
| 1730 | */ |
||
| 1731 | public function getCreateTemporaryTableSnippetSQL() |
||
| 1732 | { |
||
| 1733 | return 'CREATE TEMPORARY TABLE'; |
||
| 1734 | } |
||
| 1735 | |||
| 1736 | /** |
||
| 1737 | * Returns the SQL to create a sequence on this platform. |
||
| 1738 | * |
||
| 1739 | * @return string |
||
| 1740 | * |
||
| 1741 | * @throws DBALException If not supported on this platform. |
||
| 1742 | */ |
||
| 1743 | public function getCreateSequenceSQL(Sequence $sequence) |
||
| 1744 | { |
||
| 1745 | throw DBALException::notSupported(__METHOD__); |
||
| 1746 | } |
||
| 1747 | |||
| 1748 | /** |
||
| 1749 | * Returns the SQL to change a sequence on this platform. |
||
| 1750 | * |
||
| 1751 | * @return string |
||
| 1752 | * |
||
| 1753 | * @throws DBALException If not supported on this platform. |
||
| 1754 | */ |
||
| 1755 | public function getAlterSequenceSQL(Sequence $sequence) |
||
| 1756 | { |
||
| 1757 | throw DBALException::notSupported(__METHOD__); |
||
| 1758 | } |
||
| 1759 | |||
| 1760 | /** |
||
| 1761 | * Returns the SQL to create a constraint on a table on this platform. |
||
| 1762 | * |
||
| 1763 | * @param Table|string $table |
||
| 1764 | * |
||
| 1765 | * @return string |
||
| 1766 | * |
||
| 1767 | * @throws InvalidArgumentException |
||
| 1768 | */ |
||
| 1769 | public function getCreateConstraintSQL(Constraint $constraint, $table) |
||
| 1770 | { |
||
| 1771 | if ($table instanceof Table) { |
||
| 1772 | $table = $table->getQuotedName($this); |
||
| 1773 | } |
||
| 1774 | |||
| 1775 | $query = 'ALTER TABLE ' . $table . ' ADD CONSTRAINT ' . $constraint->getQuotedName($this); |
||
| 1776 | |||
| 1777 | $columnList = '(' . implode(', ', $constraint->getQuotedColumns($this)) . ')'; |
||
| 1778 | |||
| 1779 | $referencesClause = ''; |
||
| 1780 | if ($constraint instanceof Index) { |
||
| 1781 | if ($constraint->isPrimary()) { |
||
| 1782 | $query .= ' PRIMARY KEY'; |
||
| 1783 | } elseif ($constraint->isUnique()) { |
||
| 1784 | $query .= ' UNIQUE'; |
||
| 1785 | } else { |
||
| 1786 | throw new InvalidArgumentException( |
||
| 1787 | 'Can only create primary or unique constraints, no common indexes with getCreateConstraintSQL().' |
||
| 1788 | ); |
||
| 1789 | } |
||
| 1790 | } elseif ($constraint instanceof ForeignKeyConstraint) { |
||
| 1791 | $query .= ' FOREIGN KEY'; |
||
| 1792 | |||
| 1793 | $referencesClause = ' REFERENCES ' . $constraint->getQuotedForeignTableName($this) . |
||
| 1794 | ' (' . implode(', ', $constraint->getQuotedForeignColumns($this)) . ')'; |
||
| 1795 | } |
||
| 1796 | $query .= ' ' . $columnList . $referencesClause; |
||
| 1797 | |||
| 1798 | return $query; |
||
| 1799 | } |
||
| 1800 | |||
| 1801 | /** |
||
| 1802 | * Returns the SQL to create an index on a table on this platform. |
||
| 1803 | * |
||
| 1804 | * @param Table|string $table The name of the table on which the index is to be created. |
||
| 1805 | * |
||
| 1806 | * @return string |
||
| 1807 | * |
||
| 1808 | * @throws InvalidArgumentException |
||
| 1809 | */ |
||
| 1810 | public function getCreateIndexSQL(Index $index, $table) |
||
| 1811 | { |
||
| 1812 | if ($table instanceof Table) { |
||
| 1813 | $table = $table->getQuotedName($this); |
||
| 1814 | } |
||
| 1815 | $name = $index->getQuotedName($this); |
||
| 1816 | $columns = $index->getColumns(); |
||
| 1817 | |||
| 1818 | if (count($columns) === 0) { |
||
| 1819 | throw new InvalidArgumentException("Incomplete definition. 'columns' required."); |
||
| 1820 | } |
||
| 1821 | |||
| 1822 | if ($index->isPrimary()) { |
||
| 1823 | return $this->getCreatePrimaryKeySQL($index, $table); |
||
| 1824 | } |
||
| 1825 | |||
| 1826 | $query = 'CREATE ' . $this->getCreateIndexSQLFlags($index) . 'INDEX ' . $name . ' ON ' . $table; |
||
| 1827 | $query .= ' (' . $this->getIndexFieldDeclarationListSQL($index) . ')' . $this->getPartialIndexSQL($index); |
||
| 1828 | |||
| 1829 | return $query; |
||
| 1830 | } |
||
| 1831 | |||
| 1832 | /** |
||
| 1833 | * Adds condition for partial index. |
||
| 1834 | * |
||
| 1835 | * @return string |
||
| 1836 | */ |
||
| 1837 | protected function getPartialIndexSQL(Index $index) |
||
| 1838 | { |
||
| 1839 | if ($this->supportsPartialIndexes() && $index->hasOption('where')) { |
||
| 1840 | return ' WHERE ' . $index->getOption('where'); |
||
| 1841 | } |
||
| 1842 | |||
| 1843 | return ''; |
||
| 1844 | } |
||
| 1845 | |||
| 1846 | /** |
||
| 1847 | * Adds additional flags for index generation. |
||
| 1848 | * |
||
| 1849 | * @return string |
||
| 1850 | */ |
||
| 1851 | protected function getCreateIndexSQLFlags(Index $index) |
||
| 1852 | { |
||
| 1853 | return $index->isUnique() ? 'UNIQUE ' : ''; |
||
| 1854 | } |
||
| 1855 | |||
| 1856 | /** |
||
| 1857 | * Returns the SQL to create an unnamed primary key constraint. |
||
| 1858 | * |
||
| 1859 | * @param Table|string $table |
||
| 1860 | * |
||
| 1861 | * @return string |
||
| 1862 | */ |
||
| 1863 | public function getCreatePrimaryKeySQL(Index $index, $table) |
||
| 1864 | { |
||
| 1865 | if ($table instanceof Table) { |
||
| 1866 | $table = $table->getQuotedName($this); |
||
| 1867 | } |
||
| 1868 | |||
| 1869 | return 'ALTER TABLE ' . $table . ' ADD PRIMARY KEY (' . $this->getIndexFieldDeclarationListSQL($index) . ')'; |
||
| 1870 | } |
||
| 1871 | |||
| 1872 | /** |
||
| 1873 | * Returns the SQL to create a named schema. |
||
| 1874 | * |
||
| 1875 | * @param string $schemaName |
||
| 1876 | * |
||
| 1877 | * @return string |
||
| 1878 | * |
||
| 1879 | * @throws DBALException If not supported on this platform. |
||
| 1880 | */ |
||
| 1881 | public function getCreateSchemaSQL($schemaName) |
||
| 1884 | } |
||
| 1885 | |||
| 1886 | /** |
||
| 1887 | * Quotes a string so that it can be safely used as a table or column name, |
||
| 1888 | * even if it is a reserved word of the platform. This also detects identifier |
||
| 1889 | * chains separated by dot and quotes them independently. |
||
| 1890 | * |
||
| 1891 | * NOTE: Just because you CAN use quoted identifiers doesn't mean |
||
| 1892 | * you SHOULD use them. In general, they end up causing way more |
||
| 1893 | * problems than they solve. |
||
| 1894 | * |
||
| 1895 | * @param string $str The identifier name to be quoted. |
||
| 1896 | * |
||
| 1897 | * @return string The quoted identifier string. |
||
| 1898 | */ |
||
| 1899 | public function quoteIdentifier($str) |
||
| 1900 | { |
||
| 1901 | if (strpos($str, '.') !== false) { |
||
| 1902 | $parts = array_map([$this, 'quoteSingleIdentifier'], explode('.', $str)); |
||
| 1903 | |||
| 1904 | return implode('.', $parts); |
||
| 1905 | } |
||
| 1906 | |||
| 1907 | return $this->quoteSingleIdentifier($str); |
||
| 1908 | } |
||
| 1909 | |||
| 1910 | /** |
||
| 1911 | * Quotes a single identifier (no dot chain separation). |
||
| 1912 | * |
||
| 1913 | * @param string $str The identifier name to be quoted. |
||
| 1914 | * |
||
| 1915 | * @return string The quoted identifier string. |
||
| 1916 | */ |
||
| 1917 | public function quoteSingleIdentifier($str) |
||
| 1918 | { |
||
| 1919 | $c = $this->getIdentifierQuoteCharacter(); |
||
| 1920 | |||
| 1921 | return $c . str_replace($c, $c . $c, $str) . $c; |
||
| 1922 | } |
||
| 1923 | |||
| 1924 | /** |
||
| 1925 | * Returns the SQL to create a new foreign key. |
||
| 1926 | * |
||
| 1927 | * @param ForeignKeyConstraint $foreignKey The foreign key constraint. |
||
| 1928 | * @param Table|string $table The name of the table on which the foreign key is to be created. |
||
| 1929 | * |
||
| 1930 | * @return string |
||
| 1931 | */ |
||
| 1932 | public function getCreateForeignKeySQL(ForeignKeyConstraint $foreignKey, $table) |
||
| 1933 | { |
||
| 1934 | if ($table instanceof Table) { |
||
| 1935 | $table = $table->getQuotedName($this); |
||
| 1936 | } |
||
| 1937 | |||
| 1938 | return 'ALTER TABLE ' . $table . ' ADD ' . $this->getForeignKeyDeclarationSQL($foreignKey); |
||
| 1939 | } |
||
| 1940 | |||
| 1941 | /** |
||
| 1942 | * Gets the SQL statements for altering an existing table. |
||
| 1943 | * |
||
| 1944 | * This method returns an array of SQL statements, since some platforms need several statements. |
||
| 1945 | * |
||
| 1946 | * @return string[] |
||
| 1947 | * |
||
| 1948 | * @throws DBALException If not supported on this platform. |
||
| 1949 | */ |
||
| 1950 | public function getAlterTableSQL(TableDiff $diff) |
||
| 1951 | { |
||
| 1952 | throw DBALException::notSupported(__METHOD__); |
||
| 1953 | } |
||
| 1954 | |||
| 1955 | /** |
||
| 1956 | * @param mixed[] $columnSql |
||
| 1957 | * |
||
| 1958 | * @return bool |
||
| 1959 | */ |
||
| 1960 | protected function onSchemaAlterTableAddColumn(Column $column, TableDiff $diff, &$columnSql) |
||
| 1961 | { |
||
| 1962 | if ($this->_eventManager === null) { |
||
| 1963 | return false; |
||
| 1964 | } |
||
| 1965 | |||
| 1966 | if (! $this->_eventManager->hasListeners(Events::onSchemaAlterTableAddColumn)) { |
||
| 1967 | return false; |
||
| 1968 | } |
||
| 1969 | |||
| 1970 | $eventArgs = new SchemaAlterTableAddColumnEventArgs($column, $diff, $this); |
||
| 1971 | $this->_eventManager->dispatchEvent(Events::onSchemaAlterTableAddColumn, $eventArgs); |
||
| 1972 | |||
| 1973 | $columnSql = array_merge($columnSql, $eventArgs->getSql()); |
||
| 1974 | |||
| 1975 | return $eventArgs->isDefaultPrevented(); |
||
| 1976 | } |
||
| 1977 | |||
| 1978 | /** |
||
| 1979 | * @param string[] $columnSql |
||
| 1980 | * |
||
| 1981 | * @return bool |
||
| 1982 | */ |
||
| 1983 | protected function onSchemaAlterTableRemoveColumn(Column $column, TableDiff $diff, &$columnSql) |
||
| 1984 | { |
||
| 1985 | if ($this->_eventManager === null) { |
||
| 1986 | return false; |
||
| 1987 | } |
||
| 1988 | |||
| 1989 | if (! $this->_eventManager->hasListeners(Events::onSchemaAlterTableRemoveColumn)) { |
||
| 1990 | return false; |
||
| 1991 | } |
||
| 1992 | |||
| 1993 | $eventArgs = new SchemaAlterTableRemoveColumnEventArgs($column, $diff, $this); |
||
| 1994 | $this->_eventManager->dispatchEvent(Events::onSchemaAlterTableRemoveColumn, $eventArgs); |
||
| 1995 | |||
| 1996 | $columnSql = array_merge($columnSql, $eventArgs->getSql()); |
||
| 1997 | |||
| 1998 | return $eventArgs->isDefaultPrevented(); |
||
| 1999 | } |
||
| 2000 | |||
| 2001 | /** |
||
| 2002 | * @param string[] $columnSql |
||
| 2003 | * |
||
| 2004 | * @return bool |
||
| 2005 | */ |
||
| 2006 | protected function onSchemaAlterTableChangeColumn(ColumnDiff $columnDiff, TableDiff $diff, &$columnSql) |
||
| 2007 | { |
||
| 2008 | if ($this->_eventManager === null) { |
||
| 2009 | return false; |
||
| 2010 | } |
||
| 2011 | |||
| 2012 | if (! $this->_eventManager->hasListeners(Events::onSchemaAlterTableChangeColumn)) { |
||
| 2013 | return false; |
||
| 2014 | } |
||
| 2015 | |||
| 2016 | $eventArgs = new SchemaAlterTableChangeColumnEventArgs($columnDiff, $diff, $this); |
||
| 2017 | $this->_eventManager->dispatchEvent(Events::onSchemaAlterTableChangeColumn, $eventArgs); |
||
| 2018 | |||
| 2019 | $columnSql = array_merge($columnSql, $eventArgs->getSql()); |
||
| 2020 | |||
| 2021 | return $eventArgs->isDefaultPrevented(); |
||
| 2022 | } |
||
| 2023 | |||
| 2024 | /** |
||
| 2025 | * @param string $oldColumnName |
||
| 2026 | * @param string[] $columnSql |
||
| 2027 | * |
||
| 2028 | * @return bool |
||
| 2029 | */ |
||
| 2030 | protected function onSchemaAlterTableRenameColumn($oldColumnName, Column $column, TableDiff $diff, &$columnSql) |
||
| 2046 | } |
||
| 2047 | |||
| 2048 | /** |
||
| 2049 | * @param string[] $sql |
||
| 2050 | * |
||
| 2051 | * @return bool |
||
| 2052 | */ |
||
| 2053 | protected function onSchemaAlterTable(TableDiff $diff, &$sql) |
||
| 2054 | { |
||
| 2055 | if ($this->_eventManager === null) { |
||
| 2056 | return false; |
||
| 2057 | } |
||
| 2058 | |||
| 2059 | if (! $this->_eventManager->hasListeners(Events::onSchemaAlterTable)) { |
||
| 2060 | return false; |
||
| 2061 | } |
||
| 2062 | |||
| 2063 | $eventArgs = new SchemaAlterTableEventArgs($diff, $this); |
||
| 2064 | $this->_eventManager->dispatchEvent(Events::onSchemaAlterTable, $eventArgs); |
||
| 2065 | |||
| 2066 | $sql = array_merge($sql, $eventArgs->getSql()); |
||
| 2067 | |||
| 2068 | return $eventArgs->isDefaultPrevented(); |
||
| 2069 | } |
||
| 2070 | |||
| 2071 | /** |
||
| 2072 | * @return string[] |
||
| 2073 | */ |
||
| 2074 | protected function getPreAlterTableIndexForeignKeySQL(TableDiff $diff) |
||
| 2096 | } |
||
| 2097 | |||
| 2098 | /** |
||
| 2099 | * @return string[] |
||
| 2100 | */ |
||
| 2101 | protected function getPostAlterTableIndexForeignKeySQL(TableDiff $diff) |
||
| 2102 | { |
||
| 2103 | $sql = []; |
||
| 2104 | $newName = $diff->getNewName(); |
||
| 2105 | |||
| 2106 | if ($newName !== false) { |
||
| 2107 | $tableName = $newName->getQuotedName($this); |
||
| 2108 | } else { |
||
| 2109 | $tableName = $diff->getName($this)->getQuotedName($this); |
||
| 2110 | } |
||
| 2111 | |||
| 2112 | if ($this->supportsForeignKeyConstraints()) { |
||
| 2113 | foreach ($diff->addedForeignKeys as $foreignKey) { |
||
| 2114 | $sql[] = $this->getCreateForeignKeySQL($foreignKey, $tableName); |
||
| 2115 | } |
||
| 2116 | |||
| 2117 | foreach ($diff->changedForeignKeys as $foreignKey) { |
||
| 2118 | $sql[] = $this->getCreateForeignKeySQL($foreignKey, $tableName); |
||
| 2119 | } |
||
| 2120 | } |
||
| 2121 | |||
| 2122 | foreach ($diff->addedIndexes as $index) { |
||
| 2123 | $sql[] = $this->getCreateIndexSQL($index, $tableName); |
||
| 2124 | } |
||
| 2125 | |||
| 2126 | foreach ($diff->changedIndexes as $index) { |
||
| 2127 | $sql[] = $this->getCreateIndexSQL($index, $tableName); |
||
| 2128 | } |
||
| 2129 | |||
| 2130 | foreach ($diff->renamedIndexes as $oldIndexName => $index) { |
||
| 2131 | $oldIndexName = new Identifier($oldIndexName); |
||
| 2132 | $sql = array_merge( |
||
| 2133 | $sql, |
||
| 2134 | $this->getRenameIndexSQL($oldIndexName->getQuotedName($this), $index, $tableName) |
||
| 2135 | ); |
||
| 2136 | } |
||
| 2137 | |||
| 2138 | return $sql; |
||
| 2139 | } |
||
| 2140 | |||
| 2141 | /** |
||
| 2142 | * Returns the SQL for renaming an index on a table. |
||
| 2143 | * |
||
| 2144 | * @param string $oldIndexName The name of the index to rename from. |
||
| 2145 | * @param Index $index The definition of the index to rename to. |
||
| 2146 | * @param string $tableName The table to rename the given index on. |
||
| 2147 | * |
||
| 2148 | * @return string[] The sequence of SQL statements for renaming the given index. |
||
| 2149 | */ |
||
| 2150 | protected function getRenameIndexSQL($oldIndexName, Index $index, $tableName) |
||
| 2155 | ]; |
||
| 2156 | } |
||
| 2157 | |||
| 2158 | /** |
||
| 2159 | * Common code for alter table statement generation that updates the changed Index and Foreign Key definitions. |
||
| 2160 | * |
||
| 2161 | * @deprecated |
||
| 2162 | * |
||
| 2163 | * @return string[] |
||
| 2164 | */ |
||
| 2165 | protected function _getAlterTableIndexForeignKeySQL(TableDiff $diff) |
||
| 2168 | } |
||
| 2169 | |||
| 2170 | /** |
||
| 2171 | * Gets declaration of a number of fields in bulk. |
||
| 2172 | * |
||
| 2173 | * @param mixed[][] $fields A multidimensional associative array. |
||
| 2174 | * The first dimension determines the field name, while the second |
||
| 2175 | * dimension is keyed with the name of the properties |
||
| 2176 | * of the field being declared as array indexes. Currently, the types |
||
| 2177 | * of supported field properties are as follows: |
||
| 2178 | * |
||
| 2179 | * length |
||
| 2180 | * Integer value that determines the maximum length of the text |
||
| 2181 | * field. If this argument is missing the field should be |
||
| 2182 | * declared to have the longest length allowed by the DBMS. |
||
| 2183 | * |
||
| 2184 | * default |
||
| 2185 | * Text value to be used as default for this field. |
||
| 2186 | * |
||
| 2187 | * notnull |
||
| 2188 | * Boolean flag that indicates whether this field is constrained |
||
| 2189 | * to not be set to null. |
||
| 2190 | * charset |
||
| 2191 | * Text value with the default CHARACTER SET for this field. |
||
| 2192 | * collation |
||
| 2193 | * Text value with the default COLLATION for this field. |
||
| 2194 | * unique |
||
| 2195 | * unique constraint |
||
| 2196 | * |
||
| 2197 | * @return string |
||
| 2198 | */ |
||
| 2199 | public function getColumnDeclarationListSQL(array $fields) |
||
| 2200 | { |
||
| 2201 | $queryFields = []; |
||
| 2202 | |||
| 2203 | foreach ($fields as $fieldName => $field) { |
||
| 2204 | $queryFields[] = $this->getColumnDeclarationSQL($fieldName, $field); |
||
| 2205 | } |
||
| 2206 | |||
| 2207 | return implode(', ', $queryFields); |
||
| 2208 | } |
||
| 2209 | |||
| 2210 | /** |
||
| 2211 | * Obtains DBMS specific SQL code portion needed to declare a generic type |
||
| 2212 | * field to be used in statements like CREATE TABLE. |
||
| 2213 | * |
||
| 2214 | * @param string $name The name the field to be declared. |
||
| 2215 | * @param mixed[] $field An associative array with the name of the properties |
||
| 2216 | * of the field being declared as array indexes. Currently, the types |
||
| 2217 | * of supported field properties are as follows: |
||
| 2218 | * |
||
| 2219 | * length |
||
| 2220 | * Integer value that determines the maximum length of the text |
||
| 2221 | * field. If this argument is missing the field should be |
||
| 2222 | * declared to have the longest length allowed by the DBMS. |
||
| 2223 | * |
||
| 2224 | * default |
||
| 2225 | * Text value to be used as default for this field. |
||
| 2226 | * |
||
| 2227 | * notnull |
||
| 2228 | * Boolean flag that indicates whether this field is constrained |
||
| 2229 | * to not be set to null. |
||
| 2230 | * charset |
||
| 2231 | * Text value with the default CHARACTER SET for this field. |
||
| 2232 | * collation |
||
| 2233 | * Text value with the default COLLATION for this field. |
||
| 2234 | * unique |
||
| 2235 | * unique constraint |
||
| 2236 | * check |
||
| 2237 | * column check constraint |
||
| 2238 | * columnDefinition |
||
| 2239 | * a string that defines the complete column |
||
| 2240 | * |
||
| 2241 | * @return string DBMS specific SQL code portion that should be used to declare the column. |
||
| 2242 | */ |
||
| 2243 | public function getColumnDeclarationSQL($name, array $field) |
||
| 2244 | { |
||
| 2245 | if (isset($field['columnDefinition'])) { |
||
| 2246 | $columnDef = $this->getCustomTypeDeclarationSQL($field); |
||
| 2247 | } else { |
||
| 2248 | $default = $this->getDefaultValueDeclarationSQL($field); |
||
| 2249 | |||
| 2250 | $charset = ! empty($field['charset']) ? |
||
| 2251 | ' ' . $this->getColumnCharsetDeclarationSQL($field['charset']) : ''; |
||
| 2252 | |||
| 2253 | $collation = ! empty($field['collation']) ? |
||
| 2254 | ' ' . $this->getColumnCollationDeclarationSQL($field['collation']) : ''; |
||
| 2255 | |||
| 2256 | $notnull = ! empty($field['notnull']) ? ' NOT NULL' : ''; |
||
| 2257 | |||
| 2258 | $unique = ! empty($field['unique']) ? |
||
| 2259 | ' ' . $this->getUniqueFieldDeclarationSQL() : ''; |
||
| 2260 | |||
| 2261 | $check = ! empty($field['check']) ? ' ' . $field['check'] : ''; |
||
| 2262 | |||
| 2263 | $typeDecl = $field['type']->getSQLDeclaration($field, $this); |
||
| 2264 | $columnDef = $typeDecl . $charset . $default . $notnull . $unique . $check . $collation; |
||
| 2265 | |||
| 2266 | if ($this->supportsInlineColumnComments() && isset($field['comment']) && $field['comment'] !== '') { |
||
| 2267 | $columnDef .= ' ' . $this->getInlineColumnCommentSQL($field['comment']); |
||
| 2268 | } |
||
| 2269 | } |
||
| 2270 | |||
| 2271 | return $name . ' ' . $columnDef; |
||
| 2272 | } |
||
| 2273 | |||
| 2274 | /** |
||
| 2275 | * Returns the SQL snippet that declares a floating point column of arbitrary precision. |
||
| 2276 | * |
||
| 2277 | * @param mixed[] $columnDef |
||
| 2278 | * |
||
| 2279 | * @return string |
||
| 2280 | */ |
||
| 2281 | public function getDecimalTypeDeclarationSQL(array $columnDef) |
||
| 2282 | { |
||
| 2283 | $columnDef['precision'] = ! isset($columnDef['precision']) || empty($columnDef['precision']) |
||
| 2284 | ? 10 : $columnDef['precision']; |
||
| 2285 | $columnDef['scale'] = ! isset($columnDef['scale']) || empty($columnDef['scale']) |
||
| 2286 | ? 0 : $columnDef['scale']; |
||
| 2287 | |||
| 2288 | return 'NUMERIC(' . $columnDef['precision'] . ', ' . $columnDef['scale'] . ')'; |
||
| 2289 | } |
||
| 2290 | |||
| 2291 | /** |
||
| 2292 | * Obtains DBMS specific SQL code portion needed to set a default value |
||
| 2293 | * declaration to be used in statements like CREATE TABLE. |
||
| 2294 | * |
||
| 2295 | * @param mixed[] $field The field definition array. |
||
| 2296 | * |
||
| 2297 | * @return string DBMS specific SQL code portion needed to set a default value. |
||
| 2298 | */ |
||
| 2299 | public function getDefaultValueDeclarationSQL($field) |
||
| 2300 | { |
||
| 2301 | if (! isset($field['default'])) { |
||
| 2302 | return empty($field['notnull']) ? ' DEFAULT NULL' : ''; |
||
| 2303 | } |
||
| 2304 | |||
| 2305 | $default = $field['default']; |
||
| 2306 | |||
| 2307 | if (! isset($field['type'])) { |
||
| 2308 | return " DEFAULT '" . $default . "'"; |
||
| 2309 | } |
||
| 2310 | |||
| 2311 | $type = $field['type']; |
||
| 2312 | |||
| 2313 | if ($type instanceof Types\PhpIntegerMappingType) { |
||
| 2314 | return ' DEFAULT ' . $default; |
||
| 2315 | } |
||
| 2316 | |||
| 2317 | if ($type instanceof Types\PhpDateTimeMappingType && $default === $this->getCurrentTimestampSQL()) { |
||
| 2318 | return ' DEFAULT ' . $this->getCurrentTimestampSQL(); |
||
| 2319 | } |
||
| 2320 | |||
| 2321 | if ($type instanceof Types\TimeType && $default === $this->getCurrentTimeSQL()) { |
||
| 2322 | return ' DEFAULT ' . $this->getCurrentTimeSQL(); |
||
| 2323 | } |
||
| 2324 | |||
| 2325 | if ($type instanceof Types\DateType && $default === $this->getCurrentDateSQL()) { |
||
| 2326 | return ' DEFAULT ' . $this->getCurrentDateSQL(); |
||
| 2327 | } |
||
| 2328 | |||
| 2329 | if ($type instanceof Types\BooleanType) { |
||
| 2330 | return " DEFAULT '" . $this->convertBooleans($default) . "'"; |
||
| 2331 | } |
||
| 2332 | |||
| 2333 | return ' DEFAULT ' . $this->quoteStringLiteral($default); |
||
| 2334 | } |
||
| 2335 | |||
| 2336 | /** |
||
| 2337 | * Obtains DBMS specific SQL code portion needed to set a CHECK constraint |
||
| 2338 | * declaration to be used in statements like CREATE TABLE. |
||
| 2339 | * |
||
| 2340 | * @param string[]|mixed[][] $definition The check definition. |
||
| 2341 | * |
||
| 2342 | * @return string DBMS specific SQL code portion needed to set a CHECK constraint. |
||
| 2343 | */ |
||
| 2344 | public function getCheckDeclarationSQL(array $definition) |
||
| 2345 | { |
||
| 2346 | $constraints = []; |
||
| 2347 | foreach ($definition as $field => $def) { |
||
| 2348 | if (is_string($def)) { |
||
| 2349 | $constraints[] = 'CHECK (' . $def . ')'; |
||
| 2350 | } else { |
||
| 2351 | if (isset($def['min'])) { |
||
| 2352 | $constraints[] = 'CHECK (' . $field . ' >= ' . $def['min'] . ')'; |
||
| 2353 | } |
||
| 2354 | |||
| 2355 | if (isset($def['max'])) { |
||
| 2356 | $constraints[] = 'CHECK (' . $field . ' <= ' . $def['max'] . ')'; |
||
| 2357 | } |
||
| 2358 | } |
||
| 2359 | } |
||
| 2360 | |||
| 2361 | return implode(', ', $constraints); |
||
| 2362 | } |
||
| 2363 | |||
| 2364 | /** |
||
| 2365 | * Obtains DBMS specific SQL code portion needed to set a unique |
||
| 2366 | * constraint declaration to be used in statements like CREATE TABLE. |
||
| 2367 | * |
||
| 2368 | * @param string $name The name of the unique constraint. |
||
| 2369 | * @param Index $index The index definition. |
||
| 2370 | * |
||
| 2371 | * @return string DBMS specific SQL code portion needed to set a constraint. |
||
| 2372 | * |
||
| 2373 | * @throws InvalidArgumentException |
||
| 2374 | */ |
||
| 2375 | public function getUniqueConstraintDeclarationSQL($name, Index $index) |
||
| 2376 | { |
||
| 2377 | $columns = $index->getColumns(); |
||
| 2378 | $name = new Identifier($name); |
||
| 2379 | |||
| 2380 | if (count($columns) === 0) { |
||
| 2381 | throw new InvalidArgumentException("Incomplete definition. 'columns' required."); |
||
| 2382 | } |
||
| 2383 | |||
| 2384 | return 'CONSTRAINT ' . $name->getQuotedName($this) . ' UNIQUE (' |
||
| 2385 | . $this->getIndexFieldDeclarationListSQL($index) |
||
| 2386 | . ')' . $this->getPartialIndexSQL($index); |
||
| 2387 | } |
||
| 2388 | |||
| 2389 | /** |
||
| 2390 | * Obtains DBMS specific SQL code portion needed to set an index |
||
| 2391 | * declaration to be used in statements like CREATE TABLE. |
||
| 2392 | * |
||
| 2393 | * @param string $name The name of the index. |
||
| 2394 | * @param Index $index The index definition. |
||
| 2395 | * |
||
| 2396 | * @return string DBMS specific SQL code portion needed to set an index. |
||
| 2397 | * |
||
| 2398 | * @throws InvalidArgumentException |
||
| 2399 | */ |
||
| 2400 | public function getIndexDeclarationSQL($name, Index $index) |
||
| 2401 | { |
||
| 2402 | $columns = $index->getColumns(); |
||
| 2403 | $name = new Identifier($name); |
||
| 2404 | |||
| 2405 | if (count($columns) === 0) { |
||
| 2406 | throw new InvalidArgumentException("Incomplete definition. 'columns' required."); |
||
| 2407 | } |
||
| 2408 | |||
| 2409 | return $this->getCreateIndexSQLFlags($index) . 'INDEX ' . $name->getQuotedName($this) . ' (' |
||
| 2410 | . $this->getIndexFieldDeclarationListSQL($index) |
||
| 2411 | . ')' . $this->getPartialIndexSQL($index); |
||
| 2412 | } |
||
| 2413 | |||
| 2414 | /** |
||
| 2415 | * Obtains SQL code portion needed to create a custom column, |
||
| 2416 | * e.g. when a field has the "columnDefinition" keyword. |
||
| 2417 | * Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate. |
||
| 2418 | * |
||
| 2419 | * @param mixed[] $columnDef |
||
| 2420 | * |
||
| 2421 | * @return string |
||
| 2422 | */ |
||
| 2423 | public function getCustomTypeDeclarationSQL(array $columnDef) |
||
| 2424 | { |
||
| 2425 | return $columnDef['columnDefinition']; |
||
| 2426 | } |
||
| 2427 | |||
| 2428 | /** |
||
| 2429 | * Obtains DBMS specific SQL code portion needed to set an index |
||
| 2430 | * declaration to be used in statements like CREATE TABLE. |
||
| 2431 | * |
||
| 2432 | * @param mixed[]|Index $columnsOrIndex array declaration is deprecated, prefer passing Index to this method |
||
| 2433 | */ |
||
| 2434 | public function getIndexFieldDeclarationListSQL($columnsOrIndex) : string |
||
| 2435 | { |
||
| 2436 | if ($columnsOrIndex instanceof Index) { |
||
| 2437 | return implode(', ', $columnsOrIndex->getQuotedColumns($this)); |
||
| 2438 | } |
||
| 2439 | |||
| 2440 | if (! is_array($columnsOrIndex)) { |
||
| 2441 | throw new InvalidArgumentException('Fields argument should be an Index or array.'); |
||
| 2442 | } |
||
| 2443 | |||
| 2444 | $ret = []; |
||
| 2445 | |||
| 2446 | foreach ($columnsOrIndex as $column => $definition) { |
||
| 2447 | if (is_array($definition)) { |
||
| 2448 | $ret[] = $column; |
||
| 2449 | } else { |
||
| 2450 | $ret[] = $definition; |
||
| 2451 | } |
||
| 2452 | } |
||
| 2453 | |||
| 2454 | return implode(', ', $ret); |
||
| 2455 | } |
||
| 2456 | |||
| 2457 | /** |
||
| 2458 | * Returns the required SQL string that fits between CREATE ... TABLE |
||
| 2459 | * to create the table as a temporary table. |
||
| 2460 | * |
||
| 2461 | * Should be overridden in driver classes to return the correct string for the |
||
| 2462 | * specific database type. |
||
| 2463 | * |
||
| 2464 | * The default is to return the string "TEMPORARY" - this will result in a |
||
| 2465 | * SQL error for any database that does not support temporary tables, or that |
||
| 2466 | * requires a different SQL command from "CREATE TEMPORARY TABLE". |
||
| 2467 | * |
||
| 2468 | * @return string The string required to be placed between "CREATE" and "TABLE" |
||
| 2469 | * to generate a temporary table, if possible. |
||
| 2470 | */ |
||
| 2471 | public function getTemporaryTableSQL() |
||
| 2472 | { |
||
| 2473 | return 'TEMPORARY'; |
||
| 2474 | } |
||
| 2475 | |||
| 2476 | /** |
||
| 2477 | * Some vendors require temporary table names to be qualified specially. |
||
| 2478 | * |
||
| 2479 | * @param string $tableName |
||
| 2480 | * |
||
| 2481 | * @return string |
||
| 2482 | */ |
||
| 2483 | public function getTemporaryTableName($tableName) |
||
| 2484 | { |
||
| 2485 | return $tableName; |
||
| 2486 | } |
||
| 2487 | |||
| 2488 | /** |
||
| 2489 | * Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint |
||
| 2490 | * of a field declaration to be used in statements like CREATE TABLE. |
||
| 2491 | * |
||
| 2492 | * @return string DBMS specific SQL code portion needed to set the FOREIGN KEY constraint |
||
| 2493 | * of a field declaration. |
||
| 2494 | */ |
||
| 2495 | public function getForeignKeyDeclarationSQL(ForeignKeyConstraint $foreignKey) |
||
| 2496 | { |
||
| 2497 | $sql = $this->getForeignKeyBaseDeclarationSQL($foreignKey); |
||
| 2498 | $sql .= $this->getAdvancedForeignKeyOptionsSQL($foreignKey); |
||
| 2499 | |||
| 2500 | return $sql; |
||
| 2501 | } |
||
| 2502 | |||
| 2503 | /** |
||
| 2504 | * Returns the FOREIGN KEY query section dealing with non-standard options |
||
| 2505 | * as MATCH, INITIALLY DEFERRED, ON UPDATE, ... |
||
| 2506 | * |
||
| 2507 | * @param ForeignKeyConstraint $foreignKey The foreign key definition. |
||
| 2508 | * |
||
| 2509 | * @return string |
||
| 2510 | */ |
||
| 2511 | public function getAdvancedForeignKeyOptionsSQL(ForeignKeyConstraint $foreignKey) |
||
| 2512 | { |
||
| 2513 | $query = ''; |
||
| 2514 | if ($this->supportsForeignKeyOnUpdate() && $foreignKey->hasOption('onUpdate')) { |
||
| 2515 | $query .= ' ON UPDATE ' . $this->getForeignKeyReferentialActionSQL($foreignKey->getOption('onUpdate')); |
||
| 2516 | } |
||
| 2517 | if ($foreignKey->hasOption('onDelete')) { |
||
| 2518 | $query .= ' ON DELETE ' . $this->getForeignKeyReferentialActionSQL($foreignKey->getOption('onDelete')); |
||
| 2519 | } |
||
| 2520 | |||
| 2521 | return $query; |
||
| 2522 | } |
||
| 2523 | |||
| 2524 | /** |
||
| 2525 | * Returns the given referential action in uppercase if valid, otherwise throws an exception. |
||
| 2526 | * |
||
| 2527 | * @param string $action The foreign key referential action. |
||
| 2528 | * |
||
| 2529 | * @return string |
||
| 2530 | * |
||
| 2531 | * @throws InvalidArgumentException If unknown referential action given. |
||
| 2532 | */ |
||
| 2533 | public function getForeignKeyReferentialActionSQL($action) |
||
| 2534 | { |
||
| 2535 | $upper = strtoupper($action); |
||
| 2536 | switch ($upper) { |
||
| 2537 | case 'CASCADE': |
||
| 2538 | case 'SET NULL': |
||
| 2539 | case 'NO ACTION': |
||
| 2540 | case 'RESTRICT': |
||
| 2541 | case 'SET DEFAULT': |
||
| 2542 | return $upper; |
||
| 2543 | default: |
||
| 2544 | throw new InvalidArgumentException('Invalid foreign key action: ' . $upper); |
||
| 2545 | } |
||
| 2546 | } |
||
| 2547 | |||
| 2548 | /** |
||
| 2549 | * Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint |
||
| 2550 | * of a field declaration to be used in statements like CREATE TABLE. |
||
| 2551 | * |
||
| 2552 | * @return string |
||
| 2553 | * |
||
| 2554 | * @throws InvalidArgumentException |
||
| 2555 | */ |
||
| 2556 | public function getForeignKeyBaseDeclarationSQL(ForeignKeyConstraint $foreignKey) |
||
| 2557 | { |
||
| 2558 | $sql = ''; |
||
| 2559 | if (strlen($foreignKey->getName()) > 0) { |
||
| 2560 | $sql .= 'CONSTRAINT ' . $foreignKey->getQuotedName($this) . ' '; |
||
| 2561 | } |
||
| 2562 | $sql .= 'FOREIGN KEY ('; |
||
| 2563 | |||
| 2564 | if (count($foreignKey->getLocalColumns()) === 0) { |
||
| 2565 | throw new InvalidArgumentException("Incomplete definition. 'local' required."); |
||
| 2566 | } |
||
| 2567 | if (count($foreignKey->getForeignColumns()) === 0) { |
||
| 2568 | throw new InvalidArgumentException("Incomplete definition. 'foreign' required."); |
||
| 2569 | } |
||
| 2570 | if (strlen($foreignKey->getForeignTableName()) === 0) { |
||
| 2571 | throw new InvalidArgumentException("Incomplete definition. 'foreignTable' required."); |
||
| 2572 | } |
||
| 2573 | |||
| 2574 | return $sql . implode(', ', $foreignKey->getQuotedLocalColumns($this)) |
||
| 2575 | . ') REFERENCES ' |
||
| 2576 | . $foreignKey->getQuotedForeignTableName($this) . ' (' |
||
| 2577 | . implode(', ', $foreignKey->getQuotedForeignColumns($this)) . ')'; |
||
| 2578 | } |
||
| 2579 | |||
| 2580 | /** |
||
| 2581 | * Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint |
||
| 2582 | * of a field declaration to be used in statements like CREATE TABLE. |
||
| 2583 | * |
||
| 2584 | * @return string DBMS specific SQL code portion needed to set the UNIQUE constraint |
||
| 2585 | * of a field declaration. |
||
| 2586 | */ |
||
| 2587 | public function getUniqueFieldDeclarationSQL() |
||
| 2588 | { |
||
| 2589 | return 'UNIQUE'; |
||
| 2590 | } |
||
| 2591 | |||
| 2592 | /** |
||
| 2593 | * Obtains DBMS specific SQL code portion needed to set the CHARACTER SET |
||
| 2594 | * of a field declaration to be used in statements like CREATE TABLE. |
||
| 2595 | * |
||
| 2596 | * @param string $charset The name of the charset. |
||
| 2597 | * |
||
| 2598 | * @return string DBMS specific SQL code portion needed to set the CHARACTER SET |
||
| 2599 | * of a field declaration. |
||
| 2600 | */ |
||
| 2601 | public function getColumnCharsetDeclarationSQL($charset) |
||
| 2602 | { |
||
| 2603 | return ''; |
||
| 2604 | } |
||
| 2605 | |||
| 2606 | /** |
||
| 2607 | * Obtains DBMS specific SQL code portion needed to set the COLLATION |
||
| 2608 | * of a field declaration to be used in statements like CREATE TABLE. |
||
| 2609 | * |
||
| 2610 | * @param string $collation The name of the collation. |
||
| 2611 | * |
||
| 2612 | * @return string DBMS specific SQL code portion needed to set the COLLATION |
||
| 2613 | * of a field declaration. |
||
| 2614 | */ |
||
| 2615 | public function getColumnCollationDeclarationSQL($collation) |
||
| 2616 | { |
||
| 2617 | return $this->supportsColumnCollation() ? 'COLLATE ' . $collation : ''; |
||
| 2618 | } |
||
| 2619 | |||
| 2620 | /** |
||
| 2621 | * Whether the platform prefers sequences for ID generation. |
||
| 2622 | * Subclasses should override this method to return TRUE if they prefer sequences. |
||
| 2623 | * |
||
| 2624 | * @return bool |
||
| 2625 | */ |
||
| 2626 | public function prefersSequences() |
||
| 2627 | { |
||
| 2628 | return false; |
||
| 2629 | } |
||
| 2630 | |||
| 2631 | /** |
||
| 2632 | * Whether the platform prefers identity columns (eg. autoincrement) for ID generation. |
||
| 2633 | * Subclasses should override this method to return TRUE if they prefer identity columns. |
||
| 2634 | * |
||
| 2635 | * @return bool |
||
| 2636 | */ |
||
| 2637 | public function prefersIdentityColumns() |
||
| 2638 | { |
||
| 2639 | return false; |
||
| 2640 | } |
||
| 2641 | |||
| 2642 | /** |
||
| 2643 | * Some platforms need the boolean values to be converted. |
||
| 2644 | * |
||
| 2645 | * The default conversion in this implementation converts to integers (false => 0, true => 1). |
||
| 2646 | * |
||
| 2647 | * Note: if the input is not a boolean the original input might be returned. |
||
| 2648 | * |
||
| 2649 | * There are two contexts when converting booleans: Literals and Prepared Statements. |
||
| 2650 | * This method should handle the literal case |
||
| 2651 | * |
||
| 2652 | * @param mixed $item A boolean or an array of them. |
||
| 2653 | * |
||
| 2654 | * @return mixed A boolean database value or an array of them. |
||
| 2655 | */ |
||
| 2656 | public function convertBooleans($item) |
||
| 2657 | { |
||
| 2658 | if (is_array($item)) { |
||
| 2659 | foreach ($item as $k => $value) { |
||
| 2660 | if (! is_bool($value)) { |
||
| 2661 | continue; |
||
| 2662 | } |
||
| 2663 | |||
| 2664 | $item[$k] = (int) $value; |
||
| 2665 | } |
||
| 2666 | } elseif (is_bool($item)) { |
||
| 2667 | $item = (int) $item; |
||
| 2668 | } |
||
| 2669 | |||
| 2670 | return $item; |
||
| 2671 | } |
||
| 2672 | |||
| 2673 | /** |
||
| 2674 | * Some platforms have boolean literals that needs to be correctly converted |
||
| 2675 | * |
||
| 2676 | * The default conversion tries to convert value into bool "(bool)$item" |
||
| 2677 | * |
||
| 2678 | * @param mixed $item |
||
| 2679 | * |
||
| 2680 | * @return bool|null |
||
| 2681 | */ |
||
| 2682 | public function convertFromBoolean($item) |
||
| 2683 | { |
||
| 2684 | return $item === null ? null: (bool) $item; |
||
| 2685 | } |
||
| 2686 | |||
| 2687 | /** |
||
| 2688 | * This method should handle the prepared statements case. When there is no |
||
| 2689 | * distinction, it's OK to use the same method. |
||
| 2690 | * |
||
| 2691 | * Note: if the input is not a boolean the original input might be returned. |
||
| 2692 | * |
||
| 2693 | * @param mixed $item A boolean or an array of them. |
||
| 2694 | * |
||
| 2695 | * @return mixed A boolean database value or an array of them. |
||
| 2696 | */ |
||
| 2697 | public function convertBooleansToDatabaseValue($item) |
||
| 2698 | { |
||
| 2699 | return $this->convertBooleans($item); |
||
| 2700 | } |
||
| 2701 | |||
| 2702 | /** |
||
| 2703 | * Returns the SQL specific for the platform to get the current date. |
||
| 2704 | * |
||
| 2705 | * @return string |
||
| 2706 | */ |
||
| 2707 | public function getCurrentDateSQL() |
||
| 2708 | { |
||
| 2709 | return 'CURRENT_DATE'; |
||
| 2710 | } |
||
| 2711 | |||
| 2712 | /** |
||
| 2713 | * Returns the SQL specific for the platform to get the current time. |
||
| 2714 | * |
||
| 2715 | * @return string |
||
| 2716 | */ |
||
| 2717 | public function getCurrentTimeSQL() |
||
| 2718 | { |
||
| 2719 | return 'CURRENT_TIME'; |
||
| 2720 | } |
||
| 2721 | |||
| 2722 | /** |
||
| 2723 | * Returns the SQL specific for the platform to get the current timestamp |
||
| 2724 | * |
||
| 2725 | * @return string |
||
| 2726 | */ |
||
| 2727 | public function getCurrentTimestampSQL() |
||
| 2728 | { |
||
| 2729 | return 'CURRENT_TIMESTAMP'; |
||
| 2730 | } |
||
| 2731 | |||
| 2732 | /** |
||
| 2733 | * Returns the SQL for a given transaction isolation level Connection constant. |
||
| 2734 | * |
||
| 2735 | * @param int $level |
||
| 2736 | * |
||
| 2737 | * @return string |
||
| 2738 | * |
||
| 2739 | * @throws InvalidArgumentException |
||
| 2740 | */ |
||
| 2741 | protected function _getTransactionIsolationLevelSQL($level) |
||
| 2742 | { |
||
| 2743 | switch ($level) { |
||
| 2744 | case TransactionIsolationLevel::READ_UNCOMMITTED: |
||
| 2745 | return 'READ UNCOMMITTED'; |
||
| 2746 | case TransactionIsolationLevel::READ_COMMITTED: |
||
| 2747 | return 'READ COMMITTED'; |
||
| 2748 | case TransactionIsolationLevel::REPEATABLE_READ: |
||
| 2749 | return 'REPEATABLE READ'; |
||
| 2750 | case TransactionIsolationLevel::SERIALIZABLE: |
||
| 2751 | return 'SERIALIZABLE'; |
||
| 2752 | default: |
||
| 2753 | throw new InvalidArgumentException('Invalid isolation level:' . $level); |
||
| 2754 | } |
||
| 2755 | } |
||
| 2756 | |||
| 2757 | /** |
||
| 2758 | * @return string |
||
| 2759 | * |
||
| 2760 | * @throws DBALException If not supported on this platform. |
||
| 2761 | */ |
||
| 2762 | public function getListDatabasesSQL() |
||
| 2763 | { |
||
| 2764 | throw DBALException::notSupported(__METHOD__); |
||
| 2765 | } |
||
| 2766 | |||
| 2767 | /** |
||
| 2768 | * Returns the SQL statement for retrieving the namespaces defined in the database. |
||
| 2769 | * |
||
| 2770 | * @return string |
||
| 2771 | * |
||
| 2772 | * @throws DBALException If not supported on this platform. |
||
| 2773 | */ |
||
| 2774 | public function getListNamespacesSQL() |
||
| 2775 | { |
||
| 2776 | throw DBALException::notSupported(__METHOD__); |
||
| 2777 | } |
||
| 2778 | |||
| 2779 | /** |
||
| 2780 | * @param string $database |
||
| 2781 | * |
||
| 2782 | * @return string |
||
| 2783 | * |
||
| 2784 | * @throws DBALException If not supported on this platform. |
||
| 2785 | */ |
||
| 2786 | public function getListSequencesSQL($database) |
||
| 2787 | { |
||
| 2788 | throw DBALException::notSupported(__METHOD__); |
||
| 2789 | } |
||
| 2790 | |||
| 2791 | /** |
||
| 2792 | * @param string $table |
||
| 2793 | * |
||
| 2794 | * @return string |
||
| 2795 | * |
||
| 2796 | * @throws DBALException If not supported on this platform. |
||
| 2797 | */ |
||
| 2798 | public function getListTableConstraintsSQL($table) |
||
| 2799 | { |
||
| 2800 | throw DBALException::notSupported(__METHOD__); |
||
| 2801 | } |
||
| 2802 | |||
| 2803 | /** |
||
| 2804 | * @param string $table |
||
| 2805 | * @param string|null $database |
||
| 2806 | * |
||
| 2807 | * @return string |
||
| 2808 | * |
||
| 2809 | * @throws DBALException If not supported on this platform. |
||
| 2810 | */ |
||
| 2811 | public function getListTableColumnsSQL($table, $database = null) |
||
| 2812 | { |
||
| 2813 | throw DBALException::notSupported(__METHOD__); |
||
| 2814 | } |
||
| 2815 | |||
| 2816 | /** |
||
| 2817 | * @return string |
||
| 2818 | * |
||
| 2819 | * @throws DBALException If not supported on this platform. |
||
| 2820 | */ |
||
| 2821 | public function getListTablesSQL() |
||
| 2822 | { |
||
| 2823 | throw DBALException::notSupported(__METHOD__); |
||
| 2824 | } |
||
| 2825 | |||
| 2826 | /** |
||
| 2827 | * @return string |
||
| 2828 | * |
||
| 2829 | * @throws DBALException If not supported on this platform. |
||
| 2830 | */ |
||
| 2831 | public function getListUsersSQL() |
||
| 2832 | { |
||
| 2833 | throw DBALException::notSupported(__METHOD__); |
||
| 2834 | } |
||
| 2835 | |||
| 2836 | /** |
||
| 2837 | * Returns the SQL to list all views of a database or user. |
||
| 2838 | * |
||
| 2839 | * @param string $database |
||
| 2840 | * |
||
| 2841 | * @return string |
||
| 2842 | * |
||
| 2843 | * @throws DBALException If not supported on this platform. |
||
| 2844 | */ |
||
| 2845 | public function getListViewsSQL($database) |
||
| 2846 | { |
||
| 2847 | throw DBALException::notSupported(__METHOD__); |
||
| 2848 | } |
||
| 2849 | |||
| 2850 | /** |
||
| 2851 | * Returns the list of indexes for the current database. |
||
| 2852 | * |
||
| 2853 | * The current database parameter is optional but will always be passed |
||
| 2854 | * when using the SchemaManager API and is the database the given table is in. |
||
| 2855 | * |
||
| 2856 | * Attention: Some platforms only support currentDatabase when they |
||
| 2857 | * are connected with that database. Cross-database information schema |
||
| 2858 | * requests may be impossible. |
||
| 2859 | * |
||
| 2860 | * @param string $table |
||
| 2861 | * @param string $currentDatabase |
||
| 2862 | * |
||
| 2863 | * @return string |
||
| 2864 | * |
||
| 2865 | * @throws DBALException If not supported on this platform. |
||
| 2866 | */ |
||
| 2867 | public function getListTableIndexesSQL($table, $currentDatabase = null) |
||
| 2868 | { |
||
| 2869 | throw DBALException::notSupported(__METHOD__); |
||
| 2870 | } |
||
| 2871 | |||
| 2872 | /** |
||
| 2873 | * @param string $table |
||
| 2874 | * |
||
| 2875 | * @return string |
||
| 2876 | * |
||
| 2877 | * @throws DBALException If not supported on this platform. |
||
| 2878 | */ |
||
| 2879 | public function getListTableForeignKeysSQL($table) |
||
| 2880 | { |
||
| 2881 | throw DBALException::notSupported(__METHOD__); |
||
| 2882 | } |
||
| 2883 | |||
| 2884 | /** |
||
| 2885 | * @param string $name |
||
| 2886 | * @param string $sql |
||
| 2887 | * |
||
| 2888 | * @return string |
||
| 2889 | * |
||
| 2890 | * @throws DBALException If not supported on this platform. |
||
| 2891 | */ |
||
| 2892 | public function getCreateViewSQL($name, $sql) |
||
| 2893 | { |
||
| 2894 | throw DBALException::notSupported(__METHOD__); |
||
| 2895 | } |
||
| 2896 | |||
| 2897 | /** |
||
| 2898 | * @param string $name |
||
| 2899 | * |
||
| 2900 | * @return string |
||
| 2901 | * |
||
| 2902 | * @throws DBALException If not supported on this platform. |
||
| 2903 | */ |
||
| 2904 | public function getDropViewSQL($name) |
||
| 2905 | { |
||
| 2906 | throw DBALException::notSupported(__METHOD__); |
||
| 2907 | } |
||
| 2908 | |||
| 2909 | /** |
||
| 2910 | * Returns the SQL snippet to drop an existing sequence. |
||
| 2911 | * |
||
| 2912 | * @param Sequence|string $sequence |
||
| 2913 | * |
||
| 2914 | * @return string |
||
| 2915 | * |
||
| 2916 | * @throws DBALException If not supported on this platform. |
||
| 2917 | */ |
||
| 2918 | public function getDropSequenceSQL($sequence) |
||
| 2919 | { |
||
| 2920 | throw DBALException::notSupported(__METHOD__); |
||
| 2921 | } |
||
| 2922 | |||
| 2923 | /** |
||
| 2924 | * @param string $sequenceName |
||
| 2925 | * |
||
| 2926 | * @return string |
||
| 2927 | * |
||
| 2928 | * @throws DBALException If not supported on this platform. |
||
| 2929 | */ |
||
| 2930 | public function getSequenceNextValSQL($sequenceName) |
||
| 2931 | { |
||
| 2932 | throw DBALException::notSupported(__METHOD__); |
||
| 2933 | } |
||
| 2934 | |||
| 2935 | /** |
||
| 2936 | * Returns the SQL to create a new database. |
||
| 2937 | * |
||
| 2938 | * @param string $database The name of the database that should be created. |
||
| 2939 | * |
||
| 2940 | * @return string |
||
| 2941 | * |
||
| 2942 | * @throws DBALException If not supported on this platform. |
||
| 2943 | */ |
||
| 2944 | public function getCreateDatabaseSQL($database) |
||
| 2945 | { |
||
| 2946 | throw DBALException::notSupported(__METHOD__); |
||
| 2947 | } |
||
| 2948 | |||
| 2949 | /** |
||
| 2950 | * Returns the SQL to set the transaction isolation level. |
||
| 2951 | * |
||
| 2952 | * @param int $level |
||
| 2953 | * |
||
| 2954 | * @return string |
||
| 2955 | * |
||
| 2956 | * @throws DBALException If not supported on this platform. |
||
| 2957 | */ |
||
| 2958 | public function getSetTransactionIsolationSQL($level) |
||
| 2959 | { |
||
| 2960 | throw DBALException::notSupported(__METHOD__); |
||
| 2961 | } |
||
| 2962 | |||
| 2963 | /** |
||
| 2964 | * Obtains DBMS specific SQL to be used to create datetime fields in |
||
| 2965 | * statements like CREATE TABLE. |
||
| 2966 | * |
||
| 2967 | * @param mixed[] $fieldDeclaration |
||
| 2968 | * |
||
| 2969 | * @return string |
||
| 2970 | * |
||
| 2971 | * @throws DBALException If not supported on this platform. |
||
| 2972 | */ |
||
| 2973 | public function getDateTimeTypeDeclarationSQL(array $fieldDeclaration) |
||
| 2974 | { |
||
| 2975 | throw DBALException::notSupported(__METHOD__); |
||
| 2976 | } |
||
| 2977 | |||
| 2978 | /** |
||
| 2979 | * Obtains DBMS specific SQL to be used to create datetime with timezone offset fields. |
||
| 2980 | * |
||
| 2981 | * @param mixed[] $fieldDeclaration |
||
| 2982 | * |
||
| 2983 | * @return string |
||
| 2984 | */ |
||
| 2985 | public function getDateTimeTzTypeDeclarationSQL(array $fieldDeclaration) |
||
| 2986 | { |
||
| 2987 | return $this->getDateTimeTypeDeclarationSQL($fieldDeclaration); |
||
| 2988 | } |
||
| 2989 | |||
| 2990 | /** |
||
| 2991 | * Obtains DBMS specific SQL to be used to create date fields in statements |
||
| 2992 | * like CREATE TABLE. |
||
| 2993 | * |
||
| 2994 | * @param mixed[] $fieldDeclaration |
||
| 2995 | * |
||
| 2996 | * @return string |
||
| 2997 | * |
||
| 2998 | * @throws DBALException If not supported on this platform. |
||
| 2999 | */ |
||
| 3000 | public function getDateTypeDeclarationSQL(array $fieldDeclaration) |
||
| 3001 | { |
||
| 3002 | throw DBALException::notSupported(__METHOD__); |
||
| 3003 | } |
||
| 3004 | |||
| 3005 | /** |
||
| 3006 | * Obtains DBMS specific SQL to be used to create time fields in statements |
||
| 3007 | * like CREATE TABLE. |
||
| 3008 | * |
||
| 3009 | * @param mixed[] $fieldDeclaration |
||
| 3010 | * |
||
| 3011 | * @return string |
||
| 3012 | * |
||
| 3013 | * @throws DBALException If not supported on this platform. |
||
| 3014 | */ |
||
| 3015 | public function getTimeTypeDeclarationSQL(array $fieldDeclaration) |
||
| 3016 | { |
||
| 3017 | throw DBALException::notSupported(__METHOD__); |
||
| 3018 | } |
||
| 3019 | |||
| 3020 | /** |
||
| 3021 | * @param mixed[] $fieldDeclaration |
||
| 3022 | * |
||
| 3023 | * @return string |
||
| 3024 | */ |
||
| 3025 | public function getFloatDeclarationSQL(array $fieldDeclaration) |
||
| 3026 | { |
||
| 3027 | return 'DOUBLE PRECISION'; |
||
| 3028 | } |
||
| 3029 | |||
| 3030 | /** |
||
| 3031 | * Gets the default transaction isolation level of the platform. |
||
| 3032 | * |
||
| 3033 | * @see TransactionIsolationLevel |
||
| 3034 | * |
||
| 3035 | * @return int The default isolation level. |
||
| 3036 | */ |
||
| 3037 | public function getDefaultTransactionIsolationLevel() |
||
| 3038 | { |
||
| 3039 | return TransactionIsolationLevel::READ_COMMITTED; |
||
| 3040 | } |
||
| 3041 | |||
| 3042 | /* supports*() methods */ |
||
| 3043 | |||
| 3044 | /** |
||
| 3045 | * Whether the platform supports sequences. |
||
| 3046 | * |
||
| 3047 | * @return bool |
||
| 3048 | */ |
||
| 3049 | public function supportsSequences() |
||
| 3050 | { |
||
| 3051 | return false; |
||
| 3052 | } |
||
| 3053 | |||
| 3054 | /** |
||
| 3055 | * Whether the platform supports identity columns. |
||
| 3056 | * |
||
| 3057 | * Identity columns are columns that receive an auto-generated value from the |
||
| 3058 | * database on insert of a row. |
||
| 3059 | * |
||
| 3060 | * @return bool |
||
| 3061 | */ |
||
| 3062 | public function supportsIdentityColumns() |
||
| 3063 | { |
||
| 3064 | return false; |
||
| 3065 | } |
||
| 3066 | |||
| 3067 | /** |
||
| 3068 | * Whether the platform emulates identity columns through sequences. |
||
| 3069 | * |
||
| 3070 | * Some platforms that do not support identity columns natively |
||
| 3071 | * but support sequences can emulate identity columns by using |
||
| 3072 | * sequences. |
||
| 3073 | * |
||
| 3074 | * @return bool |
||
| 3075 | */ |
||
| 3076 | public function usesSequenceEmulatedIdentityColumns() |
||
| 3077 | { |
||
| 3078 | return false; |
||
| 3079 | } |
||
| 3080 | |||
| 3081 | /** |
||
| 3082 | * Returns the name of the sequence for a particular identity column in a particular table. |
||
| 3083 | * |
||
| 3084 | * @see usesSequenceEmulatedIdentityColumns |
||
| 3085 | * |
||
| 3086 | * @param string $tableName The name of the table to return the sequence name for. |
||
| 3087 | * @param string $columnName The name of the identity column in the table to return the sequence name for. |
||
| 3088 | * |
||
| 3089 | * @return string |
||
| 3090 | * |
||
| 3091 | * @throws DBALException If not supported on this platform. |
||
| 3092 | */ |
||
| 3093 | public function getIdentitySequenceName($tableName, $columnName) |
||
| 3094 | { |
||
| 3095 | throw DBALException::notSupported(__METHOD__); |
||
| 3096 | } |
||
| 3097 | |||
| 3098 | /** |
||
| 3099 | * Whether the platform supports indexes. |
||
| 3100 | * |
||
| 3101 | * @return bool |
||
| 3102 | */ |
||
| 3103 | public function supportsIndexes() |
||
| 3104 | { |
||
| 3105 | return true; |
||
| 3106 | } |
||
| 3107 | |||
| 3108 | /** |
||
| 3109 | * Whether the platform supports partial indexes. |
||
| 3110 | * |
||
| 3111 | * @return bool |
||
| 3112 | */ |
||
| 3113 | public function supportsPartialIndexes() |
||
| 3114 | { |
||
| 3115 | return false; |
||
| 3116 | } |
||
| 3117 | |||
| 3118 | /** |
||
| 3119 | * Whether the platform supports indexes with column length definitions. |
||
| 3120 | */ |
||
| 3121 | public function supportsColumnLengthIndexes() : bool |
||
| 3122 | { |
||
| 3123 | return false; |
||
| 3124 | } |
||
| 3125 | |||
| 3126 | /** |
||
| 3127 | * Whether the platform supports altering tables. |
||
| 3128 | * |
||
| 3129 | * @return bool |
||
| 3130 | */ |
||
| 3131 | public function supportsAlterTable() |
||
| 3134 | } |
||
| 3135 | |||
| 3136 | /** |
||
| 3137 | * Whether the platform supports transactions. |
||
| 3138 | * |
||
| 3139 | * @return bool |
||
| 3140 | */ |
||
| 3141 | public function supportsTransactions() |
||
| 3142 | { |
||
| 3143 | return true; |
||
| 3144 | } |
||
| 3145 | |||
| 3146 | /** |
||
| 3147 | * Whether the platform supports savepoints. |
||
| 3148 | * |
||
| 3149 | * @return bool |
||
| 3150 | */ |
||
| 3151 | public function supportsSavepoints() |
||
| 3152 | { |
||
| 3153 | return true; |
||
| 3154 | } |
||
| 3155 | |||
| 3156 | /** |
||
| 3157 | * Whether the platform supports releasing savepoints. |
||
| 3158 | * |
||
| 3159 | * @return bool |
||
| 3160 | */ |
||
| 3161 | public function supportsReleaseSavepoints() |
||
| 3162 | { |
||
| 3163 | return $this->supportsSavepoints(); |
||
| 3164 | } |
||
| 3165 | |||
| 3166 | /** |
||
| 3167 | * Whether the platform supports primary key constraints. |
||
| 3168 | * |
||
| 3169 | * @return bool |
||
| 3170 | */ |
||
| 3171 | public function supportsPrimaryConstraints() |
||
| 3172 | { |
||
| 3173 | return true; |
||
| 3174 | } |
||
| 3175 | |||
| 3176 | /** |
||
| 3177 | * Whether the platform supports foreign key constraints. |
||
| 3178 | * |
||
| 3179 | * @return bool |
||
| 3180 | */ |
||
| 3181 | public function supportsForeignKeyConstraints() |
||
| 3182 | { |
||
| 3183 | return true; |
||
| 3184 | } |
||
| 3185 | |||
| 3186 | /** |
||
| 3187 | * Whether this platform supports onUpdate in foreign key constraints. |
||
| 3188 | * |
||
| 3189 | * @return bool |
||
| 3190 | */ |
||
| 3191 | public function supportsForeignKeyOnUpdate() |
||
| 3194 | } |
||
| 3195 | |||
| 3196 | /** |
||
| 3197 | * Whether the platform supports database schemas. |
||
| 3198 | * |
||
| 3199 | * @return bool |
||
| 3200 | */ |
||
| 3201 | public function supportsSchemas() |
||
| 3202 | { |
||
| 3203 | return false; |
||
| 3204 | } |
||
| 3205 | |||
| 3206 | /** |
||
| 3207 | * Whether this platform can emulate schemas. |
||
| 3208 | * |
||
| 3209 | * Platforms that either support or emulate schemas don't automatically |
||
| 3210 | * filter a schema for the namespaced elements in {@link |
||
| 3211 | * AbstractManager#createSchema}. |
||
| 3212 | * |
||
| 3213 | * @return bool |
||
| 3214 | */ |
||
| 3215 | public function canEmulateSchemas() |
||
| 3216 | { |
||
| 3217 | return false; |
||
| 3218 | } |
||
| 3219 | |||
| 3220 | /** |
||
| 3221 | * Returns the default schema name. |
||
| 3222 | * |
||
| 3223 | * @return string |
||
| 3224 | * |
||
| 3225 | * @throws DBALException If not supported on this platform. |
||
| 3226 | */ |
||
| 3227 | public function getDefaultSchemaName() |
||
| 3230 | } |
||
| 3231 | |||
| 3232 | /** |
||
| 3233 | * Whether this platform supports create database. |
||
| 3234 | * |
||
| 3235 | * Some databases don't allow to create and drop databases at all or only with certain tools. |
||
| 3236 | * |
||
| 3237 | * @return bool |
||
| 3238 | */ |
||
| 3239 | public function supportsCreateDropDatabase() |
||
| 3242 | } |
||
| 3243 | |||
| 3244 | /** |
||
| 3245 | * Whether the platform supports getting the affected rows of a recent update/delete type query. |
||
| 3246 | * |
||
| 3247 | * @return bool |
||
| 3248 | */ |
||
| 3249 | public function supportsGettingAffectedRows() |
||
| 3250 | { |
||
| 3251 | return true; |
||
| 3252 | } |
||
| 3253 | |||
| 3254 | /** |
||
| 3255 | * Whether this platform support to add inline column comments as postfix. |
||
| 3256 | * |
||
| 3257 | * @return bool |
||
| 3258 | */ |
||
| 3259 | public function supportsInlineColumnComments() |
||
| 3260 | { |
||
| 3261 | return false; |
||
| 3262 | } |
||
| 3263 | |||
| 3264 | /** |
||
| 3265 | * Whether this platform support the proprietary syntax "COMMENT ON asset". |
||
| 3266 | * |
||
| 3267 | * @return bool |
||
| 3268 | */ |
||
| 3269 | public function supportsCommentOnStatement() |
||
| 3270 | { |
||
| 3271 | return false; |
||
| 3272 | } |
||
| 3273 | |||
| 3274 | /** |
||
| 3275 | * Does this platform have native guid type. |
||
| 3276 | * |
||
| 3277 | * @return bool |
||
| 3278 | */ |
||
| 3279 | public function hasNativeGuidType() |
||
| 3280 | { |
||
| 3281 | return false; |
||
| 3282 | } |
||
| 3283 | |||
| 3284 | /** |
||
| 3285 | * Does this platform have native JSON type. |
||
| 3286 | * |
||
| 3287 | * @return bool |
||
| 3288 | */ |
||
| 3289 | public function hasNativeJsonType() |
||
| 3290 | { |
||
| 3291 | return false; |
||
| 3292 | } |
||
| 3293 | |||
| 3294 | /** |
||
| 3295 | * @deprecated |
||
| 3296 | * |
||
| 3297 | * @return string |
||
| 3298 | * |
||
| 3299 | * @todo Remove in 3.0 |
||
| 3300 | */ |
||
| 3301 | public function getIdentityColumnNullInsertSQL() |
||
| 3302 | { |
||
| 3303 | return ''; |
||
| 3304 | } |
||
| 3305 | |||
| 3306 | /** |
||
| 3307 | * Whether this platform supports views. |
||
| 3308 | * |
||
| 3309 | * @return bool |
||
| 3310 | */ |
||
| 3311 | public function supportsViews() |
||
| 3312 | { |
||
| 3313 | return true; |
||
| 3314 | } |
||
| 3315 | |||
| 3316 | /** |
||
| 3317 | * Does this platform support column collation? |
||
| 3318 | * |
||
| 3319 | * @return bool |
||
| 3320 | */ |
||
| 3321 | public function supportsColumnCollation() |
||
| 3322 | { |
||
| 3323 | return false; |
||
| 3324 | } |
||
| 3325 | |||
| 3326 | /** |
||
| 3327 | * Gets the format string, as accepted by the date() function, that describes |
||
| 3328 | * the format of a stored datetime value of this platform. |
||
| 3329 | * |
||
| 3330 | * @return string The format string. |
||
| 3331 | */ |
||
| 3332 | public function getDateTimeFormatString() |
||
| 3333 | { |
||
| 3334 | return 'Y-m-d H:i:s'; |
||
| 3335 | } |
||
| 3336 | |||
| 3337 | /** |
||
| 3338 | * Gets the format string, as accepted by the date() function, that describes |
||
| 3339 | * the format of a stored datetime with timezone value of this platform. |
||
| 3340 | * |
||
| 3341 | * @return string The format string. |
||
| 3342 | */ |
||
| 3343 | public function getDateTimeTzFormatString() |
||
| 3344 | { |
||
| 3345 | return 'Y-m-d H:i:s'; |
||
| 3346 | } |
||
| 3347 | |||
| 3348 | /** |
||
| 3349 | * Gets the format string, as accepted by the date() function, that describes |
||
| 3350 | * the format of a stored date value of this platform. |
||
| 3351 | * |
||
| 3352 | * @return string The format string. |
||
| 3353 | */ |
||
| 3354 | public function getDateFormatString() |
||
| 3355 | { |
||
| 3356 | return 'Y-m-d'; |
||
| 3357 | } |
||
| 3358 | |||
| 3359 | /** |
||
| 3360 | * Gets the format string, as accepted by the date() function, that describes |
||
| 3361 | * the format of a stored time value of this platform. |
||
| 3362 | * |
||
| 3363 | * @return string The format string. |
||
| 3364 | */ |
||
| 3365 | public function getTimeFormatString() |
||
| 3366 | { |
||
| 3367 | return 'H:i:s'; |
||
| 3368 | } |
||
| 3369 | |||
| 3370 | /** |
||
| 3371 | * Adds an driver-specific LIMIT clause to the query. |
||
| 3372 | * |
||
| 3373 | * @param string $query |
||
| 3374 | * @param int|null $limit |
||
| 3375 | * @param int|null $offset |
||
| 3376 | * |
||
| 3377 | * @return string |
||
| 3378 | * |
||
| 3379 | * @throws DBALException |
||
| 3380 | */ |
||
| 3381 | final public function modifyLimitQuery($query, $limit, $offset = null) |
||
| 3382 | { |
||
| 3383 | if ($limit !== null) { |
||
| 3384 | $limit = (int) $limit; |
||
| 3385 | } |
||
| 3386 | |||
| 3387 | $offset = (int) $offset; |
||
| 3388 | |||
| 3389 | if ($offset < 0) { |
||
| 3390 | throw new DBALException(sprintf( |
||
| 3391 | 'Offset must be a positive integer or zero, %d given', |
||
| 3392 | $offset |
||
| 3393 | )); |
||
| 3394 | } |
||
| 3395 | |||
| 3396 | if ($offset > 0 && ! $this->supportsLimitOffset()) { |
||
| 3397 | throw new DBALException(sprintf( |
||
| 3398 | 'Platform %s does not support offset values in limit queries.', |
||
| 3399 | $this->getName() |
||
| 3400 | )); |
||
| 3401 | } |
||
| 3402 | |||
| 3403 | return $this->doModifyLimitQuery($query, $limit, $offset); |
||
| 3404 | } |
||
| 3405 | |||
| 3406 | /** |
||
| 3407 | * Adds an platform-specific LIMIT clause to the query. |
||
| 3408 | * |
||
| 3409 | * @param string $query |
||
| 3410 | * @param int|null $limit |
||
| 3411 | * @param int|null $offset |
||
| 3412 | * |
||
| 3413 | * @return string |
||
| 3414 | */ |
||
| 3415 | protected function doModifyLimitQuery($query, $limit, $offset) |
||
| 3416 | { |
||
| 3417 | if ($limit !== null) { |
||
| 3418 | $query .= ' LIMIT ' . $limit; |
||
| 3419 | } |
||
| 3420 | |||
| 3421 | if ($offset > 0) { |
||
| 3422 | $query .= ' OFFSET ' . $offset; |
||
| 3423 | } |
||
| 3424 | |||
| 3425 | return $query; |
||
| 3426 | } |
||
| 3427 | |||
| 3428 | /** |
||
| 3429 | * Whether the database platform support offsets in modify limit clauses. |
||
| 3430 | * |
||
| 3431 | * @return bool |
||
| 3432 | */ |
||
| 3433 | public function supportsLimitOffset() |
||
| 3436 | } |
||
| 3437 | |||
| 3438 | /** |
||
| 3439 | * Gets the character casing of a column in an SQL result set of this platform. |
||
| 3440 | * |
||
| 3441 | * @param string $column The column name for which to get the correct character casing. |
||
| 3442 | * |
||
| 3443 | * @return string The column name in the character casing used in SQL result sets. |
||
| 3444 | */ |
||
| 3445 | public function getSQLResultCasing($column) |
||
| 3446 | { |
||
| 3447 | return $column; |
||
| 3448 | } |
||
| 3449 | |||
| 3450 | /** |
||
| 3451 | * Makes any fixes to a name of a schema element (table, sequence, ...) that are required |
||
| 3452 | * by restrictions of the platform, like a maximum length. |
||
| 3453 | * |
||
| 3454 | * @param string $schemaElementName |
||
| 3455 | * |
||
| 3456 | * @return string |
||
| 3457 | */ |
||
| 3458 | public function fixSchemaElementName($schemaElementName) |
||
| 3461 | } |
||
| 3462 | |||
| 3463 | /** |
||
| 3464 | * Maximum length of any given database identifier, like tables or column names. |
||
| 3465 | * |
||
| 3466 | * @return int |
||
| 3467 | */ |
||
| 3468 | public function getMaxIdentifierLength() |
||
| 3471 | } |
||
| 3472 | |||
| 3473 | /** |
||
| 3474 | * Returns the insert SQL for an empty insert statement. |
||
| 3475 | * |
||
| 3476 | * @param string $tableName |
||
| 3477 | * @param string $identifierColumnName |
||
| 3478 | * |
||
| 3479 | * @return string |
||
| 3480 | */ |
||
| 3481 | public function getEmptyIdentityInsertSQL($tableName, $identifierColumnName) |
||
| 3482 | { |
||
| 3483 | return 'INSERT INTO ' . $tableName . ' (' . $identifierColumnName . ') VALUES (null)'; |
||
| 3484 | } |
||
| 3485 | |||
| 3486 | /** |
||
| 3487 | * Generates a Truncate Table SQL statement for a given table. |
||
| 3488 | * |
||
| 3489 | * Cascade is not supported on many platforms but would optionally cascade the truncate by |
||
| 3490 | * following the foreign keys. |
||
| 3491 | * |
||
| 3492 | * @param string $tableName |
||
| 3493 | * @param bool $cascade |
||
| 3494 | * |
||
| 3495 | * @return string |
||
| 3496 | */ |
||
| 3497 | public function getTruncateTableSQL($tableName, $cascade = false) |
||
| 3498 | { |
||
| 3499 | $tableIdentifier = new Identifier($tableName); |
||
| 3500 | |||
| 3501 | return 'TRUNCATE ' . $tableIdentifier->getQuotedName($this); |
||
| 3502 | } |
||
| 3503 | |||
| 3504 | /** |
||
| 3505 | * This is for test reasons, many vendors have special requirements for dummy statements. |
||
| 3506 | * |
||
| 3507 | * @return string |
||
| 3508 | */ |
||
| 3509 | public function getDummySelectSQL() |
||
| 3510 | { |
||
| 3511 | $expression = func_num_args() > 0 ? func_get_arg(0) : '1'; |
||
| 3512 | |||
| 3513 | return sprintf('SELECT %s', $expression); |
||
| 3514 | } |
||
| 3515 | |||
| 3516 | /** |
||
| 3517 | * Returns the SQL to create a new savepoint. |
||
| 3518 | * |
||
| 3519 | * @param string $savepoint |
||
| 3520 | * |
||
| 3521 | * @return string |
||
| 3522 | */ |
||
| 3523 | public function createSavePoint($savepoint) |
||
| 3526 | } |
||
| 3527 | |||
| 3528 | /** |
||
| 3529 | * Returns the SQL to release a savepoint. |
||
| 3530 | * |
||
| 3531 | * @param string $savepoint |
||
| 3532 | * |
||
| 3533 | * @return string |
||
| 3534 | */ |
||
| 3535 | public function releaseSavePoint($savepoint) |
||
| 3536 | { |
||
| 3537 | return 'RELEASE SAVEPOINT ' . $savepoint; |
||
| 3538 | } |
||
| 3539 | |||
| 3540 | /** |
||
| 3541 | * Returns the SQL to rollback a savepoint. |
||
| 3542 | * |
||
| 3543 | * @param string $savepoint |
||
| 3544 | * |
||
| 3545 | * @return string |
||
| 3546 | */ |
||
| 3547 | public function rollbackSavePoint($savepoint) |
||
| 3548 | { |
||
| 3549 | return 'ROLLBACK TO SAVEPOINT ' . $savepoint; |
||
| 3550 | } |
||
| 3551 | |||
| 3552 | /** |
||
| 3553 | * Returns the keyword list instance of this platform. |
||
| 3554 | * |
||
| 3555 | * @return KeywordList |
||
| 3556 | * |
||
| 3557 | * @throws DBALException If no keyword list is specified. |
||
| 3558 | */ |
||
| 3559 | final public function getReservedKeywordsList() |
||
| 3560 | { |
||
| 3561 | // Check for an existing instantiation of the keywords class. |
||
| 3562 | if ($this->_keywords !== null) { |
||
| 3563 | return $this->_keywords; |
||
| 3564 | } |
||
| 3565 | |||
| 3566 | $class = $this->getReservedKeywordsClass(); |
||
| 3567 | $keywords = new $class(); |
||
| 3568 | if (! $keywords instanceof KeywordList) { |
||
| 3569 | throw DBALException::notSupported(__METHOD__); |
||
| 3570 | } |
||
| 3571 | |||
| 3572 | // Store the instance so it doesn't need to be generated on every request. |
||
| 3573 | $this->_keywords = $keywords; |
||
| 3574 | |||
| 3575 | return $keywords; |
||
| 3576 | } |
||
| 3577 | |||
| 3578 | /** |
||
| 3579 | * Returns the class name of the reserved keywords list. |
||
| 3580 | * |
||
| 3581 | * @return string |
||
| 3582 | * |
||
| 3583 | * @throws DBALException If not supported on this platform. |
||
| 3584 | */ |
||
| 3585 | protected function getReservedKeywordsClass() |
||
| 3588 | } |
||
| 3589 | |||
| 3590 | /** |
||
| 3591 | * Quotes a literal string. |
||
| 3592 | * This method is NOT meant to fix SQL injections! |
||
| 3593 | * It is only meant to escape this platform's string literal |
||
| 3594 | * quote character inside the given literal string. |
||
| 3595 | * |
||
| 3596 | * @param string $str The literal string to be quoted. |
||
| 3597 | * |
||
| 3598 | * @return string The quoted literal string. |
||
| 3599 | */ |
||
| 3600 | public function quoteStringLiteral($str) |
||
| 3601 | { |
||
| 3602 | $c = $this->getStringLiteralQuoteCharacter(); |
||
| 3603 | |||
| 3604 | return $c . str_replace($c, $c . $c, $str) . $c; |
||
| 3605 | } |
||
| 3606 | |||
| 3607 | /** |
||
| 3608 | * Gets the character used for string literal quoting. |
||
| 3609 | * |
||
| 3610 | * @return string |
||
| 3611 | */ |
||
| 3612 | public function getStringLiteralQuoteCharacter() |
||
| 3615 | } |
||
| 3616 | |||
| 3617 | /** |
||
| 3618 | * Escapes metacharacters in a string intended to be used with a LIKE |
||
| 3619 | * operator. |
||
| 3620 | * |
||
| 3621 | * @param string $inputString a literal, unquoted string |
||
| 3622 | * @param string $escapeChar should be reused by the caller in the LIKE |
||
| 3623 | * expression. |
||
| 3624 | */ |
||
| 3625 | final public function escapeStringForLike(string $inputString, string $escapeChar) : string |
||
| 3626 | { |
||
| 3627 | return preg_replace( |
||
| 3628 | '~([' . preg_quote($this->getLikeWildcardCharacters() . $escapeChar, '~') . '])~u', |
||
| 3629 | addcslashes($escapeChar, '\\') . '$1', |
||
| 3630 | $inputString |
||
| 3631 | ); |
||
| 3632 | } |
||
| 3633 | |||
| 3634 | protected function getLikeWildcardCharacters() : string |
||
| 3635 | { |
||
| 3637 | } |
||
| 3638 | } |
||
| 3639 |
This check looks for parameters that have been defined for a function or method, but which are not used in the method body.