Add support for native UUID column type (#1915)

* add support for native uuid types * test setupscript fixes * review changes * added uuid to reverse schema parser types * added reverse schema parser test * review changes * fix mysql setup script
propelorm · Nov 22, 2022 · b35fb89 · b35fb89
1 parent 12c23e1
commit b35fb89
Show file tree

Hide file tree

Showing 28 changed files with 363 additions and 54 deletions.
diff --git a/src/Propel/Generator/Model/Column.php b/src/Propel/Generator/Model/Column.php
@@ -1323,6 +1323,16 @@ public function isTemporalType(): bool
         return PropelTypes::isTemporalType($this->getType());
     }
 
+    /**
+     * Returns whether this column is a uuid type.
+     *
+     * @return bool
+     */
+    public function isUuidType(): bool
+    {
+        return PropelTypes::isUuidType($this->getType());
+    }
+
     /**
      * Returns whether the column is an array column.
      *

diff --git a/src/Propel/Generator/Model/PropelTypes.php b/src/Propel/Generator/Model/PropelTypes.php
@@ -341,6 +341,16 @@ class PropelTypes
      */
     public const JSON_TYPE = 'string';
 
+    /**
+     * @var string
+     */
+    public const UUID = 'UUID';
+
+    /**
+     * @var string
+     */
+    public const UUID_NATIVE_TYPE = 'string';
+
     /**
      * Propel mapping types.
      *
@@ -381,6 +391,7 @@ class PropelTypes
         self::BU_TIMESTAMP,
         self::SET,
         self::JSON,
+        self::UUID,
     ];
 
     /**
@@ -421,6 +432,7 @@ class PropelTypes
         self::SET => self::SET_NATIVE_TYPE,
         self::GEOMETRY => self::GEOMETRY,
         self::JSON => self::JSON_TYPE,
+        self::UUID => self::UUID_NATIVE_TYPE,
     ];
 
     /**
@@ -466,6 +478,7 @@ class PropelTypes
         self::BU_DATE => PDO::PARAM_STR,
         self::BU_TIMESTAMP => PDO::PARAM_STR,
         self::JSON => PDO::PARAM_STR,
+        self::UUID => PDO::PARAM_STR,
     ];
 
     /**
@@ -542,7 +555,7 @@ public static function isTemporalType(string $type): bool
             self::TIMESTAMP,
             self::BU_DATE,
             self::BU_TIMESTAMP,
-        ]);
+        ], true);
     }
 
     /**
@@ -566,7 +579,7 @@ public static function isTextType(string $mappingType): bool
             self::BU_DATE,
             self::BU_TIMESTAMP,
             self::JSON,
-        ]);
+        ], true);
     }
 
     /**
@@ -588,7 +601,7 @@ public static function isNumericType(string $mappingType): bool
             self::NUMERIC,
             self::DECIMAL,
             self::REAL,
-        ]);
+        ], true);
     }
 
     /**
@@ -600,7 +613,7 @@ public static function isNumericType(string $mappingType): bool
      */
     public static function isBooleanType(string $mappingType): bool
     {
-        return in_array($mappingType, [self::BOOLEAN, self::BOOLEAN_EMU]);
+        return in_array($mappingType, [self::BOOLEAN, self::BOOLEAN_EMU], true);
     }
 
     /**
@@ -612,7 +625,21 @@ public static function isBooleanType(string $mappingType): bool
      */
     public static function isLobType(string $mappingType): bool
     {
-        return in_array($mappingType, [self::VARBINARY, self::LONGVARBINARY, self::BLOB, self::OBJECT, self::GEOMETRY]);
+        return in_array($mappingType, [self::VARBINARY, self::LONGVARBINARY, self::BLOB, self::OBJECT, self::GEOMETRY], true);
+    }
+
+    /**
+     * Returns whether the given type is a UUID type.
+     *
+     * @param string $type
+     *
+     * @return bool
+     */
+    public static function isUuidType(string $type): bool
+    {
+        return in_array($type, [
+            self::UUID,
+        ], true);
     }
 
     /**
@@ -624,7 +651,7 @@ public static function isLobType(string $mappingType): bool
      */
     public static function isPhpPrimitiveType(string $phpType): bool
     {
-        return in_array($phpType, ['boolean', 'int', 'double', 'float', 'string']);
+        return in_array($phpType, ['boolean', 'int', 'double', 'float', 'string'], true);
     }
 
     /**
@@ -636,7 +663,7 @@ public static function isPhpPrimitiveType(string $phpType): bool
      */
     public static function isPhpPrimitiveNumericType(string $phpType): bool
     {
-        return in_array($phpType, ['boolean', 'int', 'double', 'float']);
+        return in_array($phpType, ['boolean', 'int', 'double', 'float'], true);
     }
 
     /**
@@ -648,7 +675,7 @@ public static function isPhpPrimitiveNumericType(string $phpType): bool
      */
     public static function isPhpObjectType(string $phpType): bool
     {
-        return !self::isPhpPrimitiveType($phpType) && !in_array($phpType, ['resource', 'array']);
+        return !self::isPhpPrimitiveType($phpType) && !in_array($phpType, ['resource', 'array'], true);
     }
 
     /**

diff --git a/src/Propel/Generator/Platform/MssqlPlatform.php b/src/Propel/Generator/Platform/MssqlPlatform.php
@@ -57,6 +57,7 @@ protected function initialize(): void
         $this->setSchemaDomainMapping(new Domain(PropelTypes::PHP_ARRAY, 'VARCHAR(MAX)'));
         $this->setSchemaDomainMapping(new Domain(PropelTypes::ENUM, 'TINYINT'));
         $this->setSchemaDomainMapping(new Domain(PropelTypes::SET, 'INT'));
+        $this->setSchemaDomainMapping(new Domain(PropelTypes::UUID, 'UNIQUEIDENTIFIER'));
     }
 
     /**

diff --git a/src/Propel/Generator/Platform/MysqlPlatform.php b/src/Propel/Generator/Platform/MysqlPlatform.php
@@ -53,6 +53,7 @@ class MysqlPlatform extends DefaultPlatform
     protected function initialize(): void
     {
         parent::initialize();
+        unset($this->schemaDomainMap[PropelTypes::UUID]);
         $this->setSchemaDomainMapping(new Domain(PropelTypes::BOOLEAN, 'TINYINT', 1));
         $this->setSchemaDomainMapping(new Domain(PropelTypes::NUMERIC, 'DECIMAL'));
         $this->setSchemaDomainMapping(new Domain(PropelTypes::LONGVARCHAR, 'TEXT'));

diff --git a/src/Propel/Generator/Platform/OraclePlatform.php b/src/Propel/Generator/Platform/OraclePlatform.php
@@ -60,6 +60,7 @@ protected function initialize(): void
         $this->setSchemaDomainMapping(new Domain(PropelTypes::PHP_ARRAY, 'NVARCHAR2', 2000));
         $this->setSchemaDomainMapping(new Domain(PropelTypes::ENUM, 'NUMBER', 3, 0));
         $this->setSchemaDomainMapping(new Domain(PropelTypes::SET, 'NUMBER'));
+        $this->setSchemaDomainMapping(new Domain(PropelTypes::UUID, 'UUID'));
     }
 
     /**

diff --git a/src/Propel/Generator/Platform/PgsqlPlatform.php b/src/Propel/Generator/Platform/PgsqlPlatform.php
@@ -62,6 +62,7 @@ protected function initialize(): void
         $this->setSchemaDomainMapping(new Domain(PropelTypes::SET, 'INT4'));
         $this->setSchemaDomainMapping(new Domain(PropelTypes::DECIMAL, 'NUMERIC'));
         $this->setSchemaDomainMapping(new Domain(PropelTypes::DATETIME, 'TIMESTAMP'));
+        $this->setSchemaDomainMapping(new Domain(PropelTypes::UUID, 'uuid'));
     }
 
     /**
@@ -582,7 +583,7 @@ public function supportsSchemas(): bool
      */
     public function hasSize(string $sqlType): bool
     {
-        return !in_array($sqlType, ['BYTEA', 'TEXT', 'DOUBLE PRECISION']);
+        return !in_array(strtoupper($sqlType), ['BYTEA', 'TEXT', 'DOUBLE PRECISION'], true);
     }
 
     /**
@@ -670,9 +671,6 @@ public function getModifyColumnDDL(ColumnDiff $columnDiff): string
             }
 
             if (!$toColumn->isAutoIncrement() && $fromColumn->isAutoIncrement()) {
-                $changedProperties['defaultValueValue'] = [$fromColumn->getDefaultValueString(), null];
-                $toColumn->setDefaultValue(null);
-
                 //remove sequence
                 if ($fromTable->getDatabase()->hasSequence($seqName)) {
                     $this->createOrDropSequences .= sprintf(
@@ -730,6 +728,18 @@ public function getModifyColumnDDL(ColumnDiff $columnDiff): string
         return $ret;
     }
 
+    /**
+     * @param string $type
+     *
+     * @return bool
+     */
+    public function isUuid(string $type): bool
+    {
+        $strings = ['UUID'];
+
+        return in_array(strtoupper($type), $strings, true);
+    }
+
     /**
      * @param string $type
      *
@@ -739,7 +749,7 @@ public function isString(string $type): bool
     {
         $strings = ['VARCHAR'];
 
-        return in_array(strtoupper($type), $strings);
+        return in_array(strtoupper($type), $strings, true);
     }
 
     /**
@@ -751,7 +761,7 @@ public function isNumber(string $type): bool
     {
         $numbers = ['INTEGER', 'INT4', 'INT2', 'NUMBER', 'NUMERIC', 'SMALLINT', 'BIGINT', 'DECIMAL', 'REAL', 'DOUBLE PRECISION', 'SERIAL', 'BIGSERIAL'];
 
-        return in_array(strtoupper($type), $numbers);
+        return in_array(strtoupper($type), $numbers, true);
     }
 
     /**
@@ -766,10 +776,6 @@ public function getUsingCast(Column $fromColumn, Column $toColumn): string
         $toSqlType = strtoupper($toColumn->getDomain()->getSqlType());
         $name = $fromColumn->getName();
 
-        if ($this->isNumber($fromSqlType) && $this->isString($toSqlType)) {
-            //cast from int to string
-            return '  ';
-        }
         if ($this->isString($fromSqlType) && $this->isNumber($toSqlType)) {
             //cast from string to int
             return "
@@ -782,16 +788,18 @@ public function getUsingCast(Column $fromColumn, Column $toColumn): string
             return " USING decode(CAST($name as text), 'escape')";
         }
 
-        if ($fromSqlType === 'DATE' && $toSqlType === 'TIME') {
-            return ' USING NULL';
-        }
-
-        if ($this->isNumber($fromSqlType) && $this->isNumber($toSqlType)) {
+        if (
+            ($this->isNumber($fromSqlType) && $this->isNumber($toSqlType)) ||
+            ($this->isString($fromSqlType) && $this->isString($toSqlType)) ||
+            ($this->isNumber($fromSqlType) && $this->isString($toSqlType)) ||
+            ($this->isUuid($fromSqlType) && $this->isString($toSqlType))
+        ) {
+            // no cast necessary
             return '';
         }
 
-        if ($this->isString($fromSqlType) && $this->isString($toSqlType)) {
-            return '';
+        if ($this->isString($fromSqlType) && $this->isUuid($toSqlType)) {
+            return " USING $name::uuid";
         }
 
         return ' USING NULL';

diff --git a/src/Propel/Generator/Platform/SqlitePlatform.php b/src/Propel/Generator/Platform/SqlitePlatform.php
@@ -59,6 +59,8 @@ protected function initialize(): void
 
         $this->foreignKeySupport = version_compare($version, '3.6.19') >= 0;
 
+        unset($this->schemaDomainMap[PropelTypes::UUID]);
+
         $this->setSchemaDomainMapping(new Domain(PropelTypes::NUMERIC, 'DECIMAL'));
         $this->setSchemaDomainMapping(new Domain(PropelTypes::LONGVARCHAR, 'MEDIUMTEXT'));
         $this->setSchemaDomainMapping(new Domain(PropelTypes::DATE, 'DATETIME'));

diff --git a/src/Propel/Generator/Reverse/AbstractSchemaParser.php b/src/Propel/Generator/Reverse/AbstractSchemaParser.php
@@ -191,11 +191,7 @@ protected function getMappedPropelType(string $nativeType): ?string
             $this->nativeToPropelTypeMap = $this->getTypeMapping();
         }
 
-        if (isset($this->nativeToPropelTypeMap[$nativeType])) {
-            return $this->nativeToPropelTypeMap[$nativeType];
-        }
-
-        return null;
+        return $this->nativeToPropelTypeMap[$nativeType] ?? null;
     }
 
     /**

diff --git a/src/Propel/Generator/Reverse/MssqlSchemaParser.php b/src/Propel/Generator/Reverse/MssqlSchemaParser.php
@@ -60,7 +60,7 @@ class MssqlSchemaParser extends AbstractSchemaParser
         'timestamp' => PropelTypes::BINARY,
         'tinyint identity' => PropelTypes::TINYINT,
         'tinyint' => PropelTypes::TINYINT,
-        'uniqueidentifier' => PropelTypes::CHAR,
+        'uniqueidentifier' => PropelTypes::UUID,
         'varbinary' => PropelTypes::VARBINARY,
         'varbinary(max)' => PropelTypes::CLOB,
         'varchar' => PropelTypes::VARCHAR,

diff --git a/src/Propel/Generator/Reverse/OracleSchemaParser.php b/src/Propel/Generator/Reverse/OracleSchemaParser.php
@@ -58,6 +58,7 @@ class OracleSchemaParser extends AbstractSchemaParser
         'NUMBER' => PropelTypes::INTEGER,
         'NVARCHAR2' => PropelTypes::VARCHAR,
         'TIMESTAMP' => PropelTypes::TIMESTAMP,
+        'UUID' => PropelTypes::UUID,
         'VARCHAR2' => PropelTypes::VARCHAR,
     ];
 

diff --git a/src/Propel/Generator/Reverse/PgsqlSchemaParser.php b/src/Propel/Generator/Reverse/PgsqlSchemaParser.php
@@ -73,6 +73,7 @@ class PgsqlSchemaParser extends AbstractSchemaParser
         'timestamp with time zone' => PropelTypes::TIMESTAMP,
         'double precision' => PropelTypes::DOUBLE,
         'json' => PropelTypes::JSON,
+        'uuid' => PropelTypes::UUID,
     ];
 
     /**

diff --git a/src/Propel/Generator/Reverse/SqliteSchemaParser.php b/src/Propel/Generator/Reverse/SqliteSchemaParser.php
@@ -68,6 +68,7 @@ class SqliteSchemaParser extends AbstractSchemaParser
         'text' => PropelTypes::LONGVARCHAR,
         'enum' => PropelTypes::CHAR,
         'set' => PropelTypes::CHAR,
+        'uuid' => PropelTypes::UUID,
     ];
 
     /**

diff --git a/src/Propel/Runtime/ActiveQuery/Criteria.php b/src/Propel/Runtime/ActiveQuery/Criteria.php
@@ -2357,7 +2357,7 @@ public function getPrimaryKey(?self $criteria = null): ?ColumnMap
      * WHERE some_column = some value AND could_have_another_column =
      * another value AND so on.
      *
-     * @param \Propel\Runtime\ActiveQuery\Criteria|array $updateValues A Criteria object containing values used in set clause.
+     * @param \Propel\Runtime\ActiveQuery\Criteria $updateValues A Criteria object containing values used in set clause.
      * @param \Propel\Runtime\Connection\ConnectionInterface $con The ConnectionInterface connection object to use.
      *
      * @return int The number of rows affected by last update statement.
@@ -2366,7 +2366,7 @@ public function getPrimaryKey(?self $criteria = null): ?ColumnMap
      *             Note that the return value does require that this information is returned
      *             (supported) by the Propel db driver.
      */
