Optimize schema managers' ::listTables() methods

psalm.xml.dist

@@ -85,6 +85,10 @@
  TODO: remove in 4.0.0
  -->
  <referencedClass name="Doctrine\DBAL\Schema\Constraint"/>
+ <!--
+ TODO: remove in 4.0.0
+ -->
+ <referencedClass name="Doctrine\DBAL\Platforms\DatabaseIntrospectionSQLBuilder"/>
  </errorLevel>
  </DeprecatedInterface>
  <DeprecatedMethod>

src/Platforms/DatabaseIntrospectionSQLBuilder.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Doctrine\DBAL\Platforms;
+
+/**
+ * Database introspection SQL builder interface.
+ * Interface that DBAL platforms can implement when all database objects can be retrieved with a single metadata query.
+ *
+ * @deprecated The methods defined in this interface will be made part of the {@link AbstractPlatform} base class in
+ * the next major release.
+ */
+interface DatabaseIntrospectionSQLBuilder
+{
+ /**
+ * Returns the SQL to list all the columns of all the tables in the database.
+ */
+ public function getListDatabaseColumnsSQL(string $database): string;
+
+ /**
+ * Returns the SQL to list all the indexes in the database.
+ */
+ public function getListDatabaseIndexesSQL(string $database): string;
+
+ /**
+ * Returns the SQL to list all the foreign keys in the database.
+ */
+ public function getListDatabaseForeignKeysSQL(string $database): string;
+}

src/Platforms/OraclePlatform.php

@@ -15,6 +15,7 @@
 use InvalidArgumentException;
 
 use function array_merge;
+use function assert;
 use function count;
 use function explode;
 use function func_get_arg;
@@ -30,7 +31,7 @@
 /**
  * OraclePlatform.
  */
