<?php
declare(strict_types=1);
namespace Doctrine\DBAL\Platforms;
use Doctrine\Common\EventManager;
use Doctrine\DBAL\DBALException;
use Doctrine\DBAL\Event\SchemaAlterTableAddColumnEventArgs;
use Doctrine\DBAL\Event\SchemaAlterTableChangeColumnEventArgs;
use Doctrine\DBAL\Event\SchemaAlterTableEventArgs;
use Doctrine\DBAL\Event\SchemaAlterTableRemoveColumnEventArgs;
use Doctrine\DBAL\Event\SchemaAlterTableRenameColumnEventArgs;
use Doctrine\DBAL\Event\SchemaCreateTableColumnEventArgs;
use Doctrine\DBAL\Event\SchemaCreateTableEventArgs;
use Doctrine\DBAL\Event\SchemaDropTableEventArgs;
use Doctrine\DBAL\Events;
use Doctrine\DBAL\Platforms\Exception\NoColumnsSpecifiedForTable;
use Doctrine\DBAL\Platforms\Exception\NotSupported;
use Doctrine\DBAL\Platforms\Keywords\KeywordList;
use Doctrine\DBAL\Schema\Column;
use Doctrine\DBAL\Schema\ColumnDiff;
use Doctrine\DBAL\Schema\Constraint;
use Doctrine\DBAL\Schema\ForeignKeyConstraint;
use Doctrine\DBAL\Schema\Identifier;
use Doctrine\DBAL\Schema\Index;
use Doctrine\DBAL\Schema\Sequence;
use Doctrine\DBAL\Schema\Table;
use Doctrine\DBAL\Schema\TableDiff;
use Doctrine\DBAL\Schema\UniqueConstraint;
use Doctrine\DBAL\TransactionIsolationLevel;
use Doctrine\DBAL\Types;
use Doctrine\DBAL\Types\Exception\TypeNotFound;
use Doctrine\DBAL\Types\Type;
use InvalidArgumentException;
use UnexpectedValueException;
use function addcslashes;
use function array_map;
use function array_merge;
use function array_unique;
use function array_values;
use function assert;
use function count;
use function explode;
use function implode;
use function in_array;
use function is_array;
use function is_bool;
use function is_float;
use function is_int;
use function is_string;
use function preg_quote;
use function preg_replace;
use function sprintf;
use function str_replace;
use function strlen;
use function strpos;
use function strtolower;
use function strtoupper;
/**
* Base class for all DatabasePlatforms. The DatabasePlatforms are the central
* point of abstraction of platform-specific behaviors, features and SQL dialects.
* They are a passive source of information.
*
* @todo Remove any unnecessary methods.
*/
abstract class AbstractPlatform
{
public const CREATE_INDEXES = 1;
public const CREATE_FOREIGNKEYS = 2;
/** @var string[]|null */
protected $doctrineTypeMapping = null;
/**
* Contains a list of all columns that should generate parseable column comments for type-detection
* in reverse engineering scenarios.
*
* @var string[]|null
*/
protected $doctrineTypeComments = null;
/** @var EventManager|null */
protected $_eventManager;
/**
* Holds the KeywordList instance for the current platform.
*
* @var KeywordList|null
*/
protected $_keywords;
public function __construct()
{
}
/**
* Sets the EventManager used by the Platform.
*/
public function setEventManager(EventManager $eventManager) : void
{
$this->_eventManager = $eventManager;
}
/**
* Gets the EventManager used by the Platform.
*/
public function getEventManager() : ?EventManager
{
return $this->_eventManager;
}
/**
* Returns the SQL snippet that declares a boolean column.
*
* @param mixed[] $columnDef
*/
abstract public function getBooleanTypeDeclarationSQL(array $columnDef) : string;
/**
* Returns the SQL snippet that declares a 4 byte integer column.
*
* @param mixed[] $columnDef
*/
abstract public function getIntegerTypeDeclarationSQL(array $columnDef) : string;
/**
* Returns the SQL snippet that declares an 8 byte integer column.
*
* @param mixed[] $columnDef
*/
abstract public function getBigIntTypeDeclarationSQL(array $columnDef) : string;
/**
* Returns the SQL snippet that declares a 2 byte integer column.
*
* @param mixed[] $columnDef
*/
abstract public function getSmallIntTypeDeclarationSQL(array $columnDef) : string;
/**
* Returns the SQL snippet that declares common properties of an integer column.
*
* @param mixed[] $columnDef
*/
abstract protected function _getCommonIntegerTypeDeclarationSQL(array $columnDef) : string;
/**
* Lazy load Doctrine Type Mappings.
*/
abstract protected function initializeDoctrineTypeMappings() : void;
/**
* Initializes Doctrine Type Mappings with the platform defaults
* and with all additional type mappings.
*/
private function initializeAllDoctrineTypeMappings() : void
{
$this->initializeDoctrineTypeMappings();
foreach (Type::getTypesMap() as $typeName => $className) {
foreach (Type::getType($typeName)->getMappedDatabaseTypes($this) as $dbType) {
$this->doctrineTypeMapping[$dbType] = $typeName;
}
}
}
/**
* Returns the SQL snippet used to declare a VARCHAR column type.
*
* @param mixed[] $field
*/
public function getVarcharTypeDeclarationSQL(array $field) : string
{
if (! isset($field['length'])) {
$field['length'] = $this->getVarcharDefaultLength();
}
$fixed = $field['fixed'] ?? false;
$maxLength = $fixed
? $this->getCharMaxLength()
: $this->getVarcharMaxLength();
if ($field['length'] > $maxLength) {
return $this->getClobTypeDeclarationSQL($field);
}
return $this->getVarcharTypeDeclarationSQLSnippet($field['length'], $fixed);
}
/**
* Returns the SQL snippet used to declare a BINARY/VARBINARY column type.
*
* @param mixed[] $field The column definition.
*/
public function getBinaryTypeDeclarationSQL(array $field) : string
{
if (! isset($field['length'])) {
$field['length'] = $this->getBinaryDefaultLength();
}
$fixed = $field['fixed'] ?? false;
return $this->getBinaryTypeDeclarationSQLSnippet($field['length'], $fixed);
}
/**
* Returns the SQL snippet to declare a GUID/UUID field.
*
* By default this maps directly to a CHAR(36) and only maps to more
* special datatypes when the underlying databases support this datatype.
*
* @param mixed[] $field
*/
public function getGuidTypeDeclarationSQL(array $field) : string
{
$field['length'] = 36;
$field['fixed'] = true;
return $this->getVarcharTypeDeclarationSQL($field);
}
/**
* Returns the SQL snippet to declare a JSON field.
*
* By default this maps directly to a CLOB and only maps to more
* special datatypes when the underlying databases support this datatype.
*
* @param mixed[] $field
*/
public function getJsonTypeDeclarationSQL(array $field) : string
{
return $this->getClobTypeDeclarationSQL($field);
}
/**
* @param int $length The length of the column.
* @param bool $fixed Whether the column length is fixed.
*
* @throws DBALException If not supported on this platform.
*/
protected function getVarcharTypeDeclarationSQLSnippet(int $length, bool $fixed) : string
{
throw NotSupported::new('VARCHARs not supported by Platform.');
}
/**
* Returns the SQL snippet used to declare a BINARY/VARBINARY column type.
*
* @param int $length The length of the column.
* @param bool $fixed Whether the column length is fixed.
*
* @throws DBALException If not supported on this platform.
*/
protected function getBinaryTypeDeclarationSQLSnippet(int $length, bool $fixed) : string
{
throw NotSupported::new('BINARY/VARBINARY column types are not supported by this platform.');
}
/**
* Returns the SQL snippet used to declare a CLOB column type.
*
* @param mixed[] $field
*/
abstract public function getClobTypeDeclarationSQL(array $field) : string;
/**
* Returns the SQL Snippet used to declare a BLOB column type.
*
* @param mixed[] $field
*/
abstract public function getBlobTypeDeclarationSQL(array $field) : string;
/**
* Gets the name of the platform.
*/
abstract public function getName() : string;
/**
* Registers a doctrine type to be used in conjunction with a column type of this platform.
*
* @throws DBALException If the type is not found.
*/
public function registerDoctrineTypeMapping(string $dbType, string $doctrineType) : void
{
if ($this->doctrineTypeMapping === null) {
$this->initializeAllDoctrineTypeMappings();
}
if (! Types\Type::hasType($doctrineType)) {
throw TypeNotFound::new($doctrineType);
}
$dbType = strtolower($dbType);
$this->doctrineTypeMapping[$dbType] = $doctrineType;
$doctrineType = Type::getType($doctrineType);
if (! $doctrineType->requiresSQLCommentHint($this)) {
return;
}
$this->markDoctrineTypeCommented($doctrineType);
}
/**
* Gets the Doctrine type that is mapped for the given database column type.
*
* @throws DBALException
*/
public function getDoctrineTypeMapping(string $dbType) : string
{
if ($this->doctrineTypeMapping === null) {
$this->initializeAllDoctrineTypeMappings();
}
$dbType = strtolower($dbType);
if (! isset($this->doctrineTypeMapping[$dbType])) {
throw new DBALException(sprintf(
'Unknown database type "%s" requested, %s may not support it.',
$dbType,
static::class
));
}
return $this->doctrineTypeMapping[$dbType];
}
/**
* Checks if a database type is currently supported by this platform.
*/
public function hasDoctrineTypeMappingFor(string $dbType) : bool
{
if ($this->doctrineTypeMapping === null) {
$this->initializeAllDoctrineTypeMappings();
}
$dbType = strtolower($dbType);
return isset($this->doctrineTypeMapping[$dbType]);
}
/**
* Initializes the Doctrine Type comments instance variable for in_array() checks.
*/
protected function initializeCommentedDoctrineTypes() : void
{
$this->doctrineTypeComments = [];
foreach (Type::getTypesMap() as $typeName => $className) {
$type = Type::getType($typeName);
if (! $type->requiresSQLCommentHint($this)) {
continue;
}
$this->doctrineTypeComments[] = $typeName;
}
}
/**
* Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?
*/
public function isCommentedDoctrineType(Type $doctrineType) : bool
{
if ($this->doctrineTypeComments === null) {
$this->initializeCommentedDoctrineTypes();
}
assert(is_array($this->doctrineTypeComments));
return in_array($doctrineType->getName(), $this->doctrineTypeComments);
}
/**
* Marks this type as to be commented in ALTER TABLE and CREATE TABLE statements.
*
* @param string|Type $doctrineType
*/
public function markDoctrineTypeCommented($doctrineType) : void
{
if ($this->doctrineTypeComments === null) {
$this->initializeCommentedDoctrineTypes();
}
assert(is_array($this->doctrineTypeComments));
$this->doctrineTypeComments[] = $doctrineType instanceof Type ? $doctrineType->getName() : $doctrineType;
}
/**
* Gets the comment to append to a column comment that helps parsing this type in reverse engineering.
*/
public function getDoctrineTypeComment(Type $doctrineType) : string
{
return '(DC2Type:' . $doctrineType->getName() . ')';
}
/**
* Gets the comment of a passed column modified by potential doctrine type comment hints.
*/
protected function getColumnComment(Column $column) : ?string
{
$comment = $column->getComment();
if ($this->isCommentedDoctrineType($column->getType())) {
$comment .= $this->getDoctrineTypeComment($column->getType());
}
return $comment;
}
/**
* Gets the character used for identifier quoting.
*/
public function getIdentifierQuoteCharacter() : string
{
return '"';
}
/**
* Gets the string portion that starts an SQL comment.
*/
public function getSqlCommentStartString() : string
{
return '--';
}
/**
* Gets the string portion that ends an SQL comment.
*/
public function getSqlCommentEndString() : string
{
return "\n";
}
/**
* Gets the maximum length of a char field.
*/
public function getCharMaxLength() : int
{
return $this->getVarcharMaxLength();
}
/**
* Gets the maximum length of a varchar field.
*/
public function getVarcharMaxLength() : int
{
return 4000;
}
/**
* Gets the default length of a varchar field.
*/
public function getVarcharDefaultLength() : int
{
return 255;
}
/**
* Gets the maximum length of a binary field.
*/
public function getBinaryMaxLength() : int
{
return 4000;
}
/**
* Gets the default length of a binary field.
*/
public function getBinaryDefaultLength() : int
{
return 255;
}
/**
* Gets all SQL wildcard characters of the platform.
*
* @return string[]
*/
public function getWildcards() : array
{
return ['%', '_'];
}
/**
* Returns the regular expression operator.
*
* @throws DBALException If not supported on this platform.
*/
public function getRegexpExpression() : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Returns the SQL snippet to get the average value of a column.
*
* @param string $value SQL expression producing the value.
*/
public function getAvgExpression(string $value) : string
{
return 'AVG(' . $value . ')';
}
/**
* Returns the SQL snippet to get the number of rows (without a NULL value) of a column.
*
* If a '*' is used instead of a column the number of selected rows is returned.
*
* @param string $expression The expression to count.
*/
public function getCountExpression(string $expression) : string
{
return 'COUNT(' . $expression . ')';
}
/**
* Returns the SQL snippet to get the maximum value in a set of values.
*
* @param string $value SQL expression producing the value.
*/
public function getMaxExpression(string $value) : string
{
return 'MAX(' . $value . ')';
}
/**
* Returns the SQL snippet to get the minimum value in a set of values.
*
* @param string $value SQL expression producing the value.
*/
public function getMinExpression(string $value) : string
{
return 'MIN(' . $value . ')';
}
/**
* Returns the SQL snippet to get the total sum of the values in a set.
*
* @param string $value SQL expression producing the value.
*/
public function getSumExpression(string $value) : string
{
return 'SUM(' . $value . ')';
}
// scalar functions
/**
* Returns the SQL snippet to get the md5 sum of the value.
*
* Note: Not SQL92, but common functionality.
*
* @param string $string SQL expression producing the string.
*/
public function getMd5Expression(string $string) : string
{
return 'MD5(' . $string . ')';
}
/**
* Returns the SQL snippet to get the length of a text field.
*
* @param string $string SQL expression producing the string.
*/
public function getLengthExpression(string $string) : string
{
return 'LENGTH(' . $string . ')';
}
/**
* Returns the SQL snippet to get the square root of the value.
*
* @param string $number SQL expression producing the number.
*/
public function getSqrtExpression(string $number) : string
{
return 'SQRT(' . $number . ')';
}
/**
* Returns the SQL snippet to round a number to the number of decimals specified.
*
* @param string $number SQL expression producing the number to round.
* @param string $decimals SQL expression producing the number of decimals.
*/
public function getRoundExpression(string $number, string $decimals = '0') : string
{
return 'ROUND(' . $number . ', ' . $decimals . ')';
}
/**
* Returns the SQL snippet to get the remainder of the operation of division of dividend by divisor.
*
* @param string $dividend SQL expression producing the dividend.
* @param string $divisor SQL expression producing the divisor.
*/
public function getModExpression(string $dividend, string $divisor) : string
{
return 'MOD(' . $dividend . ', ' . $divisor . ')';
}
/**
* Returns the SQL snippet to trim a string.
*
* @param string $str The expression to apply the trim to.
* @param int $mode The position of the trim (leading/trailing/both).
* @param string|null $char The char to trim, has to be quoted already. Defaults to space.
*
* @throws InvalidArgumentException
*/
public function getTrimExpression(string $str, int $mode = TrimMode::UNSPECIFIED, ?string $char = null) : string
{
$tokens = [];
switch ($mode) {
case TrimMode::UNSPECIFIED:
break;
case TrimMode::LEADING:
$tokens[] = 'LEADING';
break;
case TrimMode::TRAILING:
$tokens[] = 'TRAILING';
break;
case TrimMode::BOTH:
$tokens[] = 'BOTH';
break;
default:
throw new InvalidArgumentException(
sprintf(
'The value of $mode is expected to be one of the TrimMode constants, %d given.',
$mode
)
);
}
if ($char !== null) {
$tokens[] = $char;
}
if (count($tokens) > 0) {
$tokens[] = 'FROM';
}
$tokens[] = $str;
return sprintf('TRIM(%s)', implode(' ', $tokens));
}
/**
* Returns the SQL snippet to trim trailing space characters from the string.
*
* @param string $string SQL expression producing the string.
*/
public function getRtrimExpression(string $string) : string
{
return 'RTRIM(' . $string . ')';
}
/**
* Returns the SQL snippet to trim leading space characters from the string.
*
* @param string $string SQL expression producing the string.
*/
public function getLtrimExpression(string $string) : string
{
return 'LTRIM(' . $string . ')';
}
/**
* Returns the SQL snippet to change all characters from the string to uppercase,
* according to the current character set mapping.
*
* @param string $string SQL expression producing the string.
*/
public function getUpperExpression(string $string) : string
{
return 'UPPER(' . $string . ')';
}
/**
* Returns the SQL snippet to change all characters from the string to lowercase,
* according to the current character set mapping.
*
* @param string $string SQL expression producing the string.
*/
public function getLowerExpression(string $string) : string
{
return 'LOWER(' . $string . ')';
}
/**
* Returns the SQL snippet to get the position of the first occurrence of the substring in the string.
*
* @param string $string SQL expression producing the string to locate the substring in.
* @param string $substring SQL expression producing the substring to locate.
* @param string|null $start SQL expression producing the position to start at.
* Defaults to the beginning of the string.
*
* @throws DBALException If not supported on this platform.
*/
public function getLocateExpression(string $string, string $substring, ?string $start = null) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Returns the SQL snippet to get the current system date.
*/
public function getNowExpression() : string
{
return 'NOW()';
}
/**
* Returns an SQL snippet to get a substring inside the string.
*
* Note: Not SQL92, but common functionality.
*
* @param string $string SQL expression producing the string from which a substring should be extracted.
* @param string $start SQL expression producing the position to start at,
* @param string|null $length SQL expression producing the length of the substring portion to be returned.
* By default, the entire substring is returned.
*/
public function getSubstringExpression(string $string, string $start, ?string $length = null) : string
{
if ($length === null) {
return sprintf('SUBSTRING(%s FROM %s)', $string, $start);
}
return sprintf('SUBSTRING(%s FROM %s FOR %s)', $string, $start, $length);
}
/**
* Returns a SQL snippet to concatenate the given strings.
*
* @param string[] ...$string
*/
public function getConcatExpression(string ...$string) : string
{
return implode(' || ', $string);
}
/**
* Returns the SQL for a logical not.
*
* @param string $value SQL expression producing the value to negate.
*/
public function getNotExpression(string $value) : string
{
return 'NOT(' . $value . ')';
}
/**
* Returns the SQL that checks if an expression is null.
*
* @param string $value SQL expression producing the to be compared to null.
*/
public function getIsNullExpression(string $value) : string
{
return $value . ' IS NULL';
}
/**
* Returns the SQL that checks if an expression is not null.
*
* @param string $value SQL expression producing the to be compared to null.
*/
public function getIsNotNullExpression(string $value) : string
{
return $value . ' IS NOT NULL';
}
/**
* Returns the SQL that checks if an expression evaluates to a value between two values.
*
* The parameter $value is checked if it is between $min and $max.
*
* Note: There is a slight difference in the way BETWEEN works on some databases.
* http://www.w3schools.com/sql/sql_between.asp. If you want complete database
* independence you should avoid using between().
*
* @param string $value SQL expression producing the value to compare.
* @param string $min SQL expression producing the lower value to compare with.
* @param string $max SQL expression producing the higher value to compare with.
*/
public function getBetweenExpression(string $value, string $min, string $max) : string
{
return $value . ' BETWEEN ' . $min . ' AND ' . $max;
}
/**
* Returns the SQL to get the arccosine of a value.
*
* @param string $number SQL expression producing the number.
*/
public function getAcosExpression(string $number) : string
{
return 'ACOS(' . $number . ')';
}
/**
* Returns the SQL to get the sine of a value.
*
* @param string $number SQL expression producing the number.
*/
public function getSinExpression(string $number) : string
{
return 'SIN(' . $number . ')';
}
/**
* Returns the SQL to get the PI value.
*/
public function getPiExpression() : string
{
return 'PI()';
}
/**
* Returns the SQL to get the cosine of a value.
*
* @param string $number SQL expression producing the number.
*/
public function getCosExpression(string $number) : string
{
return 'COS(' . $number . ')';
}
/**
* Returns the SQL to calculate the difference in days between the two passed dates.
*
* Computes diff = date1 - date2.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateDiffExpression(string $date1, string $date2) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Returns the SQL to add the number of given seconds to a date.
*
* @param string $date SQL expression producing the date.
* @param string $seconds SQL expression producing the number of seconds.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateAddSecondsExpression(string $date, string $seconds) : string
{
return $this->getDateArithmeticIntervalExpression($date, '+', $seconds, DateIntervalUnit::SECOND);
}
/**
* Returns the SQL to subtract the number of given seconds from a date.
*
* @param string $date SQL expression producing the date.
* @param string $seconds SQL expression producing the number of seconds.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateSubSecondsExpression(string $date, string $seconds) : string
{
return $this->getDateArithmeticIntervalExpression($date, '-', $seconds, DateIntervalUnit::SECOND);
}
/**
* Returns the SQL to add the number of given minutes to a date.
*
* @param string $date SQL expression producing the date.
* @param string $minutes SQL expression producing the number of minutes.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateAddMinutesExpression(string $date, string $minutes) : string
{
return $this->getDateArithmeticIntervalExpression($date, '+', $minutes, DateIntervalUnit::MINUTE);
}
/**
* Returns the SQL to subtract the number of given minutes from a date.
*
* @param string $date SQL expression producing the date.
* @param string $minutes SQL expression producing the number of minutes.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateSubMinutesExpression(string $date, string $minutes) : string
{
return $this->getDateArithmeticIntervalExpression($date, '-', $minutes, DateIntervalUnit::MINUTE);
}
/**
* Returns the SQL to add the number of given hours to a date.
*
* @param string $date SQL expression producing the date.
* @param string $hours SQL expression producing the number of hours.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateAddHourExpression(string $date, string $hours) : string
{
return $this->getDateArithmeticIntervalExpression($date, '+', $hours, DateIntervalUnit::HOUR);
}
/**
* Returns the SQL to subtract the number of given hours to a date.
*
* @param string $date SQL expression producing the date.
* @param string $hours SQL expression producing the number of hours.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateSubHourExpression(string $date, string $hours) : string
{
return $this->getDateArithmeticIntervalExpression($date, '-', $hours, DateIntervalUnit::HOUR);
}
/**
* Returns the SQL to add the number of given days to a date.
*
* @param string $date SQL expression producing the date.
* @param string $days SQL expression producing the number of days.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateAddDaysExpression(string $date, string $days) : string
{
return $this->getDateArithmeticIntervalExpression($date, '+', $days, DateIntervalUnit::DAY);
}
/**
* Returns the SQL to subtract the number of given days to a date.
*
* @param string $date SQL expression producing the date.
* @param string $days SQL expression producing the number of days.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateSubDaysExpression(string $date, string $days) : string
{
return $this->getDateArithmeticIntervalExpression($date, '-', $days, DateIntervalUnit::DAY);
}
/**
* Returns the SQL to add the number of given weeks to a date.
*
* @param string $date SQL expression producing the date.
* @param string $weeks SQL expression producing the number of weeks.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateAddWeeksExpression(string $date, string $weeks) : string
{
return $this->getDateArithmeticIntervalExpression($date, '+', $weeks, DateIntervalUnit::WEEK);
}
/**
* Returns the SQL to subtract the number of given weeks from a date.
*
* @param string $date SQL expression producing the date.
* @param string $weeks SQL expression producing the number of weeks.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateSubWeeksExpression(string $date, string $weeks) : string
{
return $this->getDateArithmeticIntervalExpression($date, '-', $weeks, DateIntervalUnit::WEEK);
}
/**
* Returns the SQL to add the number of given months to a date.
*
* @param string $date SQL expression producing the date.
* @param string $months SQL expression producing the number of months.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateAddMonthExpression(string $date, string $months) : string
{
return $this->getDateArithmeticIntervalExpression($date, '+', $months, DateIntervalUnit::MONTH);
}
/**
* Returns the SQL to subtract the number of given months to a date.
*
* @param string $date SQL expression producing the date.
* @param string $months SQL expression producing the number of months.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateSubMonthExpression(string $date, string $months) : string
{
return $this->getDateArithmeticIntervalExpression($date, '-', $months, DateIntervalUnit::MONTH);
}
/**
* Returns the SQL to add the number of given quarters to a date.
*
* @param string $date SQL expression producing the date.
* @param string $quarters SQL expression producing the number of quarters.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateAddQuartersExpression(string $date, string $quarters) : string
{
return $this->getDateArithmeticIntervalExpression($date, '+', $quarters, DateIntervalUnit::QUARTER);
}
/**
* Returns the SQL to subtract the number of given quarters from a date.
*
* @param string $date SQL expression producing the date.
* @param string $quarters SQL expression producing the number of quarters.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateSubQuartersExpression(string $date, string $quarters) : string
{
return $this->getDateArithmeticIntervalExpression($date, '-', $quarters, DateIntervalUnit::QUARTER);
}
/**
* Returns the SQL to add the number of given years to a date.
*
* @param string $date SQL expression producing the date.
* @param string $years SQL expression producing the number of years.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateAddYearsExpression(string $date, string $years) : string
{
return $this->getDateArithmeticIntervalExpression($date, '+', $years, DateIntervalUnit::YEAR);
}
/**
* Returns the SQL to subtract the number of given years from a date.
*
* @param string $date SQL expression producing the date.
* @param string $years SQL expression producing the number of years.
*
* @throws DBALException If not supported on this platform.
*/
public function getDateSubYearsExpression(string $date, string $years) : string
{
return $this->getDateArithmeticIntervalExpression($date, '-', $years, DateIntervalUnit::YEAR);
}
/**
* Returns the SQL for a date arithmetic expression.
*
* @param string $date SQL expression representing a date to perform the arithmetic operation on.
* @param string $operator The arithmetic operator (+ or -).
* @param string $interval SQL expression representing the value of the interval that shall be calculated
* into the date.
* @param string $unit The unit of the interval that shall be calculated into the date.
* One of the DATE_INTERVAL_UNIT_* constants.
*
* @throws DBALException If not supported on this platform.
*/
protected function getDateArithmeticIntervalExpression(string $date, string $operator, string $interval, string $unit) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Generates the SQL expression which represents the given date interval multiplied by a number
*
* @param string $interval SQL expression describing the interval value
* @param int $multiplier Interval multiplier
*
* @throws DBALException
*/
protected function multiplyInterval(string $interval, int $multiplier) : string
{
return sprintf('(%s * %d)', $interval, $multiplier);
}
/**
* Returns the SQL bit AND comparison expression.
*
* @param string $value1 SQL expression producing the first value.
* @param string $value2 SQL expression producing the second value.
*/
public function getBitAndComparisonExpression(string $value1, string $value2) : string
{
return '(' . $value1 . ' & ' . $value2 . ')';
}
/**
* Returns the SQL bit OR comparison expression.
*
* @param string $value1 SQL expression producing the first value.
* @param string $value2 SQL expression producing the second value.
*/
public function getBitOrComparisonExpression(string $value1, string $value2) : string
{
return '(' . $value1 . ' | ' . $value2 . ')';
}
/**
* Returns the FOR UPDATE expression.
*/
public function getForUpdateSQL() : string
{
return 'FOR UPDATE';
}
/**
* Honors that some SQL vendors such as MsSql use table hints for locking instead of the ANSI SQL FOR UPDATE specification.
*
* @param string $fromClause The FROM clause to append the hint for the given lock mode to.
* @param int|null $lockMode One of the Doctrine\DBAL\LockMode::* constants. If null is given, nothing will
* be appended to the FROM clause.
*/
public function appendLockHint(string $fromClause, ?int $lockMode) : string
{
return $fromClause;
}
/**
* Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.
*
* This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database
* vendors allow to lighten this constraint up to be a real read lock.
*/
public function getReadLockSQL() : string
{
return $this->getForUpdateSQL();
}
/**
* Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.
*
* The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard.
*/
public function getWriteLockSQL() : string
{
return $this->getForUpdateSQL();
}
/**
* Returns the SQL snippet to drop an existing database.
*
* @param string $database The name of the database that should be dropped.
*/
public function getDropDatabaseSQL(string $database) : string
{
return 'DROP DATABASE ' . $database;
}
/**
* Returns the SQL snippet to drop an existing table.
*
* @param Table|string $table
*
* @throws InvalidArgumentException
*/
public function getDropTableSQL($table) : string
{
$tableArg = $table;
if ($table instanceof Table) {
$table = $table->getQuotedName($this);
}
if (! is_string($table)) {
throw new InvalidArgumentException('getDropTableSQL() expects $table parameter to be string or \Doctrine\DBAL\Schema\Table.');
}
if ($this->_eventManager !== null && $this->_eventManager->hasListeners(Events::onSchemaDropTable)) {
$eventArgs = new SchemaDropTableEventArgs($tableArg, $this);
$this->_eventManager->dispatchEvent(Events::onSchemaDropTable, $eventArgs);
if ($eventArgs->isDefaultPrevented()) {
$sql = $eventArgs->getSql();
if ($sql === null) {
throw new UnexpectedValueException('Default implementation of DROP TABLE was overridden with NULL.');
}
return $sql;
}
}
return 'DROP TABLE ' . $table;
}
/**
* Returns the SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.
*
* @param Table|string $table
*/
public function getDropTemporaryTableSQL($table) : string
{
return $this->getDropTableSQL($table);
}
/**
* Returns the SQL to drop an index from a table.
*
* @param Index|string $index
* @param Table|string $table
*
* @throws InvalidArgumentException
*/
public function getDropIndexSQL($index, $table = null) : string
{
if ($index instanceof Index) {
$index = $index->getQuotedName($this);
} elseif (! is_string($index)) {
throw new InvalidArgumentException('AbstractPlatform::getDropIndexSQL() expects $index parameter to be string or \Doctrine\DBAL\Schema\Index.');
}
return 'DROP INDEX ' . $index;
}
/**
* Returns the SQL to drop a constraint.
*
* @param Constraint|string $constraint
* @param Table|string $table
*/
public function getDropConstraintSQL($constraint, $table) : string
{
if (! $constraint instanceof Constraint) {
$constraint = new Identifier($constraint);
}
if (! $table instanceof Table) {
$table = new Identifier($table);
}
$constraint = $constraint->getQuotedName($this);
$table = $table->getQuotedName($this);
return 'ALTER TABLE ' . $table . ' DROP CONSTRAINT ' . $constraint;
}
/**
* Returns the SQL to drop a foreign key.
*
* @param ForeignKeyConstraint|string $foreignKey
* @param Table|string $table
*/
public function getDropForeignKeySQL($foreignKey, $table) : string
{
if (! $foreignKey instanceof ForeignKeyConstraint) {
$foreignKey = new Identifier($foreignKey);
}
if (! $table instanceof Table) {
$table = new Identifier($table);
}
$foreignKey = $foreignKey->getQuotedName($this);
$table = $table->getQuotedName($this);
return 'ALTER TABLE ' . $table . ' DROP FOREIGN KEY ' . $foreignKey;
}
/**
* Returns the SQL statement(s) to create a table with the specified name, columns and constraints
* on this platform.
*
* @return array<int, string> The sequence of SQL statements.
*
* @throws DBALException
*/
public function getCreateTableSQL(Table $table, int $createFlags = self::CREATE_INDEXES) : array
{
if (count($table->getColumns()) === 0) {
throw NoColumnsSpecifiedForTable::new($table->getName());
}
$tableName = $table->getQuotedName($this);
$options = $table->getOptions();
$options['uniqueConstraints'] = [];
$options['indexes'] = [];
$options['primary'] = [];
if (($createFlags & self::CREATE_INDEXES) > 0) {
foreach ($table->getIndexes() as $index) {
/** @var $index Index */
if (! $index->isPrimary()) {
$options['indexes'][$index->getQuotedName($this)] = $index;
continue;
}
$options['primary'] = $index->getQuotedColumns($this);
$options['primary_index'] = $index;
}
foreach ($table->getUniqueConstraints() as $uniqueConstraint) {
/** @var UniqueConstraint $uniqueConstraint */
$options['uniqueConstraints'][$uniqueConstraint->getQuotedName($this)] = $uniqueConstraint;
}
}
if (($createFlags & self::CREATE_FOREIGNKEYS) > 0) {
$options['foreignKeys'] = [];
foreach ($table->getForeignKeys() as $fkConstraint) {
$options['foreignKeys'][] = $fkConstraint;
}
}
$columnSql = [];
$columns = [];
foreach ($table->getColumns() as $column) {
if ($this->_eventManager !== null && $this->_eventManager->hasListeners(Events::onSchemaCreateTableColumn)) {
$eventArgs = new SchemaCreateTableColumnEventArgs($column, $table, $this);
$this->_eventManager->dispatchEvent(Events::onSchemaCreateTableColumn, $eventArgs);
$columnSql = array_merge($columnSql, $eventArgs->getSql());
if ($eventArgs->isDefaultPrevented()) {
continue;
}
}
$columnData = $column->toArray();
$columnData['name'] = $column->getQuotedName($this);
$columnData['version'] = $column->hasPlatformOption('version') ? $column->getPlatformOption('version') : false;
$columnData['comment'] = $this->getColumnComment($column);
if ($columnData['type'] instanceof Types\StringType && $columnData['length'] === null) {
$columnData['length'] = 255;
}
if (in_array($column->getName(), $options['primary'])) {
$columnData['primary'] = true;
}
$columnName = $columnData['name'];
assert(is_string($columnName));
$columns[$columnName] = $columnData;
}
if ($this->_eventManager !== null && $this->_eventManager->hasListeners(Events::onSchemaCreateTable)) {
$eventArgs = new SchemaCreateTableEventArgs($table, $columns, $options, $this);
$this->_eventManager->dispatchEvent(Events::onSchemaCreateTable, $eventArgs);
if ($eventArgs->isDefaultPrevented()) {
return array_merge($eventArgs->getSql(), $columnSql);
}
}
$sql = $this->_getCreateTableSQL($tableName, $columns, $options);
if ($this->supportsCommentOnStatement()) {
if ($table->hasOption('comment')) {
$sql[] = $this->getCommentOnTableSQL($tableName, $table->getOption('comment'));
}
foreach ($table->getColumns() as $column) {
$comment = $this->getColumnComment($column);
if ($comment === null || $comment === '') {
continue;
}
$sql[] = $this->getCommentOnColumnSQL($tableName, $column->getQuotedName($this), $comment);
}
}
return array_merge($sql, $columnSql);
}
protected function getCommentOnTableSQL(string $tableName, ?string $comment) : string
{
$tableName = new Identifier($tableName);
return sprintf(
'COMMENT ON TABLE %s IS %s',
$tableName->getQuotedName($this),
$this->quoteStringLiteral((string) $comment)
);
}
public function getCommentOnColumnSQL(string $tableName, string $columnName, ?string $comment) : string
{
$tableName = new Identifier($tableName);
$columnName = new Identifier($columnName);
return sprintf(
'COMMENT ON COLUMN %s.%s IS %s',
$tableName->getQuotedName($this),
$columnName->getQuotedName($this),
$this->quoteStringLiteral((string) $comment)
);
}
/**
* Returns the SQL to create inline comment on a column.
*
* @throws DBALException If not supported on this platform.
*/
public function getInlineColumnCommentSQL(?string $comment) : string
{
if (! $this->supportsInlineColumnComments()) {
throw NotSupported::new(__METHOD__);
}
return 'COMMENT ' . $this->quoteStringLiteral((string) $comment);
}
/**
* Returns the SQL used to create a table.
*
* @param mixed[][] $columns
* @param mixed[] $options
*
* @return array<int, string>
*/
protected function _getCreateTableSQL(string $tableName, array $columns, array $options = []) : array
{
$columnListSql = $this->getColumnDeclarationListSQL($columns);
if (isset($options['uniqueConstraints']) && ! empty($options['uniqueConstraints'])) {
foreach ($options['uniqueConstraints'] as $name => $definition) {
$columnListSql .= ', ' . $this->getUniqueConstraintDeclarationSQL($name, $definition);
}
}
if (isset($options['primary']) && ! empty($options['primary'])) {
$columnListSql .= ', PRIMARY KEY(' . implode(', ', array_unique(array_values($options['primary']))) . ')';
}
if (isset($options['indexes']) && ! empty($options['indexes'])) {
foreach ($options['indexes'] as $index => $definition) {
$columnListSql .= ', ' . $this->getIndexDeclarationSQL($index, $definition);
}
}
$query = 'CREATE TABLE ' . $tableName . ' (' . $columnListSql;
$check = $this->getCheckDeclarationSQL($columns);
if (! empty($check)) {
$query .= ', ' . $check;
}
$query .= ')';
$sql = [$query];
if (isset($options['foreignKeys'])) {
foreach ((array) $options['foreignKeys'] as $definition) {
$sql[] = $this->getCreateForeignKeySQL($definition, $tableName);
}
}
return $sql;
}
public function getCreateTemporaryTableSnippetSQL() : string
{
return 'CREATE TEMPORARY TABLE';
}
/**
* Returns the SQL to create a sequence on this platform.
*
* @throws DBALException If not supported on this platform.
*/
public function getCreateSequenceSQL(Sequence $sequence) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Returns the SQL to change a sequence on this platform.
*
* @throws DBALException If not supported on this platform.
*/
public function getAlterSequenceSQL(Sequence $sequence) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Returns the SQL to create a constraint on a table on this platform.
*
* @param Table|string $table
*
* @throws InvalidArgumentException
*/
public function getCreateConstraintSQL(Constraint $constraint, $table) : string
{
if ($table instanceof Table) {
$table = $table->getQuotedName($this);
}
$query = 'ALTER TABLE ' . $table . ' ADD CONSTRAINT ' . $constraint->getQuotedName($this);
$columnList = '(' . implode(', ', $constraint->getQuotedColumns($this)) . ')';
$referencesClause = '';
if ($constraint instanceof Index) {
if ($constraint->isPrimary()) {
$query .= ' PRIMARY KEY';
} elseif ($constraint->isUnique()) {
$query .= ' UNIQUE';
} else {
throw new InvalidArgumentException(
'Can only create primary or unique constraints, no common indexes with getCreateConstraintSQL().'
);
}
} elseif ($constraint instanceof ForeignKeyConstraint) {
$query .= ' FOREIGN KEY';
$referencesClause = ' REFERENCES ' . $constraint->getQuotedForeignTableName($this) .
' (' . implode(', ', $constraint->getQuotedForeignColumns($this)) . ')';
}
$query .= ' ' . $columnList . $referencesClause;
return $query;
}
/**
* Returns the SQL to create an index on a table on this platform.
*
* @param Table|string $table The name of the table on which the index is to be created.
*
* @throws InvalidArgumentException
*/
public function getCreateIndexSQL(Index $index, $table) : string
{
if ($table instanceof Table) {
$table = $table->getQuotedName($this);
}
$name = $index->getQuotedName($this);
$columns = $index->getColumns();
if (count($columns) === 0) {
throw new InvalidArgumentException('Incomplete definition. "columns" required.');
}
if ($index->isPrimary()) {
return $this->getCreatePrimaryKeySQL($index, $table);
}
$query = 'CREATE ' . $this->getCreateIndexSQLFlags($index) . 'INDEX ' . $name . ' ON ' . $table;
$query .= ' (' . $this->getIndexFieldDeclarationListSQL($index) . ')' . $this->getPartialIndexSQL($index);
return $query;
}
/**
* Adds condition for partial index.
*/
protected function getPartialIndexSQL(Index $index) : string
{
if ($this->supportsPartialIndexes() && $index->hasOption('where')) {
return ' WHERE ' . $index->getOption('where');
}
return '';
}
/**
* Adds additional flags for index generation.
*/
protected function getCreateIndexSQLFlags(Index $index) : string
{
return $index->isUnique() ? 'UNIQUE ' : '';
}
/**
* Returns the SQL to create an unnamed primary key constraint.
*
* @param Table|string $table
*/
public function getCreatePrimaryKeySQL(Index $index, $table) : string
{
if ($table instanceof Table) {
$table = $table->getQuotedName($this);
}
return 'ALTER TABLE ' . $table . ' ADD PRIMARY KEY (' . $this->getIndexFieldDeclarationListSQL($index) . ')';
}
/**
* Returns the SQL to create a named schema.
*
* @throws DBALException If not supported on this platform.
*/
public function getCreateSchemaSQL(string $schemaName) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Quotes a string so that it can be safely used as a table or column name,
* even if it is a reserved word of the platform. This also detects identifier
* chains separated by dot and quotes them independently.
*
* NOTE: Just because you CAN use quoted identifiers doesn't mean
* you SHOULD use them. In general, they end up causing way more
* problems than they solve.
*
* @param string $identifier The identifier name to be quoted.
*
* @return string The quoted identifier string.
*/
public function quoteIdentifier(string $identifier) : string
{
if (strpos($identifier, '.') !== false) {
$parts = array_map([$this, 'quoteSingleIdentifier'], explode('.', $identifier));
return implode('.', $parts);
}
return $this->quoteSingleIdentifier($identifier);
}
/**
* Quotes a single identifier (no dot chain separation).
*
* @param string $str The identifier name to be quoted.
*
* @return string The quoted identifier string.
*/
public function quoteSingleIdentifier(string $str) : string
{
$c = $this->getIdentifierQuoteCharacter();
return $c . str_replace($c, $c . $c, $str) . $c;
}
/**
* Returns the SQL to create a new foreign key.
*
* @param ForeignKeyConstraint $foreignKey The foreign key constraint.
* @param Table|string $table The name of the table on which the foreign key is to be created.
*/
public function getCreateForeignKeySQL(ForeignKeyConstraint $foreignKey, $table) : string
{
if ($table instanceof Table) {
$table = $table->getQuotedName($this);
}
return 'ALTER TABLE ' . $table . ' ADD ' . $this->getForeignKeyDeclarationSQL($foreignKey);
}
/**
* Gets the SQL statements for altering an existing table.
*
* This method returns an array of SQL statements, since some platforms need several statements.
*
* @return array<int, string>
*
* @throws DBALException If not supported on this platform.
*/
public function getAlterTableSQL(TableDiff $diff) : array
{
throw NotSupported::new(__METHOD__);
}
/**
* @param mixed[] $columnSql
*/
protected function onSchemaAlterTableAddColumn(Column $column, TableDiff $diff, array &$columnSql) : bool
{
if ($this->_eventManager === null) {
return false;
}
if (! $this->_eventManager->hasListeners(Events::onSchemaAlterTableAddColumn)) {
return false;
}
$eventArgs = new SchemaAlterTableAddColumnEventArgs($column, $diff, $this);
$this->_eventManager->dispatchEvent(Events::onSchemaAlterTableAddColumn, $eventArgs);
$columnSql = array_merge($columnSql, $eventArgs->getSql());
return $eventArgs->isDefaultPrevented();
}
/**
* @param string[] $columnSql
*/
protected function onSchemaAlterTableRemoveColumn(Column $column, TableDiff $diff, array &$columnSql) : bool
{
if ($this->_eventManager === null) {
return false;
}
if (! $this->_eventManager->hasListeners(Events::onSchemaAlterTableRemoveColumn)) {
return false;
}
$eventArgs = new SchemaAlterTableRemoveColumnEventArgs($column, $diff, $this);
$this->_eventManager->dispatchEvent(Events::onSchemaAlterTableRemoveColumn, $eventArgs);
$columnSql = array_merge($columnSql, $eventArgs->getSql());
return $eventArgs->isDefaultPrevented();
}
/**
* @param string[] $columnSql
*/
protected function onSchemaAlterTableChangeColumn(ColumnDiff $columnDiff, TableDiff $diff, array &$columnSql) : bool
{
if ($this->_eventManager === null) {
return false;
}
if (! $this->_eventManager->hasListeners(Events::onSchemaAlterTableChangeColumn)) {
return false;
}
$eventArgs = new SchemaAlterTableChangeColumnEventArgs($columnDiff, $diff, $this);
$this->_eventManager->dispatchEvent(Events::onSchemaAlterTableChangeColumn, $eventArgs);
$columnSql = array_merge($columnSql, $eventArgs->getSql());
return $eventArgs->isDefaultPrevented();
}
/**
* @param string[] $columnSql
*/
protected function onSchemaAlterTableRenameColumn(string $oldColumnName, Column $column, TableDiff $diff, array &$columnSql) : bool
{
if ($this->_eventManager === null) {
return false;
}
if (! $this->_eventManager->hasListeners(Events::onSchemaAlterTableRenameColumn)) {
return false;
}
$eventArgs = new SchemaAlterTableRenameColumnEventArgs($oldColumnName, $column, $diff, $this);
$this->_eventManager->dispatchEvent(Events::onSchemaAlterTableRenameColumn, $eventArgs);
$columnSql = array_merge($columnSql, $eventArgs->getSql());
return $eventArgs->isDefaultPrevented();
}
/**
* @param string[] $sql
*/
protected function onSchemaAlterTable(TableDiff $diff, array &$sql) : bool
{
if ($this->_eventManager === null) {
return false;
}
if (! $this->_eventManager->hasListeners(Events::onSchemaAlterTable)) {
return false;
}
$eventArgs = new SchemaAlterTableEventArgs($diff, $this);
$this->_eventManager->dispatchEvent(Events::onSchemaAlterTable, $eventArgs);
$sql = array_merge($sql, $eventArgs->getSql());
return $eventArgs->isDefaultPrevented();
}
/**
* @return string[]
*/
protected function getPreAlterTableIndexForeignKeySQL(TableDiff $diff) : array
{
$tableName = $diff->getName($this)->getQuotedName($this);
$sql = [];
if ($this->supportsForeignKeyConstraints()) {
foreach ($diff->removedForeignKeys as $foreignKey) {
$sql[] = $this->getDropForeignKeySQL($foreignKey, $tableName);
}
foreach ($diff->changedForeignKeys as $foreignKey) {
$sql[] = $this->getDropForeignKeySQL($foreignKey, $tableName);
}
}
foreach ($diff->removedIndexes as $index) {
$sql[] = $this->getDropIndexSQL($index, $tableName);
}
foreach ($diff->changedIndexes as $index) {
$sql[] = $this->getDropIndexSQL($index, $tableName);
}
return $sql;
}
/**
* @return string[]
*/
protected function getPostAlterTableIndexForeignKeySQL(TableDiff $diff) : array
{
$sql = [];
$newName = $diff->getNewName();
if ($newName !== null) {
$tableName = $newName->getQuotedName($this);
} else {
$tableName = $diff->getName($this)->getQuotedName($this);
}
if ($this->supportsForeignKeyConstraints()) {
foreach ($diff->addedForeignKeys as $foreignKey) {
$sql[] = $this->getCreateForeignKeySQL($foreignKey, $tableName);
}
foreach ($diff->changedForeignKeys as $foreignKey) {
$sql[] = $this->getCreateForeignKeySQL($foreignKey, $tableName);
}
}
foreach ($diff->addedIndexes as $index) {
$sql[] = $this->getCreateIndexSQL($index, $tableName);
}
foreach ($diff->changedIndexes as $index) {
$sql[] = $this->getCreateIndexSQL($index, $tableName);
}
foreach ($diff->renamedIndexes as $oldIndexName => $index) {
$oldIndexName = new Identifier($oldIndexName);
$sql = array_merge(
$sql,
$this->getRenameIndexSQL($oldIndexName->getQuotedName($this), $index, $tableName)
);
}
return $sql;
}
/**
* Returns the SQL for renaming an index on a table.
*
* @param string $oldIndexName The name of the index to rename from.
* @param Index $index The definition of the index to rename to.
* @param string $tableName The table to rename the given index on.
*
* @return string[] The sequence of SQL statements for renaming the given index.
*/
protected function getRenameIndexSQL(string $oldIndexName, Index $index, string $tableName) : array
{
return [
$this->getDropIndexSQL($oldIndexName, $tableName),
$this->getCreateIndexSQL($index, $tableName),
];
}
/**
* Common code for alter table statement generation that updates the changed Index and Foreign Key definitions.
*
* @deprecated
*
* @return string[]
*/
protected function _getAlterTableIndexForeignKeySQL(TableDiff $diff) : array
{
return array_merge($this->getPreAlterTableIndexForeignKeySQL($diff), $this->getPostAlterTableIndexForeignKeySQL($diff));
}
/**
* Gets declaration of a number of fields in bulk.
*
* @param mixed[][] $fields A multidimensional associative array.
* The first dimension determines the field name, while the second
* dimension is keyed with the name of the properties
* of the field being declared as array indexes. Currently, the types
* of supported field properties are as follows:
*
* length
* Integer value that determines the maximum length of the text
* field. If this argument is missing the field should be
* declared to have the longest length allowed by the DBMS.
*
* default
* Text value to be used as default for this field.
*
* notnull
* Boolean flag that indicates whether this field is constrained
* to not be set to null.
* charset
* Text value with the default CHARACTER SET for this field.
* collation
* Text value with the default COLLATION for this field.
* unique
* unique constraint
*/
public function getColumnDeclarationListSQL(array $fields) : string
{
$queryFields = [];
foreach ($fields as $fieldName => $field) {
$queryFields[] = $this->getColumnDeclarationSQL($fieldName, $field);
}
return implode(', ', $queryFields);
}
/**
* Obtains DBMS specific SQL code portion needed to declare a generic type
* field to be used in statements like CREATE TABLE.
*
* @param string $name The name the field to be declared.
* @param mixed[] $field An associative array with the name of the properties
* of the field being declared as array indexes. Currently, the types
* of supported field properties are as follows:
*
* length
* Integer value that determines the maximum length of the text
* field. If this argument is missing the field should be
* declared to have the longest length allowed by the DBMS.
*
* default
* Text value to be used as default for this field.
*
* notnull
* Boolean flag that indicates whether this field is constrained
* to not be set to null.
* charset
* Text value with the default CHARACTER SET for this field.
* collation
* Text value with the default COLLATION for this field.
* unique
* unique constraint
* check
* column check constraint
* columnDefinition
* a string that defines the complete column
*
* @return string DBMS specific SQL code portion that should be used to declare the column.
*/
public function getColumnDeclarationSQL(string $name, array $field) : string
{
if (isset($field['columnDefinition'])) {
$columnDef = $this->getCustomTypeDeclarationSQL($field);
} else {
$default = $this->getDefaultValueDeclarationSQL($field);
$charset = isset($field['charset']) && $field['charset'] ?
' ' . $this->getColumnCharsetDeclarationSQL($field['charset']) : '';
$collation = isset($field['collation']) && $field['collation'] ?
' ' . $this->getColumnCollationDeclarationSQL($field['collation']) : '';
$notnull = isset($field['notnull']) && $field['notnull'] ? ' NOT NULL' : '';
$unique = isset($field['unique']) && $field['unique'] ?
' ' . $this->getUniqueFieldDeclarationSQL() : '';
$check = isset($field['check']) && $field['check'] ?
' ' . $field['check'] : '';
$typeDecl = $field['type']->getSQLDeclaration($field, $this);
$columnDef = $typeDecl . $charset . $default . $notnull . $unique . $check . $collation;
if ($this->supportsInlineColumnComments() && isset($field['comment']) && $field['comment'] !== '') {
$columnDef .= ' ' . $this->getInlineColumnCommentSQL($field['comment']);
}
}
return $name . ' ' . $columnDef;
}
/**
* Returns the SQL snippet that declares a floating point column of arbitrary precision.
*
* @param mixed[] $columnDef
*/
public function getDecimalTypeDeclarationSQL(array $columnDef) : string
{
$columnDef['precision'] = ! isset($columnDef['precision']) || empty($columnDef['precision'])
? 10 : $columnDef['precision'];
$columnDef['scale'] = ! isset($columnDef['scale']) || empty($columnDef['scale'])
? 0 : $columnDef['scale'];
return 'NUMERIC(' . $columnDef['precision'] . ', ' . $columnDef['scale'] . ')';
}
/**
* Obtains DBMS specific SQL code portion needed to set a default value
* declaration to be used in statements like CREATE TABLE.
*
* @param mixed[] $field The field definition array.
*
* @return string DBMS specific SQL code portion needed to set a default value.
*/
public function getDefaultValueDeclarationSQL(array $field) : string
{
if (! isset($field['default'])) {
return empty($field['notnull']) ? ' DEFAULT NULL' : '';
}
$default = $field['default'];
if (! isset($field['type'])) {
return " DEFAULT '" . $default . "'";
}
$type = $field['type'];
if ($type instanceof Types\PhpIntegerMappingType) {
return ' DEFAULT ' . $default;
}
if ($type instanceof Types\PhpDateTimeMappingType && $default === $this->getCurrentTimestampSQL()) {
return ' DEFAULT ' . $this->getCurrentTimestampSQL();
}
if ($type instanceof Types\TimeType && $default === $this->getCurrentTimeSQL()) {
return ' DEFAULT ' . $this->getCurrentTimeSQL();
}
if ($type instanceof Types\DateType && $default === $this->getCurrentDateSQL()) {
return ' DEFAULT ' . $this->getCurrentDateSQL();
}
if ($type instanceof Types\BooleanType) {
return " DEFAULT '" . $this->convertBooleans($default) . "'";
}
if (is_int($default) || is_float($default)) {
return ' DEFAULT ' . $default;
}
return ' DEFAULT ' . $this->quoteStringLiteral($default);
}
/**
* Obtains DBMS specific SQL code portion needed to set a CHECK constraint
* declaration to be used in statements like CREATE TABLE.
*
* @param string[]|mixed[][] $definition The check definition.
*
* @return string DBMS specific SQL code portion needed to set a CHECK constraint.
*/
public function getCheckDeclarationSQL(array $definition) : string
{
$constraints = [];
foreach ($definition as $field => $def) {
if (is_string($def)) {
$constraints[] = 'CHECK (' . $def . ')';
} else {
if (isset($def['min'])) {
$constraints[] = 'CHECK (' . $field . ' >= ' . $def['min'] . ')';
}
if (! isset($def['max'])) {
continue;
}
$constraints[] = 'CHECK (' . $field . ' <= ' . $def['max'] . ')';
}
}
return implode(', ', $constraints);
}
/**
* Obtains DBMS specific SQL code portion needed to set a unique
* constraint declaration to be used in statements like CREATE TABLE.
*
* @param string $name The name of the unique constraint.
* @param UniqueConstraint $constraint The unique constraint definition.
*
* @return string DBMS specific SQL code portion needed to set a constraint.
*
* @throws InvalidArgumentException
*/
public function getUniqueConstraintDeclarationSQL(string $name, UniqueConstraint $constraint) : string
{
$columns = $constraint->getColumns();
if (count($columns) === 0) {
throw new InvalidArgumentException('Incomplete definition. "columns" required.');
}
$chunks = ['CONSTRAINT'];
if ($name !== '') {
$chunks[] = (new Identifier($name))->getQuotedName($this);
}
$chunks[] = 'UNIQUE';
if ($constraint->hasFlag('clustered')) {
$chunks[] = 'CLUSTERED';
}
$chunks[] = sprintf('(%s)', $this->getIndexFieldDeclarationListSQL($columns));
return implode(' ', $chunks);
}
/**
* Obtains DBMS specific SQL code portion needed to set an index
* declaration to be used in statements like CREATE TABLE.
*
* @param string $name The name of the index.
* @param Index $index The index definition.
*
* @return string DBMS specific SQL code portion needed to set an index.
*
* @throws InvalidArgumentException
*/
public function getIndexDeclarationSQL(string $name, Index $index) : string
{
$columns = $index->getColumns();
$name = new Identifier($name);
if (count($columns) === 0) {
throw new InvalidArgumentException('Incomplete definition. "columns" required.');
}
return $this->getCreateIndexSQLFlags($index) . 'INDEX ' . $name->getQuotedName($this) . ' ('
. $this->getIndexFieldDeclarationListSQL($index)
. ')' . $this->getPartialIndexSQL($index);
}
/**
* Obtains SQL code portion needed to create a custom column,
* e.g. when a field has the "columnDefinition" keyword.
* Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.
*
* @param mixed[] $columnDef
*/
public function getCustomTypeDeclarationSQL(array $columnDef) : string
{
return $columnDef['columnDefinition'];
}
/**
* Obtains DBMS specific SQL code portion needed to set an index
* declaration to be used in statements like CREATE TABLE.
*
* @param mixed[]|Index $columnsOrIndex array declaration is deprecated, prefer passing Index to this method
*/
public function getIndexFieldDeclarationListSQL($columnsOrIndex) : string
{
if ($columnsOrIndex instanceof Index) {
return implode(', ', $columnsOrIndex->getQuotedColumns($this));
}
if (! is_array($columnsOrIndex)) {
throw new InvalidArgumentException('Fields argument should be an Index or array.');
}
$ret = [];
foreach ($columnsOrIndex as $column => $definition) {
if (is_array($definition)) {
$ret[] = $column;
} else {
$ret[] = $definition;
}
}
return implode(', ', $ret);
}
/**
* Returns the required SQL string that fits between CREATE ... TABLE
* to create the table as a temporary table.
*
* Should be overridden in driver classes to return the correct string for the
* specific database type.
*
* The default is to return the string "TEMPORARY" - this will result in a
* SQL error for any database that does not support temporary tables, or that
* requires a different SQL command from "CREATE TEMPORARY TABLE".
*
* @return string The string required to be placed between "CREATE" and "TABLE"
* to generate a temporary table, if possible.
*/
public function getTemporaryTableSQL() : string
{
return 'TEMPORARY';
}
/**
* Some vendors require temporary table names to be qualified specially.
*/
public function getTemporaryTableName(string $tableName) : string
{
return $tableName;
}
/**
* Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
* of a field declaration to be used in statements like CREATE TABLE.
*
* @return string DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
* of a field declaration.
*/
public function getForeignKeyDeclarationSQL(ForeignKeyConstraint $foreignKey) : string
{
$sql = $this->getForeignKeyBaseDeclarationSQL($foreignKey);
$sql .= $this->getAdvancedForeignKeyOptionsSQL($foreignKey);
return $sql;
}
/**
* Returns the FOREIGN KEY query section dealing with non-standard options
* as MATCH, INITIALLY DEFERRED, ON UPDATE, ...
*
* @param ForeignKeyConstraint $foreignKey The foreign key definition.
*/
public function getAdvancedForeignKeyOptionsSQL(ForeignKeyConstraint $foreignKey) : string
{
$query = '';
if ($this->supportsForeignKeyOnUpdate() && $foreignKey->hasOption('onUpdate')) {
$query .= ' ON UPDATE ' . $this->getForeignKeyReferentialActionSQL($foreignKey->getOption('onUpdate'));
}
if ($foreignKey->hasOption('onDelete')) {
$query .= ' ON DELETE ' . $this->getForeignKeyReferentialActionSQL($foreignKey->getOption('onDelete'));
}
return $query;
}
/**
* Returns the given referential action in uppercase if valid, otherwise throws an exception.
*
* @param string $action The foreign key referential action.
*
* @throws InvalidArgumentException If unknown referential action given.
*/
public function getForeignKeyReferentialActionSQL(string $action) : string
{
$upper = strtoupper($action);
switch ($upper) {
case 'CASCADE':
case 'SET NULL':
case 'NO ACTION':
case 'RESTRICT':
case 'SET DEFAULT':
return $upper;
default:
throw new InvalidArgumentException(sprintf('Invalid foreign key action "%s".', $upper));
}
}
/**
* Obtains DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
* of a field declaration to be used in statements like CREATE TABLE.
*
* @throws InvalidArgumentException
*/
public function getForeignKeyBaseDeclarationSQL(ForeignKeyConstraint $foreignKey) : string
{
$sql = '';
if ($foreignKey->getName() !== '') {
$sql .= 'CONSTRAINT ' . $foreignKey->getQuotedName($this) . ' ';
}
$sql .= 'FOREIGN KEY (';
if (count($foreignKey->getLocalColumns()) === 0) {
throw new InvalidArgumentException('Incomplete definition. "local" required.');
}
if (count($foreignKey->getForeignColumns()) === 0) {
throw new InvalidArgumentException('Incomplete definition. "foreign" required.');
}
if (strlen($foreignKey->getForeignTableName()) === 0) {
throw new InvalidArgumentException('Incomplete definition. "foreignTable" required.');
}
return $sql . implode(', ', $foreignKey->getQuotedLocalColumns($this))
. ') REFERENCES '
. $foreignKey->getQuotedForeignTableName($this) . ' ('
. implode(', ', $foreignKey->getQuotedForeignColumns($this)) . ')';
}
/**
* Obtains DBMS specific SQL code portion needed to set the UNIQUE constraint
* of a field declaration to be used in statements like CREATE TABLE.
*
* @return string DBMS specific SQL code portion needed to set the UNIQUE constraint
* of a field declaration.
*/
public function getUniqueFieldDeclarationSQL() : string
{
return 'UNIQUE';
}
/**
* Obtains DBMS specific SQL code portion needed to set the CHARACTER SET
* of a field declaration to be used in statements like CREATE TABLE.
*
* @param string $charset The name of the charset.
*
* @return string DBMS specific SQL code portion needed to set the CHARACTER SET
* of a field declaration.
*/
public function getColumnCharsetDeclarationSQL(string $charset) : string
{
return '';
}
/**
* Obtains DBMS specific SQL code portion needed to set the COLLATION
* of a field declaration to be used in statements like CREATE TABLE.
*
* @param string $collation The name of the collation.
*
* @return string DBMS specific SQL code portion needed to set the COLLATION
* of a field declaration.
*/
public function getColumnCollationDeclarationSQL(string $collation) : string
{
return $this->supportsColumnCollation() ? 'COLLATE ' . $collation : '';
}
/**
* Whether the platform prefers sequences for ID generation.
* Subclasses should override this method to return TRUE if they prefer sequences.
*/
public function prefersSequences() : bool
{
return false;
}
/**
* Whether the platform prefers identity columns (eg. autoincrement) for ID generation.
* Subclasses should override this method to return TRUE if they prefer identity columns.
*/
public function prefersIdentityColumns() : bool
{
return false;
}
/**
* Some platforms need the boolean values to be converted.
*
* The default conversion in this implementation converts to integers (false => 0, true => 1).
*
* Note: if the input is not a boolean the original input might be returned.
*
* There are two contexts when converting booleans: Literals and Prepared Statements.
* This method should handle the literal case
*
* @param mixed $item A boolean or an array of them.
*
* @return mixed A boolean database value or an array of them.
*/
public function convertBooleans($item)
{
if (is_array($item)) {
foreach ($item as $k => $value) {
if (! is_bool($value)) {
continue;
}
$item[$k] = (int) $value;
}
} elseif (is_bool($item)) {
$item = (int) $item;
}
return $item;
}
/**
* Some platforms have boolean literals that needs to be correctly converted
*
* The default conversion tries to convert value into bool "(bool)$item"
*
* @param mixed $item
*/
public function convertFromBoolean($item) : ?bool
{
if ($item === null) {
return null;
}
return (bool) $item;
}
/**
* This method should handle the prepared statements case. When there is no
* distinction, it's OK to use the same method.
*
* Note: if the input is not a boolean the original input might be returned.
*
* @param mixed $item A boolean or an array of them.
*
* @return mixed A boolean database value or an array of them.
*/
public function convertBooleansToDatabaseValue($item)
{
return $this->convertBooleans($item);
}
/**
* Returns the SQL specific for the platform to get the current date.
*/
public function getCurrentDateSQL() : string
{
return 'CURRENT_DATE';
}
/**
* Returns the SQL specific for the platform to get the current time.
*/
public function getCurrentTimeSQL() : string
{
return 'CURRENT_TIME';
}
/**
* Returns the SQL specific for the platform to get the current timestamp
*/
public function getCurrentTimestampSQL() : string
{
return 'CURRENT_TIMESTAMP';
}
/**
* Returns the SQL for a given transaction isolation level Connection constant.
*
* @throws InvalidArgumentException
*/
protected function _getTransactionIsolationLevelSQL(int $level) : string
{
switch ($level) {
case TransactionIsolationLevel::READ_UNCOMMITTED:
return 'READ UNCOMMITTED';
case TransactionIsolationLevel::READ_COMMITTED:
return 'READ COMMITTED';
case TransactionIsolationLevel::REPEATABLE_READ:
return 'REPEATABLE READ';
case TransactionIsolationLevel::SERIALIZABLE:
return 'SERIALIZABLE';
default:
throw new InvalidArgumentException(sprintf('Invalid isolation level "%s".', $level));
}
}
/**
* @throws DBALException If not supported on this platform.
*/
public function getListDatabasesSQL() : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Returns the SQL statement for retrieving the namespaces defined in the database.
*
* @throws DBALException If not supported on this platform.
*/
public function getListNamespacesSQL() : string
{
throw NotSupported::new(__METHOD__);
}
/**
* @throws DBALException If not supported on this platform.
*/
public function getListSequencesSQL(string $database) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* @throws DBALException If not supported on this platform.
*/
public function getListTableConstraintsSQL(string $table) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* @throws DBALException If not supported on this platform.
*/
public function getListTableColumnsSQL(string $table, ?string $database = null) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* @throws DBALException If not supported on this platform.
*/
public function getListTablesSQL() : string
{
throw NotSupported::new(__METHOD__);
}
/**
* @throws DBALException If not supported on this platform.
*/
public function getListUsersSQL() : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Returns the SQL to list all views of a database or user.
*
* @throws DBALException If not supported on this platform.
*/
public function getListViewsSQL(string $database) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Returns the list of indexes for the current database.
*
* The current database parameter is optional but will always be passed
* when using the SchemaManager API and is the database the given table is in.
*
* Attention: Some platforms only support currentDatabase when they
* are connected with that database. Cross-database information schema
* requests may be impossible.
*
* @throws DBALException If not supported on this platform.
*/
public function getListTableIndexesSQL(string $table, ?string $currentDatabase = null) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* @throws DBALException If not supported on this platform.
*/
public function getListTableForeignKeysSQL(string $table, ?string $database = null) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* @throws DBALException If not supported on this platform.
*/
public function getCreateViewSQL(string $name, string $sql) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* @throws DBALException If not supported on this platform.
*/
public function getDropViewSQL(string $name) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Returns the SQL snippet to drop an existing sequence.
*
* @param Sequence|string $sequence
*
* @throws DBALException If not supported on this platform.
*/
public function getDropSequenceSQL($sequence) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* @throws DBALException If not supported on this platform.
*/
public function getSequenceNextValSQL(string $sequenceName) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Returns the SQL to create a new database.
*
* @param string $database The name of the database that should be created.
*
* @throws DBALException If not supported on this platform.
*/
public function getCreateDatabaseSQL(string $database) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Returns the SQL to set the transaction isolation level.
*
* @throws DBALException If not supported on this platform.
*/
public function getSetTransactionIsolationSQL(int $level) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Obtains DBMS specific SQL to be used to create datetime fields in
* statements like CREATE TABLE.
*
* @param mixed[] $fieldDeclaration
*
* @throws DBALException If not supported on this platform.
*/
public function getDateTimeTypeDeclarationSQL(array $fieldDeclaration) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Obtains DBMS specific SQL to be used to create datetime with timezone offset fields.
*
* @param mixed[] $fieldDeclaration
*/
public function getDateTimeTzTypeDeclarationSQL(array $fieldDeclaration) : string
{
return $this->getDateTimeTypeDeclarationSQL($fieldDeclaration);
}
/**
* Obtains DBMS specific SQL to be used to create date fields in statements
* like CREATE TABLE.
*
* @param mixed[] $fieldDeclaration
*
* @throws DBALException If not supported on this platform.
*/
public function getDateTypeDeclarationSQL(array $fieldDeclaration) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Obtains DBMS specific SQL to be used to create time fields in statements
* like CREATE TABLE.
*
* @param mixed[] $fieldDeclaration
*
* @throws DBALException If not supported on this platform.
*/
public function getTimeTypeDeclarationSQL(array $fieldDeclaration) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* @param mixed[] $fieldDeclaration
*/
public function getFloatDeclarationSQL(array $fieldDeclaration) : string
{
return 'DOUBLE PRECISION';
}
/**
* Gets the default transaction isolation level of the platform.
*
* @see TransactionIsolationLevel
*
* @return int The default isolation level.
*/
public function getDefaultTransactionIsolationLevel() : int
{
return TransactionIsolationLevel::READ_COMMITTED;
}
/* supports*() methods */
/**
* Whether the platform supports sequences.
*/
public function supportsSequences() : bool
{
return false;
}
/**
* Whether the platform supports identity columns.
*
* Identity columns are columns that receive an auto-generated value from the
* database on insert of a row.
*/
public function supportsIdentityColumns() : bool
{
return false;
}
/**
* Whether the platform emulates identity columns through sequences.
*
* Some platforms that do not support identity columns natively
* but support sequences can emulate identity columns by using
* sequences.
*/
public function usesSequenceEmulatedIdentityColumns() : bool
{
return false;
}
/**
* Gets the sequence name prefix based on table information.
*/
public function getSequencePrefix(string $tableName, ?string $schemaName = null) : string
{
if (! $schemaName) {
return $tableName;
}
// Prepend the schema name to the table name if there is one
return ! $this->supportsSchemas() && $this->canEmulateSchemas()
? $schemaName . '__' . $tableName
: $schemaName . '.' . $tableName;
}
/**
* Returns the name of the sequence for a particular identity column in a particular table.
*
* @see usesSequenceEmulatedIdentityColumns
*
* @param string $tableName The name of the table to return the sequence name for.
* @param string $columnName The name of the identity column in the table to return the sequence name for.
*
* @throws DBALException If not supported on this platform.
*/
public function getIdentitySequenceName(string $tableName, string $columnName) : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Whether the platform supports indexes.
*/
public function supportsIndexes() : bool
{
return true;
}
/**
* Whether the platform supports partial indexes.
*/
public function supportsPartialIndexes() : bool
{
return false;
}
/**
* Whether the platform supports indexes with column length definitions.
*/
public function supportsColumnLengthIndexes() : bool
{
return false;
}
/**
* Whether the platform supports altering tables.
*/
public function supportsAlterTable() : bool
{
return true;
}
/**
* Whether the platform supports transactions.
*/
public function supportsTransactions() : bool
{
return true;
}
/**
* Whether the platform supports savepoints.
*/
public function supportsSavepoints() : bool
{
return true;
}
/**
* Whether the platform supports releasing savepoints.
*/
public function supportsReleaseSavepoints() : bool
{
return $this->supportsSavepoints();
}
/**
* Whether the platform supports primary key constraints.
*/
public function supportsPrimaryConstraints() : bool
{
return true;
}
/**
* Whether the platform supports foreign key constraints.
*/
public function supportsForeignKeyConstraints() : bool
{
return true;
}
/**
* Whether this platform supports onUpdate in foreign key constraints.
*/
public function supportsForeignKeyOnUpdate() : bool
{
return $this->supportsForeignKeyConstraints();
}
/**
* Whether the platform supports database schemas.
*/
public function supportsSchemas() : bool
{
return false;
}
/**
* Whether this platform can emulate schemas.
*
* Platforms that either support or emulate schemas don't automatically
* filter a schema for the namespaced elements in {@link
* AbstractManager#createSchema}.
*/
public function canEmulateSchemas() : bool
{
return false;
}
/**
* Returns the default schema name.
*
* @throws DBALException If not supported on this platform.
*/
public function getDefaultSchemaName() : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Whether this platform supports create database.
*
* Some databases don't allow to create and drop databases at all or only with certain tools.
*/
public function supportsCreateDropDatabase() : bool
{
return true;
}
/**
* Whether the platform supports getting the affected rows of a recent update/delete type query.
*/
public function supportsGettingAffectedRows() : bool
{
return true;
}
/**
* Whether this platform support to add inline column comments as postfix.
*/
public function supportsInlineColumnComments() : bool
{
return false;
}
/**
* Whether this platform support the proprietary syntax "COMMENT ON asset".
*/
public function supportsCommentOnStatement() : bool
{
return false;
}
/**
* Does this platform have native guid type.
*/
public function hasNativeGuidType() : bool
{
return false;
}
/**
* Does this platform have native JSON type.
*/
public function hasNativeJsonType() : bool
{
return false;
}
/**
* Whether this platform supports views.
*/
public function supportsViews() : bool
{
return true;
}
/**
* Does this platform support column collation?
*/
public function supportsColumnCollation() : bool
{
return false;
}
/**
* Gets the format string, as accepted by the date() function, that describes
* the format of a stored datetime value of this platform.
*
* @return string The format string.
*/
public function getDateTimeFormatString() : string
{
return 'Y-m-d H:i:s';
}
/**
* Gets the format string, as accepted by the date() function, that describes
* the format of a stored datetime with timezone value of this platform.
*
* @return string The format string.
*/
public function getDateTimeTzFormatString() : string
{
return 'Y-m-d H:i:s';
}
/**
* Gets the format string, as accepted by the date() function, that describes
* the format of a stored date value of this platform.
*
* @return string The format string.
*/
public function getDateFormatString() : string
{
return 'Y-m-d';
}
/**
* Gets the format string, as accepted by the date() function, that describes
* the format of a stored time value of this platform.
*
* @return string The format string.
*/
public function getTimeFormatString() : string
{
return 'H:i:s';
}
/**
* Adds an driver-specific LIMIT clause to the query.
*
* @throws DBALException
*/
final public function modifyLimitQuery(string $query, ?int $limit, int $offset = 0) : string
{
if ($offset < 0) {
throw new DBALException(sprintf(
'Offset must be a positive integer or zero, %d given.',
$offset
));
}
if ($offset > 0 && ! $this->supportsLimitOffset()) {
throw new DBALException(sprintf(
'Platform "%s" does not support offset values in limit queries.',
$this->getName()
));
}
return $this->doModifyLimitQuery($query, $limit, $offset);
}
/**
* Adds an platform-specific LIMIT clause to the query.
*/
protected function doModifyLimitQuery(string $query, ?int $limit, int $offset) : string
{
if ($limit !== null) {
$query .= sprintf(' LIMIT %d', $limit);
}
if ($offset > 0) {
$query .= sprintf(' OFFSET %d', $offset);
}
return $query;
}
/**
* Whether the database platform support offsets in modify limit clauses.
*/
public function supportsLimitOffset() : bool
{
return true;
}
/**
* Gets the character casing of a column in an SQL result set of this platform.
*
* @param string $column The column name for which to get the correct character casing.
*
* @return string The column name in the character casing used in SQL result sets.
*/
public function getSQLResultCasing(string $column) : string
{
return $column;
}
/**
* Makes any fixes to a name of a schema element (table, sequence, ...) that are required
* by restrictions of the platform, like a maximum length.
*/
public function fixSchemaElementName(string $schemaElementName) : string
{
return $schemaElementName;
}
/**
* Maximum length of any given database identifier, like tables or column names.
*/
public function getMaxIdentifierLength() : int
{
return 63;
}
/**
* Returns the insert SQL for an empty insert statement.
*/
public function getEmptyIdentityInsertSQL(string $tableName, string $identifierColumnName) : string
{
return 'INSERT INTO ' . $tableName . ' (' . $identifierColumnName . ') VALUES (null)';
}
/**
* Generates a Truncate Table SQL statement for a given table.
*
* Cascade is not supported on many platforms but would optionally cascade the truncate by
* following the foreign keys.
*/
public function getTruncateTableSQL(string $tableName, bool $cascade = false) : string
{
$tableIdentifier = new Identifier($tableName);
return 'TRUNCATE ' . $tableIdentifier->getQuotedName($this);
}
/**
* This is for test reasons, many vendors have special requirements for dummy statements.
*/
public function getDummySelectSQL(string $expression = '1') : string
{
return sprintf('SELECT %s', $expression);
}
/**
* Returns the SQL to create a new savepoint.
*/
public function createSavePoint(string $savepoint) : string
{
return 'SAVEPOINT ' . $savepoint;
}
/**
* Returns the SQL to release a savepoint.
*/
public function releaseSavePoint(string $savepoint) : string
{
return 'RELEASE SAVEPOINT ' . $savepoint;
}
/**
* Returns the SQL to rollback a savepoint.
*/
public function rollbackSavePoint(string $savepoint) : string
{
return 'ROLLBACK TO SAVEPOINT ' . $savepoint;
}
/**
* Returns the keyword list instance of this platform.
*
* @throws DBALException If no keyword list is specified.
*/
final public function getReservedKeywordsList() : KeywordList
{
// Check for an existing instantiation of the keywords class.
if ($this->_keywords) {
return $this->_keywords;
}
$class = $this->getReservedKeywordsClass();
$keywords = new $class();
if (! $keywords instanceof KeywordList) {
throw NotSupported::new(__METHOD__);
}
// Store the instance so it doesn't need to be generated on every request.
$this->_keywords = $keywords;
return $keywords;
}
/**
* Returns the class name of the reserved keywords list.
*
* @throws DBALException If not supported on this platform.
*/
protected function getReservedKeywordsClass() : string
{
throw NotSupported::new(__METHOD__);
}
/**
* Quotes a literal string.
* This method is NOT meant to fix SQL injections!
* It is only meant to escape this platform's string literal
* quote character inside the given literal string.
*
* @param string $str The literal string to be quoted.
*
* @return string The quoted literal string.
*/
public function quoteStringLiteral(string $str) : string
{
$c = $this->getStringLiteralQuoteCharacter();
return $c . str_replace($c, $c . $c, $str) . $c;
}
/**
* Gets the character used for string literal quoting.
*/
public function getStringLiteralQuoteCharacter() : string
{
return "'";
}
/**
* Escapes metacharacters in a string intended to be used with a LIKE
* operator.
*
* @param string $inputString a literal, unquoted string
* @param string $escapeChar should be reused by the caller in the LIKE
* expression.
*/
final public function escapeStringForLike(string $inputString, string $escapeChar) : string
{
return preg_replace(
'~([' . preg_quote($this->getLikeWildcardCharacters() . $escapeChar, '~') . '])~u',
addcslashes($escapeChar, '\\') . '$1',
$inputString
);
}
protected function getLikeWildcardCharacters() : string
{
return '%_';
}
}