Support JSON type

.github/workflows/build.yml

@@ -63,6 +63,9 @@ jobs:
           --health-retries 10
 
     steps:
+      - name: Configure Database.
+        run: docker exec -i oci bash -c "sqlplus -s system/root@XE <<< 'ALTER USER system DEFAULT TABLESPACE USERS;'"
+
       - name: Checkout.
         uses: actions/checkout@v3
 

.github/workflows/mutation.yml

@@ -52,6 +52,9 @@ jobs:
           --health-retries 10
 
     steps:
+      - name: Configure Database.
+        run: docker exec -i oci bash -c "sqlplus -s system/root@XE <<< 'ALTER USER system DEFAULT TABLESPACE USERS;'"
+
       - name: Checkout.
         uses: actions/checkout@v3
 

CHANGELOG.md

@@ -31,6 +31,7 @@
 - Enh #299: Convert database types to lower case (@Tigrov)
 - Enh #300: Replace `DbArrayHelper::getColumn()` with `array_column()` (@Tigrov)
 - New #301: Add `IndexType` class (@Tigrov)
+- New #303: Support JSON type (@Tigrov)
 
 ## 1.3.0 March 21, 2024
 

phpunit.xml.dist

@@ -1,6 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" colors="true" bootstrap="vendor/autoload.php" failOnRisky="true" failOnWarning="true" executionOrder="default" resolveDependencies="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd">
-  <coverage/>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    colors="true"
+    bootstrap="vendor/autoload.php"
+    failOnRisky="true"
+    failOnWarning="true"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/schema/10.4.xsd"
+>
   <php>
     <ini name="error_reporting" value="-1"/>
   </php>

src/Column/ColumnBuilder.php

@@ -5,12 +5,16 @@
 namespace Yiisoft\Db\Oracle\Column;
 
 use Yiisoft\Db\Constant\ColumnType;
-use Yiisoft\Db\Schema\Column\ColumnInterface;
 
 final class ColumnBuilder extends \Yiisoft\Db\Schema\Column\ColumnBuilder
 {
-    public static function binary(int|null $size = null): ColumnInterface
+    public static function binary(int|null $size = null): BinaryColumn
     {
         return new BinaryColumn(ColumnType::BINARY, size: $size);
     }
+
+    public static function json(): JsonColumn
+    {
+        return new JsonColumn(ColumnType::JSON);
+    }
 }

src/Column/ColumnDefinitionBuilder.php

@@ -49,6 +49,27 @@ public function build(ColumnInterface $column): string
             . $this->buildExtra($column);
     }
 
+    protected function buildCheck(ColumnInterface $column): string
+    {
+        $check = $column->getCheck();
+
+        if (empty($check)) {
+            $name = $column->getName();
+
+            if (empty($name) || version_compare($this->queryBuilder->getServerInfo()->getVersion(), '21', '>=')) {
+                return '';
+            }
+
+            return match ($column->getType()) {
+                ColumnType::ARRAY, ColumnType::STRUCTURED, ColumnType::JSON =>
+                    ' CHECK (' . $this->queryBuilder->quoter()->quoteSimpleColumnName($name) . ' IS JSON)',
+                default => '',
+            };
+        }
+
+        return " CHECK ($check)";
+    }
+
     protected function buildOnDelete(string $onDelete): string
     {
         return match ($onDelete = strtoupper($onDelete)) {
@@ -96,9 +117,10 @@ protected function getDbType(ColumnInterface $column): string
                 ColumnType::TIMESTAMP => 'timestamp',
                 ColumnType::DATE => 'date',
                 ColumnType::TIME => 'interval day(0) to second',
-                ColumnType::ARRAY => 'clob',
-                ColumnType::STRUCTURED => 'clob',
-                ColumnType::JSON => 'clob',
+                ColumnType::ARRAY, ColumnType::STRUCTURED, ColumnType::JSON =>
+                    version_compare($this->queryBuilder->getServerInfo()->getVersion(), '21', '>=')
+                    ? 'json'
+                    : 'clob',
                 default => 'varchar2',
             },
             'timestamp with time zone' => 'timestamp' . ($size !== null ? "($size)" : '') . ' with time zone',

src/Column/ColumnDefinitionParser.php

@@ -22,7 +22,7 @@ final class ColumnDefinitionParser extends \Yiisoft\Db\Syntax\ColumnDefinitionPa
         . 'interval day\s*(?:\((\d+)\))? to second'
         . '|long raw'
         . '|\w*'
-        . ')\s*(?:\(([^)]+)\))?\s*'
+        . ')\s*(?:\(([^)]+)\))?(\[[\d\[\]]*\])?\s*'
         . '/i';
 
     public function parse(string $definition): array
@@ -48,6 +48,11 @@ public function parse(string $definition): array
             $info += ['scale' => (int) $scale];
         }
 
