Create IndexType class (#301)

Author: Tigrov

CHANGELOG.md

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

src/IndexType.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Db\Oracle;
+
+/**
+ * Defines the available index types for {@see DDLQueryBuilder::createIndex()} method.
+ */
+final class IndexType
+{
+    /**
+     * Define the type of the index as `UNIQUE`.
+     */
+    public const UNIQUE = 'UNIQUE';
+    /**
+     * Define the type of the index as `BITMAP`.
+     */
+    public const BITMAP = 'BITMAP';
+    /**
+     * Define the type of the index as `MULTIVALUE`.
+     */
+    public const MULTIVALUE = 'MULTIVALUE';
+    /**
+     * Define the type of the index as `SEARCH`.
+     */
+    public const SEARCH = 'SEARCH';
+}

src/Schema.php

@@ -267,8 +267,8 @@ protected function loadTableIndexes(string $tableName): array
         foreach ($indexes as $name => $index) {
             $columnNames = array_column($index, 'column_name');
 
-            if ($columnNames[0] === null) {
-                $columnNames[0] = '';
+            if ($columnNames === [null]) {
+                $columnNames = [];
             }
 
             $result[] = (new IndexConstraint())

tests/CommandTest.php

@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Db\Oracle\Tests;
 
+use PHPUnit\Framework\Attributes\DataProviderExternal;
 use ReflectionException;
 use Throwable;
 use Yiisoft\Db\Constant\ColumnType;
@@ -13,9 +14,12 @@
 use Yiisoft\Db\Exception\InvalidCallException;
 use Yiisoft\Db\Exception\InvalidConfigException;
 use Yiisoft\Db\Exception\NotSupportedException;
+use Yiisoft\Db\Oracle\Column\ColumnBuilder;
 use Yiisoft\Db\Oracle\Connection;
 use Yiisoft\Db\Oracle\Dsn;
 use Yiisoft\Db\Oracle\Driver;
+use Yiisoft\Db\Oracle\IndexType;
+use Yiisoft\Db\Oracle\Tests\Provider\CommandProvider;
 use Yiisoft\Db\Oracle\Tests\Support\TestTrait;
 use Yiisoft\Db\Query\Query;
 use Yiisoft\Db\Tests\Common\CommonCommandTest;
@@ -26,6 +30,7 @@
 use function is_resource;
 use function str_pad;
 use function stream_get_contents;
+use function version_compare;
 
 /**
  * @group oracle
@@ -636,4 +641,47 @@ public function testShowDatabases(): void
         $this->assertSame('oci:dbname=localhost:1521', $db->getDriver()->getDsn());
         $this->assertSame(['YIITEST'], $command->showDatabases());
     }
+
+    #[DataProviderExternal(CommandProvider::class, 'createIndex')]
+    public function testCreateIndex(array $columns, array $indexColumns, string|null $indexType, string|null $indexMethod): void
+    {
+        parent::testCreateIndex($columns, $indexColumns, $indexType, $indexMethod);
+    }
+
+    public function testCreateSearchIndex()
+    {
+        $db = $this->getConnection();
+
+        if (version_compare($db->getServerInfo()->getVersion(), '21', '<')) {
+            $this->markTestSkipped('Search index is supported since Oracle 21');
+        }
+
+        $command = $db->createCommand();
+        $schema = $db->getSchema();
+
+        $tableName = 'test_create_index';
+        $indexName = 'test_index_name';
+
+        if ($schema->getTableSchema($tableName) !== null) {
+            $command->dropTable($tableName)->execute();
+        }
+
+        $command->createTable($tableName, ['col1' => ColumnBuilder::text()])->execute();
+        $command->createIndex($tableName, $indexName, ['col1'], IndexType::SEARCH)->execute();
+
+        $this->assertCount(2, $schema->getTableIndexes($tableName));
+
+        $index = $schema->getTableIndexes($tableName)[0];
+
+        $this->assertSame(['col1'], $index->getColumnNames());
+        $this->assertFalse($index->isUnique());
+        $this->assertFalse($index->isPrimary());
+
+        $sysIndex = $schema->getTableIndexes($tableName)[1];
+        $this->assertSame([], $sysIndex->getColumnNames());
+        $this->assertTrue($sysIndex->isUnique());
+        $this->assertFalse($sysIndex->isPrimary());
+
+        $db->close();
+    }
 }

tests/Provider/CommandProvider.php

@@ -7,6 +7,8 @@
 use JsonException;
 use PDO;
 use Yiisoft\Db\Command\Param;
+use Yiisoft\Db\Oracle\Column\ColumnBuilder;
+use Yiisoft\Db\Oracle\IndexType;
 use Yiisoft\Db\Oracle\Tests\Support\TestTrait;
 use Yiisoft\Db\Tests\Support\DbHelper;
 
@@ -92,4 +94,13 @@ public static function insertVarbinary(): array
             ['simple string', 'simple string'],
         ];
     }
+
+    public static function createIndex(): array
+    {
+        return [
+            ...parent::createIndex(),
+            [['col1' => ColumnBuilder::integer()], ['col1'], IndexType::UNIQUE, null],
+            [['col1' => ColumnBuilder::integer()], ['col1'], IndexType::BITMAP, null],
+        ];
+    }
 }