Remove deprecated schema introspection API

Author: morozov

UPGRADE.md

@@ -8,6 +8,19 @@ awareness about deprecated code.
 
 # Upgrade to 5.0
 
+## BC BREAK: Removed `AbstractSchemaManager` methods
+
+The following `AbstractSchemaManager` methods have been removed:
+1. `listDatabases()`
+2. `listSchemaNames()`
+3. `listTableNames()`
+4. `listTableColumns()`
+5. `listTableIndexes()`
+6. `listTableForeignKeys()`
+7. `listTables()`
+8. `listViews()`
+9. `listSequences()`
+
 ## BC BREAK: changes in `Table` class
 
 The `Table` class no longer accepts `foreignKeyConstraints`

phpstan.neon.dist

@@ -47,7 +47,6 @@ parameters:
             paths:
                 - src/Platforms/*MetadataProvider.php
                 - src/Platforms/*Platform.php
-                - src/Schema/*SchemaManager.php
 
         # Some APIs use variable method calls internally
         -

src/Platforms/AbstractMySQLPlatform.php

@@ -112,18 +112,6 @@ public function getLengthExpression(string $string): string
         return 'CHAR_LENGTH(' . $string . ')';
     }
 
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListDatabasesSQL(): string
-    {
-        return 'SHOW DATABASES';
-    }
-
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListViewsSQL(string $database): string
-    {
-        return 'SELECT * FROM information_schema.VIEWS WHERE TABLE_SCHEMA = ' . $this->quoteStringLiteral($database);
-    }
-
     /**
      * {@inheritDoc}
      */

src/Platforms/AbstractPlatform.php