+        if (isset($matches[7])) {
+            /** @psalm-var positive-int */
+            $info['dimension'] = substr_count($matches[7], '[');
+        }
+
         $extra = substr($definition, strlen($matches[0]));
 
         return $info + $this->extraInfo($extra);

src/Column/ColumnFactory.php

@@ -9,6 +9,7 @@
 use Yiisoft\Db\Schema\Column\ColumnInterface;
 
 use function rtrim;
+use function strcasecmp;
 
 final class ColumnFactory extends AbstractColumnFactory
 {
@@ -43,6 +44,7 @@ final class ColumnFactory extends AbstractColumnFactory
         'timestamp with local time zone' => ColumnType::TIMESTAMP,
         'interval day to second' => ColumnType::STRING,
         'interval year to month' => ColumnType::STRING,
+        'json' => ColumnType::JSON,
 
         /** Deprecated */
         'long' => ColumnType::TEXT,
@@ -63,6 +65,10 @@ protected function getType(string $dbType, array $info = []): string
             };
         }
 
+        if (isset($info['check'], $info['name']) && strcasecmp($info['check'], '"' . $info['name'] . '" is json') === 0) {
+            return ColumnType::JSON;
+        }
+
         if ($dbType === 'interval day to second' && isset($info['scale']) && $info['scale'] === 0) {
             return ColumnType::TIME;
         }
@@ -72,11 +78,11 @@ protected function getType(string $dbType, array $info = []): string
 
     protected function getColumnClass(string $type, array $info = []): string
     {
-        if ($type === ColumnType::BINARY) {
-            return BinaryColumn::class;
-        }
-
-        return parent::getColumnClass($type, $info);
+        return match ($type) {
+            ColumnType::BINARY => BinaryColumn::class,
+            ColumnType::JSON => JsonColumn::class,
+            default => parent::getColumnClass($type, $info),
+        };
     }
 
     protected function normalizeNotNullDefaultValue(string $defaultValue, ColumnInterface $column): mixed

src/Column/JsonColumn.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Db\Oracle\Column;
+
+use Yiisoft\Db\Schema\Column\AbstractJsonColumn;
+
+use function is_resource;
+use function is_string;
+use function json_decode;
+use function stream_get_contents;
+
+use const JSON_THROW_ON_ERROR;
+
+/**
+ * Represents a json column with eager parsing values retrieved from the database.
+ */
+final class JsonColumn extends AbstractJsonColumn
+{
+    /**
+     * @throws \JsonException
+     */
+    public function phpTypecast(mixed $value): mixed
+    {
+        if (is_string($value)) {
+            return json_decode($value, true, 512, JSON_THROW_ON_ERROR);
+        }
+
+        if (is_resource($value)) {
+            return json_decode(stream_get_contents($value), true, 512, JSON_THROW_ON_ERROR);
+        }
+
+        return $value;
+    }
+}

src/Schema.php

@@ -45,6 +45,7 @@
  *   nullable: string,
  *   data_default: string|null,
  *   constraint_type: string|null,
+ *   check: string|null,
  *   column_comment: string|null,
  *   schema: string,
  *   table: string
@@ -331,6 +332,22 @@ protected function findColumns(TableSchemaInterface $table): bool
         $tableName = $table->getName();
 
         $sql = <<<SQL
+        WITH C AS (
+            SELECT AC.CONSTRAINT_TYPE, AC.SEARCH_CONDITION, ACC.COLUMN_NAME
+            FROM ALL_CONSTRAINTS AC
+            INNER JOIN ALL_CONS_COLUMNS ACC
+                ON ACC.OWNER = AC.OWNER
+                AND ACC.TABLE_NAME = AC.TABLE_NAME
+                AND ACC.CONSTRAINT_NAME = AC.CONSTRAINT_NAME
+            LEFT JOIN ALL_CONS_COLUMNS ACC2
+                ON ACC2.OWNER = AC.OWNER
+                AND ACC2.TABLE_NAME = AC.TABLE_NAME
+                AND ACC2.CONSTRAINT_NAME = AC.CONSTRAINT_NAME
+                AND ACC2.COLUMN_NAME != ACC.COLUMN_NAME
+            WHERE AC.OWNER = :schemaName2
+                AND AC.TABLE_NAME = :tableName2
+                AND (AC.CONSTRAINT_TYPE = 'P' OR AC.CONSTRAINT_TYPE IN ('U', 'C') AND ACC2.COLUMN_NAME IS NULL)
+        )
         SELECT
             A.COLUMN_NAME,
             A.DATA_TYPE,
@@ -339,7 +356,8 @@ protected function findColumns(TableSchemaInterface $table): bool
             (CASE WHEN A.CHAR_LENGTH > 0 THEN A.CHAR_LENGTH ELSE A.DATA_PRECISION END) AS "size",
             A.NULLABLE,
             A.DATA_DEFAULT,
