[9.x] Add getAllTables support for SQLite and SQLServer schema builde…

…rs (#41896) * add sqlite and sqlserver table column getters * formatting Co-authored-by: Jonathan Havens <[email protected]> Co-authored-by: Taylor Otwell <[email protected]>
laravel · Apr 12, 2022 · 827893f · 827893f
1 parent fab6107
commit 827893f
Show file tree

Hide file tree

Showing 6 changed files with 267 additions and 1 deletion.
diff --git a/src/Illuminate/Database/Schema/Grammars/SQLiteGrammar.php b/src/Illuminate/Database/Schema/Grammars/SQLiteGrammar.php
@@ -246,6 +246,26 @@ public function compileDropAllViews()
         return "delete from sqlite_master where type in ('view')";
     }
 
+    /**
+     * Compile the SQL needed to retrieve all table names.
+     *
+     * @return string
+     */
+    public function compileGetAllTables()
+    {
+        return 'select type, name from sqlite_master where type = \'table\' and name not like \'sqlite_%\'';
+    }
+
+    /**
+     * Compile the SQL needed to retrieve all view names.
+     *
+     * @return string
+     */
+    public function compileGetAllViews()
+    {
+        return 'select type, name from sqlite_master where type = \'view\'';
+    }
+
     /**
      * Compile the SQL needed to rebuild the database.
      *

diff --git a/src/Illuminate/Database/Schema/Grammars/SqlServerGrammar.php b/src/Illuminate/Database/Schema/Grammars/SqlServerGrammar.php
@@ -393,6 +393,27 @@ public function compileDropAllViews()
             EXEC sp_executesql @sql;";
     }
 
+    /**
+     * Compile the SQL needed to retrieve all table names.
+     *
+     * @return string
+     */
+    public function compileGetAllTables()
+    {
+        return "select name, type from sys.tables where type = 'U'";
+    }
+
+    /**
+     * Compile the SQL needed to retrieve all view names.
+     *
+     * @return string
+     */
+    public function compileGetAllViews()
+    {
+        return "select name, type from sys.objects where type = 'V'";
+    }
+
+
     /**
      * Create the column definition for a char type.
      *

diff --git a/src/Illuminate/Database/Schema/SQLiteBuilder.php b/src/Illuminate/Database/Schema/SQLiteBuilder.php
@@ -66,6 +66,30 @@ public function dropAllViews()
         $this->connection->select($this->grammar->compileRebuild());
     }
 
+    /**
+     * Get all of the table names for the database.
+     *
+     * @return array
+     */
+    public function getAllTables()
+    {
+        return $this->connection->select(
+            $this->grammar->compileGetAllTables()
+        );
+    }
+
+    /**
+     * Get all of the view names for the database.
+     *
+     * @return array
+     */
+    public function getAllViews()
+    {
+        return $this->connection->select(
+            $this->grammar->compileGetAllViews()
+        );
+    }
+
     /**
      * Empty the database file.
      *

diff --git a/src/Illuminate/Database/Schema/SqlServerBuilder.php b/src/Illuminate/Database/Schema/SqlServerBuilder.php
@@ -30,7 +30,7 @@ public function dropDatabaseIfExists($name)
         );
     }
 
-    /**
+	/**
      * Drop all tables from the database.
      *
      * @return void
@@ -51,4 +51,28 @@ public function dropAllViews()
     {
         $this->connection->statement($this->grammar->compileDropAllViews());
     }
+
+    /**
+     * Drop all tables from the database.
+     *
+     * @return array
+     */
+    public function getAllTables()
+    {
+        return $this->connection->select(
+            $this->grammar->compileGetAllTables()
+        );
+    }
+
+    /**
+     * Get all of the view names for the database.
+     *
+     * @return array
+     */
+    public function getAllViews()
+    {
+        return $this->connection->select(
+            $this->grammar->compileGetAllViews()
+        );
+    }
 }
