Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add getViews and categorize table types #3327

Open
wants to merge 12 commits into
base: 5.x
Choose a base branch
from
Open

feat: add getViews and categorize table types #3327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c32dd99
feat: exclude system collections, add engine collection type to getTa…
masterbater Mar 24, 2025
196405b
chore: remove comment
masterbater Mar 24, 2025
3162280
feat: separate virtual view and table
masterbater Mar 24, 2025
ae5187a
chore: cs fix
masterbater Mar 24, 2025
12b6d1f
chore: remove modified dev environment
masterbater Mar 24, 2025
825a4fe
fix: restore aggregate getTables
masterbater Mar 24, 2025
19f1cdd
fix: follow suggestions
masterbater Mar 24, 2025
7a774e9
fix: remove stats, comparison directly in if
masterbater Mar 24, 2025
44a57f5
fix: follow master jmikola suggestions
masterbater Mar 25, 2025
ef91b44
chore: fix grammar comment
masterbater Mar 25, 2025
4890eca
feat: categorize by collection type, drop database in dropAllTables
masterbater Mar 25, 2025
0e14a68
chore: add test to ensure normal collections are excluded from getViews
masterbater Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 50 additions & 10 deletions src/Schema/Builder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,21 +134,34 @@ public function drop($table)
$blueprint->drop();
}

/** @inheritdoc */
/**
* @inheritdoc
*
* Drops the entire database instead of deleting each collection individually.
*
* In MongoDB, dropping the whole database is much faster than dropping collections
* one by one. The database will be automatically recreated when a new connection
* writes to it.
*/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doc block and its method have inconsistent indentation.

public function dropAllTables()
{
foreach ($this->getAllCollections() as $collection) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GromNaN: This is now outside the scope of this PR, but I noted that getAllCollections() could more easily use Database::listCollectionNames().

That said, I'm not even sure that method is still necessary unless you're overriding a base method. It was protected, but this seemed like the only reference to it (in this file at least).

$this->drop($collection);
}
$this->connection->getDatabase()->drop();
}

/** @param string|null $schema Database name */
/** @param string|null $schema Database name */
public function getTables($schema = null)
{
$db = $this->connection->getDatabase($schema);
$collections = [];

foreach ($db->listCollectionNames() as $collectionName) {
foreach ($db->listCollections() as $collectionInfo) {
$collectionName = $collectionInfo->getName();

// Skip views, which don't support aggregate
if ($collectionInfo->getType() === 'view') {
continue;
}

$stats = $db->selectCollection($collectionName)->aggregate([
['$collStats' => ['storageStats' => ['scale' => 1]]],
['$project' => ['storageStats.totalSize' => 1]],
Expand All @@ -165,9 +178,37 @@ public function getTables($schema = null)
];
}

usort($collections, function ($a, $b) {
return $a['name'] <=> $b['name'];
});
usort($collections, fn ($a, $b) => $a['name'] <=> $b['name']);

return $collections;
}

/** @param string|null $schema Database name */
public function getViews($schema = null)
{
$db = $this->connection->getDatabase($schema);
$collections = [];

foreach ($db->listCollections() as $collectionInfo) {
$collectionName = $collectionInfo->getName();

// Skip normal type collection
if ($collectionInfo->getType() !== 'view') {
continue;
}

$collections[] = [
'name' => $collectionName,
'schema' => $db->getDatabaseName(),
'schema_qualified_name' => $db->getDatabaseName() . '.' . $collectionName,
'size' => null,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is relevant, the information can be provided via $collStats (MongoDB 6.2+). I'm not sure that'd be worth the overhead to obtain this for all collections/views, though.

'comment' => null,
'collation' => null,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is actually relevant, the information should be available via the options field for each collection info result. See: listCollections

'engine' => null,
];
}

usort($collections, fn ($a, $b) => $a['name'] <=> $b['name']);

return $collections;
}
Expand Down Expand Up @@ -195,7 +236,6 @@ public function getTableListing($schema = null, $schemaQualified = false)
}

$collections = array_merge(...array_values($collections));

sort($collections);

return $collections;
Expand Down
41 changes: 40 additions & 1 deletion tests/SchemaTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ class SchemaTest extends TestCase
{
public function tearDown(): void
{
$database = $this->getConnection('mongodb')->getMongoDB();
$database = $this->getConnection('mongodb')->getDatabase();
assert($database instanceof Database);
$database->dropCollection('newcollection');
$database->dropCollection('newcollection_two');
$database->dropCollection('test_view');

parent::tearDown();
}
Expand Down Expand Up @@ -395,6 +396,7 @@ public function testGetTables()
{
DB::connection('mongodb')->table('newcollection')->insert(['test' => 'value']);
DB::connection('mongodb')->table('newcollection_two')->insert(['test' => 'value']);
DB::connection('mongodb')->getDatabase()->createCollection('test_view', ['viewOn' => 'newcollection']);
$dbName = DB::connection('mongodb')->getDatabaseName();

$tables = Schema::getTables();
Expand All @@ -407,6 +409,9 @@ public function testGetTables()
$this->assertArrayHasKey('schema', $table);
$this->assertArrayHasKey('schema_qualified_name', $table);

// Ensure "test_view" is not in the tables list
$this->assertNotEquals('test_view', $table['name'], 'Standard views should not be included in the result of getTables.');

if ($table['name'] === 'newcollection') {
$this->assertEquals(8192, $table['size']);
$this->assertEquals($dbName, $table['schema']);
Expand All @@ -420,6 +425,40 @@ public function testGetTables()
}
}

public function testGetViews()
{
DB::connection('mongodb')->table('newcollection')->insert(['test' => 'value']);
DB::connection('mongodb')->table('newcollection_two')->insert(['test' => 'value']);
$dbName = DB::connection('mongodb')->getDatabaseName();

DB::connection('mongodb')->getDatabase()->createCollection('test_view', ['viewOn' => 'newcollection']);

$tables = Schema::getViews();

$this->assertIsArray($tables);
$this->assertGreaterThanOrEqual(1, count($tables));
$found = false;
foreach ($tables as $table) {
$this->assertArrayHasKey('name', $table);
$this->assertArrayHasKey('size', $table);
$this->assertArrayHasKey('schema', $table);
$this->assertArrayHasKey('schema_qualified_name', $table);

// Ensure "normal collections" are not in the views list
$this->assertNotEquals('newcollection', $table['name'], 'Normal collections should not be included in the result of getViews.');

if ($table['name'] === 'test_view') {
$this->assertEquals($dbName, $table['schema']);
$this->assertEquals($dbName . '.test_view', $table['schema_qualified_name']);
$found = true;
}
}

if (! $found) {
$this->fail('Collection "test_view" not found');
}
}

public function testGetTableListing()
{
DB::connection('mongodb')->table('newcollection')->insert(['test' => 'value']);
Expand Down
Loading