PHPORM-215 Implement Schema::getColumns and getIndexes

Author: GromNaN

CHANGELOG.md

@@ -4,7 +4,8 @@ All notable changes to this project will be documented in this file.
 ## [4.9.0] - coming soon
 
 * Add `Connection::getServerVersion()` by @GromNaN in [#3043](https://github.com/mongodb/laravel-mongodb/pull/3043)
-* Add `Schema\Builder::getTables()` and `getTableListing` by @GromNaN in [#3044](https://github.com/mongodb/laravel-mongodb/pull/3044)
+* Add `Schema\Builder::getTables()` and `getTableListing()` by @GromNaN in [#3044](https://github.com/mongodb/laravel-mongodb/pull/3044)
+* Add `Schema\Builder::getColumns()` and `getIndexes()` by @GromNaN in [#3045](https://github.com/mongodb/laravel-mongodb/pull/3045)
 
 ## [4.6.0] - 2024-07-09
 

src/Schema/Builder.php

@@ -6,11 +6,17 @@
 
 use Closure;
 use MongoDB\Model\CollectionInfo;
+use MongoDB\Model\IndexInfo;
+use stdClass;
 
+use function array_keys;
+use function assert;
 use function count;
 use function current;
+use function implode;
 use function iterator_to_array;
 use function sort;
+use function sprintf;
 use function usort;
 
 class Builder extends \Illuminate\Database\Schema\Builder
@@ -146,6 +152,70 @@ public function getTableListing()
         return $collections;
     }
 
+    public function getColumns($table)
+    {
+        $stats = $this->connection->getMongoDB()->selectCollection($table)->aggregate([
+            ['$project' => ['fields' => ['$objectToArray' => '$$ROOT']]],
+            ['$unwind' => '$fields'],
+            [
+                '$group' => [
+                    '_id' => '$fields.k',
+                    'total' => ['$count' => new stdClass()],
+                    'types' => ['$addToSet' => ['$type' => '$fields.v']],
+                ],
+            ],
+            ['$sort' => ['_id' => 1]],
+        ], ['typeMap' => ['array' => 'array']])->toArray();
+
+        $columns = [];
+        foreach ($stats as $stat) {
+            sort($stat->types);
+            $type = implode(', ', $stat->types);
+            $columns[] = [
+                'name' => $stat->_id,
+                'type_name' => $type,
+                'type' => $type,
+                'collation' => null,
+                'nullable' => $stat->_id !== '_id',
+                'default' => null,
+                'auto_increment' => false,
+                'comment' => sprintf('%d occurrences', $stat->total),
+                'generation' => $stat->_id === '_id' ? ['type' => 'objectId', 'expression' => null] : null,
+            ];
+        }
+
+        return $columns;
+    }
+
+    public function getIndexes($table)
+    {
+        $indexes = $this->connection->getMongoDB()->selectCollection($table)->listIndexes();
+
+        $indexList = [];
+        foreach ($indexes as $index) {
+            assert($index instanceof IndexInfo);
+            $indexList[] = [
+                'name' => $index->getName(),
+                'columns' => array_keys($index->getKey()),
+                'primary' => $index->getKey() === ['_id' => 1],
+                'type' => match (true) {
+                    $index->isText() => 'text',
+                    $index->is2dSphere() => '2dsphere',
+                    $index->isTtl() => 'ttl',
+                    default => 'default',
+                },
+                'unique' => $index->isUnique(),
+            ];
+        }
+
+        return $indexList;
+    }
+
+    public function getForeignKeys($table)
+    {
+        return [];
+    }
+
     /** @inheritdoc */
     protected function createBlueprint($table, ?Closure $callback = null)
     {

tests/SchemaTest.php

@@ -6,8 +6,11 @@
 
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Schema;
+use MongoDB\BSON\Binary;
+use MongoDB\BSON\UTCDateTime;
 use MongoDB\Laravel\Schema\Blueprint;
 
+use function collect;
 use function count;
 
 class SchemaTest extends TestCase
@@ -416,6 +419,70 @@ public function testGetTableListing()
         $this->assertContains('newcollection_two', $tables);
     }
 
+    public function testGetColumns()
+    {
+        $collection = DB::connection('mongodb')->collection('newcollection');
+        $collection->insert(['text' => 'value', 'mixed' => ['key' => 'value']]);
+        $collection->insert(['date' => new UTCDateTime(), 'binary' => new Binary('binary'), 'mixed' => true]);
+
+        $columns = Schema::getColumns('newcollection');
+        $this->assertIsArray($columns);
+        $this->assertCount(5, $columns);
+
+        $columns = collect($columns)->keyBy('name');
+
+        $columns->each(function ($column) {
+            $this->assertIsString($column['name']);
+            $this->assertEquals($column['type'], $column['type_name']);
+            $this->assertNull($column['collation']);
+            $this->assertIsBool($column['nullable']);
+            $this->assertNull($column['default']);
+            $this->assertFalse($column['auto_increment']);
+            $this->assertIsString($column['comment']);
+        });
+
+        $this->assertEquals('objectId', $columns->get('_id')['type']);
+        $this->assertEquals('objectId', $columns->get('_id')['generation']['type']);
+        $this->assertNull($columns->get('text')['generation']);
+        $this->assertEquals('string', $columns->get('text')['type']);
+        $this->assertEquals('date', $columns->get('date')['type']);
+        $this->assertEquals('binData', $columns->get('binary')['type']);
+        $this->assertEquals('bool, object', $columns->get('mixed')['type']);
+        $this->assertEquals('2 occurrences', $columns->get('mixed')['comment']);
+
+        // Non-existent collection
+        $columns = Schema::getColumns('missing');
+        $this->assertSame([], $columns);
+    }
+
+    public function testGetIndexes()
+    {
+        Schema::create('newcollection', function (Blueprint $collection) {
+            $collection->index('mykey1');
+            $collection->string('mykey2')->unique('unique_index');
+            $collection->string('mykey3')->index();
+        });
+        $indexes = Schema::getIndexes('newcollection');
+        $this->assertIsArray($indexes);
+        $this->assertCount(4, $indexes);
+
+        $indexes = collect($indexes)->keyBy('name');
+
+        $indexes->each(function ($index) {
+            $this->assertIsString($index['name']);
+            $this->assertIsString($index['type']);
+            $this->assertIsArray($index['columns']);
+            $this->assertIsBool($index['unique']);
+            $this->assertIsBool($index['primary']);
+        });
+        $this->assertTrue($indexes->get('_id_')['primary']);
+        $this->assertTrue($indexes->get('unique_index_1')['unique']);
+
+        // Non-existent collection
+        $indexes = Schema::getIndexes('missing');
+        $this->assertSame([], $indexes);
+    }
+
     protected function getIndex(string $collection, string $name)
     {
         $collection = DB::getCollection($collection);