diff --git a/tests/Integration/Database/SqlServer/DatabaseSqlServerSchemaBuilderTest.php b/tests/Integration/Database/SqlServer/DatabaseSqlServerSchemaBuilderTest.php
@@ -0,0 +1,85 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Database\SqlServer;
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Schema;
+use stdClass;
+
+class DatabaseSqlServerSchemaBuilderTest extends SqlServerTestCase
+{
+    protected function getEnvironmentSetUp($app)
+    {
+        if (getenv('DB_CONNECTION') !== 'sqlsrv') {
+            $this->markTestSkipped('Test requires a SQLServer connection.');
+        }
+
+        $this->driver = 'sqlsrv';
+    }
+
+    protected function defineDatabaseMigrationsAfterDatabaseRefreshed()
+    {
+        Schema::create('users', function (Blueprint $table) {
+            $table->integer('id');
+            $table->string('name');
+            $table->string('age');
+            $table->enum('color', ['red', 'blue']);
+        });
+    }
+
+    protected function destroyDatabaseMigrations()
+    {
+        Schema::drop('users');
+    }
+
+    public function testGetAllTablesAndColumnListing()
+    {
+        $tables = Schema::getAllTables();
+
+        $this->assertCount(2, $tables);
+        $tableProperties = array_values((array) $tables[0]);
+        $this->assertEquals(['migrations', 'U '], $tableProperties);
+
+        $this->assertInstanceOf(stdClass::class, $tables[1]);
+
+        $tableProperties = array_values((array) $tables[1]);
+        $this->assertEquals(['users', 'U '], $tableProperties);
+
+        $columns = Schema::getColumnListing('users');
+
+        foreach (['id', 'name', 'age', 'color'] as $column) {
+            $this->assertContains($column, $columns);
+        }
+
+        Schema::create('posts', function (Blueprint $table) {
+            $table->integer('id');
+            $table->string('title');
+        });
+        $tables = Schema::getAllTables();
+        $this->assertCount(3, $tables);
+        Schema::drop('posts');
+    }
+
+    public function testGetAllViews()
+    {
+        DB::connection('sqlsrv')->statement(<<<SQL
+CREATE VIEW users_view
+AS
+SELECT name,age from users;
+SQL);
+
+        $tableView = Schema::getAllViews();
+
+        $this->assertCount(1, $tableView);
+        $this->assertInstanceOf(stdClass::class, $obj = array_values($tableView)[0]);
+        $this->assertEquals('users_view', $obj->name);
+        $this->assertEquals('V ', $obj->type);
+
+        DB::connection('sqlsrv')->statement(<<<SQL
+DROP VIEW IF EXISTS users_view;
+SQL);
+
+        $this->assertEmpty(Schema::getAllViews());
+    }
+}
diff --git a/tests/Integration/Database/Sqlite/DatabaseSqliteSchemaBuilderTest.php b/tests/Integration/Database/Sqlite/DatabaseSqliteSchemaBuilderTest.php
@@ -0,0 +1,92 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Database\Sqlite;
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Tests\Integration\Database\DatabaseTestCase;
+use stdClass;
+
+class DatabaseSqliteSchemaBuilderTest extends DatabaseTestCase
+{
+    protected function getEnvironmentSetUp($app)
+    {
+        if (getenv('DB_CONNECTION') !== 'testing') {
+            $this->markTestSkipped('Test requires a Sqlite connection.');
+        }
+
+        $app['config']->set('database.default', 'conn1');
+
+        $app['config']->set('database.connections.conn1', [
+            'driver' => 'sqlite',
+            'database' => ':memory:',
+            'prefix' => '',
+        ]);
+    }
+
+    protected function defineDatabaseMigrationsAfterDatabaseRefreshed()
+    {
+        Schema::create('users', function (Blueprint $table) {
+            $table->integer('id');
+            $table->string('name');
+            $table->string('age');
+            $table->enum('color', ['red', 'blue']);
+        });
+    }
+
+    protected function destroyDatabaseMigrations()
+    {
+        Schema::drop('users');
+    }
+
+    public function testGetAllTablesAndColumnListing()
+    {
+        $tables = Schema::getAllTables();
+
+        $this->assertCount(2, $tables);
+        $tableProperties = array_values((array) $tables[0]);
+        $this->assertEquals(['table', 'migrations'], $tableProperties);
+
+        $this->assertInstanceOf(stdClass::class, $tables[1]);
+
+        $tableProperties = array_values((array) $tables[1]);
+        $this->assertEquals(['table', 'users'], $tableProperties);
+
+        $columns = Schema::getColumnListing('users');
+
+        foreach (['id', 'name', 'age', 'color'] as $column) {
+            $this->assertContains($column, $columns);
+        }
+
+        Schema::create('posts', function (Blueprint $table) {
+            $table->integer('id');
+            $table->string('title');
+        });
+        $tables = Schema::getAllTables();
+        $this->assertCount(3, $tables);
+        Schema::drop('posts');
+    }
+
+    public function testGetAllViews()
+    {
+        DB::connection('conn1')->statement(<<<SQL
+CREATE VIEW users_view
+AS
+SELECT name,age from users;
+SQL);
+
+        $tableView = Schema::getAllViews();
+
+        $this->assertCount(1, $tableView);
+        $this->assertInstanceOf(stdClass::class, $obj = array_values($tableView)[0]);
+        $this->assertEquals('users_view', $obj->name);
+        $this->assertEquals('view', $obj->type);
+
+        DB::connection('conn1')->statement(<<<SQL
+DROP VIEW IF EXISTS users_view;
+SQL);
+
+        $this->assertEmpty(Schema::getAllViews());
+    }
+}