-    public function doUpdate($updateValues, ConnectionInterface $con): int
+    public function doUpdate(Criteria $updateValues, ConnectionInterface $con): int
     {
         return UpdateQueryExecutor::execute($this, $updateValues, $con);
     }

diff --git a/src/Propel/Runtime/ActiveQuery/SqlBuilder/InsertQuerySqlBuilder.php b/src/Propel/Runtime/ActiveQuery/SqlBuilder/InsertQuerySqlBuilder.php
@@ -71,6 +71,8 @@ protected function buildSimpleColumnNamesCsv(array $qualifiedColumnNames): strin
     }
 
     /**
+     * Build a comma separated list of placeholders, i.e. ":p1,:p2,:p3" for 3 placeholders.
+     *
      * @param int $numberOfPlaceholders
      *
      * @return string

diff --git a/src/Propel/Runtime/ActiveQuery/SqlBuilder/UpdateQuerySqlBuilder.php b/src/Propel/Runtime/ActiveQuery/SqlBuilder/UpdateQuerySqlBuilder.php
@@ -23,7 +23,7 @@ class UpdateQuerySqlBuilder extends AbstractSqlQueryBuilder
 
     /**
      * @psalm-var array<string, array<string>>
-     * @var array<string>
+     * @var array<array<string>>
      */
     protected $updateTablesColumns;
 

diff --git a/src/Propel/Runtime/Map/ColumnMap.php b/src/Propel/Runtime/Map/ColumnMap.php
@@ -294,6 +294,16 @@ public function isText(): bool
         ]);
     }
 
+    /**
+     * Whether this column contains UUIDs.
+     *
+     * @return bool
+     */
+    public function isUuid(): bool
+    {
+        return $this->type === PropelTypes::UUID;
+    }
+
     /**
      * Set the size of this column.
      *