@@ -1786,25 +1786,6 @@ protected function _getTransactionIsolationLevelSQL(TransactionIsolationLevel $l
         };
     }
 
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListDatabasesSQL(): string
-    {
-        throw NotSupported::new(__METHOD__);
-    }
-
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListSequencesSQL(string $database): string
-    {
-        throw NotSupported::new(__METHOD__);
-    }
-
-    /**
-     * Returns the SQL to list all views of a database or user.
-     *
-     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
-     */
-    abstract public function getListViewsSQL(string $database): string;
-
     public function getCreateViewSQL(string $name, string $sql): string
     {
         return 'CREATE VIEW ' . $name . ' AS ' . $sql;
@@ -2222,10 +2203,7 @@ public function getUnquotedIdentifierFolding(): UnquotedIdentifierFolding
      *
      * @throws Exception
      */
-    public function createMetadataProvider(Connection $connection): MetadataProvider
-    {
-        throw NotSupported::new(__METHOD__);
-    }
+    abstract public function createMetadataProvider(Connection $connection): MetadataProvider;
 
     /**
      * Creates the schema manager that can be used to inspect and change the underlying

src/Platforms/DB2Platform.php

@@ -204,12 +204,6 @@ public function getSetTransactionIsolationSQL(TransactionIsolationLevel $level):
         throw NotSupported::new(__METHOD__);
     }
 
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListViewsSQL(string $database): string
-    {
-        return 'SELECT NAME, TEXT FROM SYSIBM.SYSVIEWS';
-    }
-
     protected function getPrimaryKeyConstraintDeclarationSQL(PrimaryKeyConstraint $constraint): string
     {
         $this->ensurePrimaryKeyConstraintIsClustered($constraint);

src/Platforms/OraclePlatform.php

@@ -295,19 +295,6 @@ public function getClobTypeDeclarationSQL(array $column): string
         return 'CLOB';
     }
 
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListDatabasesSQL(): string
-    {
-        return 'SELECT username FROM all_users';
-    }
-
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListSequencesSQL(string $database): string
-    {
-        return 'SELECT SEQUENCE_NAME, MIN_VALUE, INCREMENT_BY FROM SYS.ALL_SEQUENCES WHERE SEQUENCE_OWNER = '
-            . $this->quoteStringLiteral($database);
-    }
-
     /**
      * {@inheritDoc}
      */
@@ -347,12 +334,6 @@ public function getCreateIndexSQL(Index $index, string $table): string
         return parent::getCreateIndexSQL($index, $table);
     }
 
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListViewsSQL(string $database): string
-    {
-        return 'SELECT view_name, text FROM sys.user_views';
-    }
-
     /** @return list<string> */
     private function getCreateAutoincrementSql(OptionallyQualifiedName $tableName, UnqualifiedName $columnName): array
     {

src/Platforms/PostgreSQLPlatform.php

@@ -141,35 +141,6 @@ protected function supportsCommentOnStatement(): bool
         return true;
     }
 
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListDatabasesSQL(): string
-    {
-        return 'SELECT datname FROM pg_database';
-    }
-
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListSequencesSQL(string $database): string
-    {
-        return 'SELECT sequence_name,
-                       sequence_schema,
-                       minimum_value,
-                       increment
-                FROM   information_schema.sequences
-                WHERE  sequence_catalog = ' . $this->quoteStringLiteral($database) . "
-                AND    sequence_schema NOT LIKE 'pg\_%'
-                AND    sequence_schema != 'information_schema'";
-    }
-
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListViewsSQL(string $database): string
-    {
-        return 'SELECT table_name,
-                       table_schema,
-                       view_definition
-                FROM   information_schema.views
-                WHERE  view_definition IS NOT NULL';
-    }
-
     protected function getPrimaryKeyConstraintDeclarationSQL(PrimaryKeyConstraint $constraint): string
     {
         $this->ensurePrimaryKeyConstraintIsClustered($constraint);

src/Platforms/SQLServerPlatform.php

@@ -150,22 +150,6 @@ public function getCreateSequenceSQL(Sequence $sequence): string
             ' MINVALUE ' . $sequence->getInitialValue();
     }
 
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListSequencesSQL(string $database): string
-    {
-        return 'SELECT seq.name,
-                       scm.name AS schema_name,
-                       CAST(
-                           seq.increment AS VARCHAR(MAX)
-                       ) AS increment, -- CAST avoids driver error for sql_variant type
-                       CAST(
-                           seq.start_value AS VARCHAR(MAX)
-                       ) AS start_value -- CAST avoids driver error for sql_variant type
-                FROM   sys.sequences AS seq
-                JOIN   sys.schemas AS scm
-                ON     scm.schema_id = seq.schema_id';
-    }
-
     public function getSequenceNextValSQL(string $sequence): string
     {
         return 'SELECT NEXT VALUE FOR ' . $sequence;
@@ -718,14 +702,6 @@ public function getEmptyIdentityInsertSQL(string $quotedTableName, string $quote
         return 'INSERT INTO ' . $quotedTableName . ' DEFAULT VALUES';
     }
 
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListViewsSQL(string $database): string
-    {
-        return "SELECT name, definition FROM sysobjects
-                    INNER JOIN sys.sql_modules ON sysobjects.id = sys.sql_modules.object_id
-                WHERE type = 'V' ORDER BY name";
-    }
-
     public function getLocateExpression(string $string, string $substring, ?string $start = null): string
     {
         if ($start === null) {
@@ -774,12 +750,6 @@ public function getConcatExpression(string ...$string): string
         return sprintf('CONCAT(%s)', implode(', ', $string));
     }
 
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListDatabasesSQL(): string
-    {
-        return 'SELECT * FROM sys.databases';
-    }
-
     public function getSubstringExpression(string $string, string $start, ?string $length = null): string
     {
         if ($length === null) {

src/Platforms/SQLitePlatform.php

@@ -376,12 +376,6 @@ public function getClobTypeDeclarationSQL(array $column): string
         return 'CLOB';
     }
 
-    /** @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy. */
-    public function getListViewsSQL(string $database): string
-    {
-        return "SELECT name, sql FROM sqlite_master WHERE type='view' AND sql NOT NULL";
-    }
-
     protected function getPrimaryKeyConstraintDeclarationSQL(PrimaryKeyConstraint $constraint): string
     {
         $this->ensurePrimaryKeyConstraintIsNotNamed($constraint);