-            AC.CONSTRAINT_TYPE,
+            C.CONSTRAINT_TYPE,
+            C2.SEARCH_CONDITION AS "check",
             COM.COMMENTS AS COLUMN_COMMENT
         FROM ALL_TAB_COLUMNS A
         INNER JOIN ALL_OBJECTS B
@@ -349,26 +367,12 @@ protected function findColumns(TableSchemaInterface $table): bool
             ON COM.OWNER = A.OWNER
             AND COM.TABLE_NAME = A.TABLE_NAME
             AND COM.COLUMN_NAME = A.COLUMN_NAME
-        LEFT JOIN ALL_CONSTRAINTS AC
-            ON AC.OWNER = A.OWNER
-            AND AC.TABLE_NAME = A.TABLE_NAME
-            AND (AC.CONSTRAINT_TYPE = 'P'
-                OR AC.CONSTRAINT_TYPE = 'U'
-                AND (
-                    SELECT COUNT(*)
-                    FROM ALL_CONS_COLUMNS UCC
-                    WHERE UCC.CONSTRAINT_NAME = AC.CONSTRAINT_NAME
-                        AND UCC.TABLE_NAME = AC.TABLE_NAME
-                        AND UCC.OWNER = AC.OWNER
-                ) = 1
-            )
-            AND AC.CONSTRAINT_NAME IN (
-                SELECT ACC.CONSTRAINT_NAME
-                FROM ALL_CONS_COLUMNS ACC
-                WHERE ACC.OWNER = A.OWNER
-                    AND ACC.TABLE_NAME = A.TABLE_NAME
-                    AND ACC.COLUMN_NAME = A.COLUMN_NAME
-            )
+        LEFT JOIN C
+            ON C.COLUMN_NAME = A.COLUMN_NAME
+            AND C.CONSTRAINT_TYPE IN ('P', 'U')
+        LEFT JOIN C C2
+            ON C2.COLUMN_NAME = A.COLUMN_NAME
+            AND C2.CONSTRAINT_TYPE = 'C'
         WHERE A.OWNER = :schemaName
             AND A.TABLE_NAME = :tableName
             AND B.OBJECT_TYPE IN ('TABLE', 'VIEW', 'MATERIALIZED VIEW')
@@ -377,7 +381,9 @@ protected function findColumns(TableSchemaInterface $table): bool
 
         $columns = $this->db->createCommand($sql, [
             ':schemaName' => $schemaName,
+            ':schemaName2' => $schemaName,
             ':tableName' => $tableName,
+            ':tableName2' => $tableName,
         ])->queryAll();
 
         if ($columns === []) {
@@ -453,6 +459,7 @@ private function loadColumn(array $info): ColumnInterface
 
         return $this->getColumnFactory()->fromDbType($dbType, [
             'autoIncrement' => $info['identity_column'] === 'YES',
+            'check' => $info['check'],
             'comment' => $info['column_comment'],
             'defaultValueRaw' => $info['data_default'],
             'name' => $info['column_name'],

tests/ColumnFactoryTest.php

@@ -7,6 +7,7 @@
 use PHPUnit\Framework\Attributes\DataProviderExternal;
 use Yiisoft\Db\Oracle\Tests\Provider\ColumnFactoryProvider;
 use Yiisoft\Db\Oracle\Tests\Support\TestTrait;
+use Yiisoft\Db\Schema\Column\ColumnInterface;
 use Yiisoft\Db\Tests\AbstractColumnFactoryTest;
 
 /**
@@ -23,23 +24,15 @@ public function testFromDbType(string $dbType, string $expectedType, string $exp
     }
 
     #[DataProviderExternal(ColumnFactoryProvider::class, 'definitions')]
-    public function testFromDefinition(
-        string $definition,
-        string $expectedType,
-        string $expectedInstanceOf,
-        array $expectedMethodResults = []
-    ): void {
-        parent::testFromDefinition($definition, $expectedType, $expectedInstanceOf, $expectedMethodResults);
+    public function testFromDefinition(string $definition, ColumnInterface $expected): void
+    {
+        parent::testFromDefinition($definition, $expected);
     }
 
     #[DataProviderExternal(ColumnFactoryProvider::class, 'pseudoTypes')]
-    public function testFromPseudoType(
-        string $pseudoType,
-        string $expectedType,
-        string $expectedInstanceOf,
-        array $expectedMethodResults = []
-    ): void {
-        parent::testFromPseudoType($pseudoType, $expectedType, $expectedInstanceOf, $expectedMethodResults);
+    public function testFromPseudoType(string $pseudoType, ColumnInterface $expected): void
+    {
+        parent::testFromPseudoType($pseudoType, $expected);
     }
 
     #[DataProviderExternal(ColumnFactoryProvider::class, 'types')]