Merge pull request #5568 from morozov/pre-release-documentation

Mark remaining schema introspection platform methods as internal

UPGRADE.md

@@ -289,6 +289,14 @@ The following schema introspection methods have been deprecated:
 - `AbstractPlatform::getListTableIndexesSQL()`,
 - `AbstractPlatform::getListTableForeignKeysSQL()`.
 
+## `AbstractPlatform` schema introspection methods made internal
+
+The following schema introspection methods have been marked as internal:
+
+- `AbstractPlatform::getListDatabasesSQL()`,
+- `AbstractPlatform::getListSequencesSQL()`,
+- `AbstractPlatform::getListViewsSQL()`.
+
 The queries used for schema introspection are an internal implementation detail of the DBAL.
 
 ## Deprecated `collate` option for MySQL

src/Platforms/AbstractMySQLPlatform.php

@@ -143,6 +143,8 @@ public function getLengthExpression($column)
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListDatabasesSQL()
     {
@@ -182,6 +184,8 @@ public function getListTableIndexesSQL($table, $database = null)
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListViewsSQL($database)
     {

src/Platforms/AbstractPlatform.php

@@ -3444,6 +3444,8 @@ protected function _getTransactionIsolationLevelSQL($level)
     }
 
     /**
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
+     *
      * @return string
      *
      * @throws Exception If not supported on this platform.
@@ -3475,6 +3477,8 @@ public function getListNamespacesSQL()
     }
 
     /**
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
+     *
      * @param string $database
      *
      * @return string
@@ -3548,6 +3552,8 @@ public function getListUsersSQL()
     /**
      * 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.
+     *
      * @param string $database
      *
      * @return string

src/Platforms/DB2Platform.php

@@ -396,6 +396,8 @@ public function getListTablesSQL()
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListViewsSQL($database)
     {

src/Platforms/OraclePlatform.php

@@ -415,6 +415,8 @@ public function getClobTypeDeclarationSQL(array $column)
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListDatabasesSQL()
     {
@@ -423,6 +425,8 @@ public function getListDatabasesSQL()
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListSequencesSQL($database)
     {
@@ -518,6 +522,8 @@ public function getListTablesSQL()
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListViewsSQL($database)
     {

src/Platforms/PostgreSQLPlatform.php

@@ -266,6 +266,8 @@ public function hasNativeGuidType()
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListDatabasesSQL()
     {
@@ -294,6 +296,8 @@ public function getListNamespacesSQL()
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListSequencesSQL($database)
     {
@@ -326,6 +330,8 @@ public function getListTablesSQL()
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListViewsSQL($database)
     {

src/Platforms/SQLServerPlatform.php

@@ -190,6 +190,8 @@ public function getCreateSequenceSQL(Sequence $sequence): string
 
     /**
      * {@inheritdoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListSequencesSQL($database)
     {
@@ -1040,6 +1042,8 @@ public function getListTableIndexesSQL($table, $database = null)
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListViewsSQL($database)
     {
@@ -1137,6 +1141,8 @@ public function getConcatExpression()
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListDatabasesSQL()
     {

src/Platforms/SqlitePlatform.php

@@ -573,6 +573,8 @@ public function getListTablesSQL()
 
     /**
      * {@inheritDoc}
+     *
+     * @internal The method should be only used from within the {@see AbstractSchemaManager} class hierarchy.
      */
     public function getListViewsSQL($database)
     {