-class OraclePlatform extends AbstractPlatform
+class OraclePlatform extends AbstractPlatform implements DatabaseIntrospectionSQLBuilder
 {
  /**
  * Assertion for Oracle identifiers.
@@ -431,43 +432,65 @@ protected function _getCreateTableSQL($name, array $columns, array $options = []
  return $sql;
  }
 
+ public function getListDatabaseIndexesSQL(string $database): string
+ {
+ return $this->getListIndexesSQL($database);
+ }
+
  /**
  * {@inheritDoc}
  *
  * @link http://ezcomponents.org/docs/api/trunk/DatabaseSchema/ezcDbSchemaOracleReader.html
  */
  public function getListTableIndexesSQL($table, $database = null)
  {
- $table = $this->normalizeIdentifier($table);
- $table = $this->quoteStringLiteral($table->getName());
+ return $this->getListIndexesSQL($database, $table);
+ }
+
+ private function getListIndexesSQL(?string $database, ?string $table = null): string
+ {
+ $conditions = [];
 
- return "SELECT uind_col.index_name AS name,
- (
- SELECT uind.index_type
- FROM user_indexes uind
- WHERE uind.index_name = uind_col.index_name
- ) AS type,
- decode(
- (
- SELECT uind.uniqueness
- FROM user_indexes uind
- WHERE uind.index_name = uind_col.index_name
- ),
- 'NONUNIQUE',
- 0,
- 'UNIQUE',
- 1
- ) AS is_unique,
- uind_col.column_name AS column_name,
- uind_col.column_position AS column_pos,
- (
- SELECT ucon.constraint_type
- FROM user_constraints ucon
- WHERE ucon.index_name = uind_col.index_name
- ) AS is_primary
- FROM user_ind_columns uind_col
- WHERE uind_col.table_name = " . $table . '
- ORDER BY uind_col.column_position ASC';
+ $sql = <<<SQL
+ SELECT ind_col.table_name,
+ ind_col.index_name AS name,
+ ind.index_type AS type,
+ decode(ind.uniqueness, 'NONUNIQUE', 0, 'UNIQUE', 1) AS is_unique,
+ ind_col.column_name AS column_name,
+ ind_col.column_position AS column_pos,
+ con.constraint_type AS is_primary
+SQL;
+
+ if (isset($database)) {
+ $sql .= <<<SQL
+ FROM all_ind_columns ind_col
+ LEFT JOIN all_indexes ind ON ind.owner = ind_col.index_owner AND ind.index_name = ind_col.index_name
+ LEFT JOIN all_constraints con ON con.owner = ind_col.index_owner AND con.index_name = ind_col.index_name
+SQL;
+ $conditions[] = 'ind_col.index_owner = ' . $this->quoteStringLiteral(
+ $this->normalizeIdentifier($database)->getName()
+ );
+ if (isset($table)) {
+ $conditions[] = 'ind_col.table_name = ' . $this->quoteStringLiteral(
+ $this->normalizeIdentifier($table)->getName()
+ );
+ }
+ } else {
+ $sql .= <<<SQL
+ FROM user_ind_columns ind_col
+ LEFT JOIN user_indexes ind ON ind.owner = ind_col.index_owner AND ind.index_name = ind_col.index_name
+ LEFT JOIN user_constraints con ON con.owner = ind_col.index_owner AND con.index_name = ind_col.index_name
+SQL;
+ assert(isset($table));
+ $conditions[] = 'ind_col.table_name = ' . $this->quoteStringLiteral(
+ $this->normalizeIdentifier($table)->getName()
+ );
+ }
+
+ $sql .= ' WHERE ' . implode(' AND ', $conditions);
+ $sql .= ' ORDER BY ind_col.table_name, ind_col.index_name, ind_col.column_position';
+
+ return $sql;
  }
 
  /**
@@ -632,36 +655,69 @@ private function getAutoincrementIdentifierName(Identifier $table)
  : $identifierName;
  }
 
+ public function getListDatabaseForeignKeysSQL(string $database): string
+ {
+ return $this->getListForeignKeysSQL($database);
+ }
+
  /**
  * {@inheritDoc}
  */
  public function getListTableForeignKeysSQL($table)
  {
- $table = $this->normalizeIdentifier($table);
- $table = $this->quoteStringLiteral($table->getName());
+ return $this->getListForeignKeysSQL(null, $table);
+ }
+
+ private function getListForeignKeysSQL(?string $database, ?string $table = null): string
+ {
+ $conditions = [];
+
+ $sql = <<<SQL
+ SELECT cols.table_name,
+ alc.constraint_name,
+ alc.DELETE_RULE,
+ cols.column_name "local_column",
+ cols.position,
+ r_cols.table_name "references_table",
+ r_cols.column_name "foreign_column"
+SQL;
 
- return "SELECT alc.constraint_name,
- alc.DELETE_RULE,
- cols.column_name \"local_column\",
- cols.position,
- (
- SELECT r_cols.table_name
- FROM user_cons_columns r_cols
- WHERE alc.r_constraint_name = r_cols.constraint_name
- AND r_cols.position = cols.position
- ) AS \"references_table\",
- (
- SELECT r_cols.column_name
- FROM user_cons_columns r_cols
- WHERE alc.r_constraint_name = r_cols.constraint_name
- AND r_cols.position = cols.position
- ) AS \"foreign_column\"
- FROM user_cons_columns cols
- JOIN user_constraints alc
- ON alc.constraint_name = cols.constraint_name
- AND alc.constraint_type = 'R'
- AND alc.table_name = " . $table . '
- ORDER BY cols.constraint_name ASC, cols.position ASC';
+ if (isset($database)) {
+ $sql .= <<<SQL
+ FROM all_cons_columns cols
+ LEFT JOIN all_constraints alc ON alc.owner = cols.owner AND alc.constraint_name = cols.constraint_name
+ LEFT JOIN all_cons_columns r_cols ON r_cols.owner = alc.r_owner AND
+ r_cols.constraint_name = alc.r_constraint_name AND
+ r_cols.position = cols.position
+SQL;
+ $conditions[] = 'cols.owner = ' . $this->quoteStringLiteral(
+ $this->normalizeIdentifier($database)->getName()
+ );
+ if (isset($table)) {
+ $conditions[] = 'cols.table_name = ' . $this->quoteStringLiteral(
+ $this->normalizeIdentifier($table)->getName()
+ );
+ }
+ } else {
+ assert(isset($table));
+ $sql .= <<<SQL
+ FROM user_cons_columns cols
+ LEFT JOIN user_constraints alc ON alc.owner = cols.owner AND alc.constraint_name = cols.constraint_name
+ LEFT JOIN user_cons_columns r_cols ON r_cols.owner = alc.r_owner AND
+ r_cols.constraint_name = alc.r_constraint_name AND
+ r_cols.position = cols.position
+SQL;
+ $conditions[] = 'cols.table_name = ' . $this->quoteStringLiteral(
+ $this->normalizeIdentifier($table)->getName()
+ );
+ }
+
+ $conditions[] = "alc.constraint_type = 'R'";
+
+ $sql .= ' WHERE ' . implode(' AND ', $conditions);
+ $sql .= ' ORDER BY cols.table_name, cols.constraint_name, cols.position';
+
+ return $sql;
  }
 
  /**
@@ -675,48 +731,55 @@ public function getListTableConstraintsSQL($table)
  return 'SELECT * FROM user_constraints WHERE table_name = ' . $table;
  }
 
+ public function getListDatabaseColumnsSQL(string $database): string
+ {
+ return $this->getListColumnsSQL($database);
+ }
+
  /**
  * {@inheritDoc}
  */
  public function getListTableColumnsSQL($table, $database = null)
  {
- $table = $this->normalizeIdentifier($table);
- $table = $this->quoteStringLiteral($table->getName());
+ return $this->getListColumnsSQL($database, $table);
+ }
+
+ private function getListColumnsSQL(?string $database, ?string $table = null): string
+ {
+ $conditions = [];
 
- $tabColumnsTableName = 'user_tab_columns';
- $colCommentsTableName = 'user_col_comments';
- $tabColumnsOwnerCondition = '';
- $colCommentsOwnerCondition = '';
+ $sql = 'SELECT c.table_name, c.*, d.comments AS comments ';
 
- if ($database !== null && $database !== '/') {
- $database = $this->normalizeIdentifier($database);
- $database = $this->quoteStringLiteral($database->getName());
- $tabColumnsTableName = 'all_tab_columns';
- $colCommentsTableName = 'all_col_comments';
- $tabColumnsOwnerCondition = ' AND c.owner = ' . $database;
- $colCommentsOwnerCondition = ' AND d.OWNER = c.OWNER';
+ if (isset($database)) {
+ $sql .= <<<SQL
+ FROM all_tab_columns c
+ LEFT JOIN all_col_comments d ON d.OWNER = c.OWNER AND d.TABLE_NAME = c.TABLE_NAME AND
+ d.COLUMN_NAME = c.COLUMN_NAME
+SQL;
+ $conditions[] = 'c.owner = ' . $this->quoteStringLiteral(
+ $this->normalizeIdentifier($database)->getName()
+ );
+ if (isset($table)) {
+ $conditions[] = 'c.table_name = ' . $this->quoteStringLiteral(
+ $this->normalizeIdentifier($table)->getName()
+ );
+ }
+ } else {
+ assert(isset($table));
+ $sql .= <<<SQL
+ FROM user_tab_columns c
+ LEFT JOIN user_col_comments d ON d.OWNER = c.OWNER AND d.TABLE_NAME = c.TABLE_NAME AND
+ d.COLUMN_NAME = c.COLUMN_NAME
+SQL;
+ $conditions[] = 'c.table_name = ' . $this->quoteStringLiteral(
+ $this->normalizeIdentifier($table)->getName()
+ );
  }
 
- return sprintf(
- <<<'SQL'
-SELECT c.*,
- (
- SELECT d.comments
- FROM %s d
- WHERE d.TABLE_NAME = c.TABLE_NAME%s
- AND d.COLUMN_NAME = c.COLUMN_NAME
- ) AS comments
-FROM %s c
-WHERE c.table_name = %s%s
-ORDER BY c.column_id
-SQL
- ,
- $colCommentsTableName,
- $colCommentsOwnerCondition,
- $tabColumnsTableName,
- $table,
- $tabColumnsOwnerCondition
- );
+ $sql .= ' WHERE ' . implode(' AND ', $conditions);
+ $sql .= ' ORDER BY c.table_name, c.column_id';
+
+ return $sql;
  }
 
  /**