[10.x] Get tables and views info

[hafezdivandari]

This PR adds Schema::getTables() and Schema::getViews() to fetch options and info of tables and views on the connection. We currently use doctrine/dbal on the framework to retrieve this info and also we have Schema::getAllTables() and Schema::getAllViews that this PR deprecates.

Usage

Just like Schema::getColumns() added on #48357, the new Schema::getTables() and Schema::getViews() methods are necessary to inspect the database (db:show, db:table, and model:show artisan commands). These functions provide even more info than doctrine/dbal (e.g. table size):

Schema::getTables()

• name: Name of the table
• schema: Schema name (PostgreSQL and SQL Server)
• size: Total disk space used for the table in bytes, including indexes (On SQLite, would be null if dbstat table is not available)
• comment: Table comment (MySQL and PostgreSQL only)
• collation: Table collation, e.g utf8mb4_unicode_ci (MySQL only)
• engine: Table engine, e.g. InnoDB (MySQL only)

Schema::getViews()

• name: Name of the view
• schema: Schema name (PostgreSQL and SQL Server)
• definition: View definition query

Changes

Feature	Before	After
Schema::getTables()	N/A	Added. Uses Processor::processTables() and Grammar::compileTables()
Schema::getViews()	N/A	Added. Uses Processor::processViews() and Grammar::compileViews()
Schema::getAllTables()	Uses Grammar::compileGetAllTables()	Deprecated. You may use Schema::getTables() instead
Schema::getAllViews()	Uses Grammar::compileGetAllViews()	Deprecated. You may use Schema::getViews() instead
Schema::hasTable()	Uses Grammar::compileTableExists()	Uses newly added Schema::getTables() except on PostgreSQL that left unchanged1
Schema::dropAllTables()	Uses Grammar::getAllTables() on MySQL and PostgreSQL grammars	Uses newly added Schema::getTables() on MySQL and PostgreSQL grammars
Schema::dropAllViews()	Uses Grammar::getAllViews() on MySQL and PostgreSQL grammars	Uses newly added Schema::getViews() on MySQL and PostgreSQL grammars

1. Schema::hasTable() left unchanged on PostgreSQL to avoid a breaking change on a rare case that user is calling this function with a 3-parts search path Schema::hasTable('database.schema.table'), although this usage is non-standard IMO and should be Schema::connection('database')->hasTable('schema.table'). I'll cover this on another PR to master branch.

Deprecations

• \Illuminate\Database\Schema\Builder::getAllTables()
• \Illuminate\Database\Schema\MySqlBuilder::getAllTables()
• \Illuminate\Database\Schema\MySqlBuilder::getAllViews()
• \Illuminate\Database\Schema\PostgresBuilder::getAllTables()
• \Illuminate\Database\Schema\PostgresBuilder::getAllViews()
• \Illuminate\Database\Schema\SQLiteBuilder::getAllTables()
• \Illuminate\Database\Schema\SQLiteBuilder::getAllViews()
• \Illuminate\Database\Schema\SqlServerBuilder::getAllTables()
• \Illuminate\Database\Schema\SqlServerBuilder::getAllViews()
• \Illuminate\Database\Schema\Grammars\MySqlGrammar::compileTableExists()
• \Illuminate\Database\Schema\Grammars\MySqlGrammar::compileGetAllTables()
• \Illuminate\Database\Schema\Grammars\MySqlGrammar::compileGetAllViews()
• \Illuminate\Database\Schema\Grammars\PostgresGrammar::compileTableExists()
• \Illuminate\Database\Schema\Grammars\PostgresGrammar::compileGetAllTables()
• \Illuminate\Database\Schema\Grammars\PostgresGrammar::compileGetAllViews()
• \Illuminate\Database\Schema\Grammars\SQLiteGrammar::compileTableExists()
• \Illuminate\Database\Schema\Grammars\SQLiteGrammar::compileGetAllTables()
• \Illuminate\Database\Schema\Grammars\SQLiteGrammar::compileGetAllViews()
• \Illuminate\Database\Schema\Grammars\SqlServerGrammar::compileTableExists()
• \Illuminate\Database\Schema\Grammars\SqlServerGrammar::compileGetAllTables()
• \Illuminate\Database\Schema\Grammars\SqlServerGrammar::compileGetAllViews()

[morloderex]

@hafezdivandari Why are you multiplying by 8 specifically here?

[hafezdivandari]

Because each page is 8 KB according to docs.

[morloderex]

@hafezdivandari But why not just multiply by 8192 directly instead then?

[hafezdivandari]

because that's more readable and easier to understand imo.

[imanghafoori1]

I think this feature should have some integration tests, to engage real databases in the test.
@hafezdivandari

[hafezdivandari]

@imanghafoori1 done, thank you for your feedback. Added few tests for new methods, we already had many integration tests that engage changed functions, i.e. Schema::hasTable(), Schema::dropAllTables(), and Schema::dropAllViews().

[taylorotwell]

@hafezdivandari so do any of the Artisan commands that currently prompt for doctrine/dbal need to be updated?

[hafezdivandari]

@taylorotwell no this PR doesn't change anything on these commands, we are just adding what we need as series of PRs to 10.x to be able to remove doctrine/dbal on 11.x (PR #48864)

[crynobone]

@hafezdivandari Looks like this cause a breaking change in #49227

[hafezdivandari]

@crynobone Thanks for mentioning, I'll send a PR.

[amcsi]

This caused a breaking change; when doing this in SQLServer:

$hasTable = $schemaBuilder->hasTable('schema.table_name');

This used to return TRUE if that table name in that schema existed. Now it returns FALSE.

It seems like the new code checks just table_name against the passed schema.table_name string, not taking the schema into account at all.