Remove Connection::$_schemaManager

UPGRADE.md

@@ -1,5 +1,9 @@
 # Upgrade to 4.0
 
+## BC BREAK: Removed `Connection::$_schemaManager` property
+
+The `Connection` and `AbstractSchemaManager` classes used to have a reference on each other effectively making a circular reference. Use `getSchemaManager()` to instantiate a schema manager.
+
 ## BC BREAK: Removed `Connection::$_expr` property
 
 The `Connection` and `ExpressionBuilder` classes used to have a reference on each other effectively making a circular reference. Use `getExpressionBuilder()` to instantiate an expression builder.

docs/en/reference/schema-manager.rst

@@ -5,15 +5,15 @@ A Schema Manager instance helps you with the abstraction of the
 generation of SQL assets such as Tables, Sequences, Foreign Keys
 and Indexes.
 
-To retrieve the ``SchemaManager`` for your connection you can use
-the ``getSchemaManager()`` method:
+To instantiate a ``SchemaManager`` for your connection you can use
+the ``createSchemaManager()`` method:
 
 .. code-block:: php
 
     <?php
-    $sm = $conn->getSchemaManager();
+    $schemaManager = $conn->createSchemaManager();
 
-Now with the ``SchemaManager`` instance in ``$sm`` you can use the
+Now with the ``SchemaManager`` instance in ``$schemaManager`` you can use the
 available methods to learn about your database schema:
 
 .. note::

src/Connection.php

@@ -126,15 +126,6 @@ class Connection
     /** @var Parser|null */
     private $parser;
 
-    /**
-     * The schema manager.
-     *
-     * @deprecated Use {@link createSchemaManager()} instead.
-     *
-     * @var AbstractSchemaManager|null
-     */
-    protected $_schemaManager;
-
     /**
      * The used DBAL driver.
      *
@@ -1420,23 +1411,6 @@ public function createSchemaManager(): AbstractSchemaManager
         );
     }
 
-    /**
-     * Gets the SchemaManager that can be used to inspect or change the
-     * database schema through the connection.
-     *
-     * @deprecated Use {@link createSchemaManager()} instead.
-     *
-     * @throws Exception
-     */
-    public function getSchemaManager(): AbstractSchemaManager
-    {
-        if ($this->_schemaManager === null) {
-            $this->_schemaManager = $this->createSchemaManager();
-        }
-
-        return $this->_schemaManager;
-    }
-
     /**
      * Marks the current transaction so that the only possible
      * outcome for the transaction to be rolled back.

src/Tools/Console/Command/ReservedWordsCommand.php

@@ -153,7 +153,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             true
         );
 
-        $schema  = $conn->getSchemaManager()->createSchema();
+        $schema  = $conn->createSchemaManager()->createSchema();
         $visitor = new ReservedKeywordsValidator($keywords);
         $schema->visit($visitor);
 

tests/Functional/BlobTest.php

@@ -33,7 +33,7 @@ protected function setUp(): void
         $table->addColumn('blobcolumn', 'blob');
         $table->setPrimaryKey(['id']);
 
-        $sm = $this->connection->getSchemaManager();
+        $sm = $this->connection->createSchemaManager();
         $sm->dropAndCreateTable($table);
     }
 

tests/Functional/DataAccessTest.php

@@ -44,7 +44,7 @@ protected function setUp(): void
         $table->addColumn('test_datetime', 'datetime', ['notnull' => false]);
         $table->setPrimaryKey(['test_int']);
 
-        $sm = $this->connection->getSchemaManager();
+        $sm = $this->connection->createSchemaManager();
         $sm->createTable($table);
 
         $this->connection->insert('fetch_table', [
@@ -742,7 +742,7 @@ public function testSqliteDateArithmeticWithDynamicInterval(): void
         $table->addColumn('test_days', 'integer');
         $table->setPrimaryKey(['test_date']);
 
-        $sm = $this->connection->getSchemaManager();
+        $sm = $this->connection->createSchemaManager();
         $sm->createTable($table);
 
         $this->connection->insert('fetch_table_date_math', ['test_date' => '2010-01-01', 'test_days' => 10]);

tests/Functional/Driver/OCI8/ConnectionTest.php

@@ -27,7 +27,7 @@ protected function setUp(): void
     public function testLastInsertIdAcceptsFqn(): void
     {
         $platform      = $this->connection->getDatabasePlatform();
-        $schemaManager = $this->connection->getSchemaManager();
+        $schemaManager = $this->connection->createSchemaManager();
 
         $table = new Table('DBAL2595');
         $table->addColumn('id', 'integer', ['autoincrement' => true]);

tests/Functional/ExceptionTest.php

@@ -58,7 +58,7 @@ public function testPrimaryConstraintViolationException(): void
         $table->addColumn('id', 'integer', []);
         $table->setPrimaryKey(['id']);
 
-        $this->connection->getSchemaManager()->createTable($table);
+        $this->connection->createSchemaManager()->createTable($table);
 
         $this->connection->insert('duplicatekey_table', ['id' => 1]);
 
@@ -76,7 +76,7 @@ public function testTableNotFoundException(): void
 
     public function testTableExistsException(): void
     {
-        $schemaManager = $this->connection->getSchemaManager();
+        $schemaManager = $this->connection->createSchemaManager();
         $table         = new Table('alreadyexist_table');
         $table->addColumn('id', 'integer', []);
         $table->setPrimaryKey(['id']);
@@ -160,7 +160,7 @@ public function testSyntaxErrorException(): void
         $table->addColumn('id', 'integer', []);
         $table->setPrimaryKey(['id']);
 
-        $this->connection->getSchemaManager()->createTable($table);
+        $this->connection->createSchemaManager()->createTable($table);
 
         $sql = 'SELECT id FRO syntax_error_table';
         $this->expectException(Exception\SyntaxErrorException::class);

tests/Functional/ForeignKeyExceptionTest.php

@@ -23,7 +23,7 @@ protected function setUp(): void
             self::markTestSkipped('Driver does not support special exception handling.');
         }
 
-        $schemaManager = $this->connection->getSchemaManager();
+        $schemaManager = $this->connection->createSchemaManager();
 
         $table = new Table('constraint_error_table');
         $table->addColumn('id', 'integer', []);
@@ -43,7 +43,7 @@ protected function tearDown(): void
     {
         parent::tearDown();
 
-        $schemaManager = $this->connection->getSchemaManager();
+        $schemaManager = $this->connection->createSchemaManager();
 
         $schemaManager->dropTable('owning_table');
         $schemaManager->dropTable('constraint_error_table');

tests/Functional/LegacyAPITest.php

@@ -25,7 +25,7 @@ protected function setUp(): void
         $table->addColumn('test_string', 'string', ['length' => 3]);
         $table->setPrimaryKey(['test_int']);
 
-        $sm = $this->connection->getSchemaManager();
+        $sm = $this->connection->createSchemaManager();
         $sm->dropAndCreateTable($table);
 
         $this->connection->insert('legacy_table', [

tests/Functional/LockMode/NoneTest.php

@@ -44,11 +44,11 @@ public function setUp(): void
         $table->addColumn('id', 'integer');
         $table->setPrimaryKey(['id']);
 
-        $this->connection->getSchemaManager()->dropAndCreateTable($table);
+        $this->connection->createSchemaManager()->dropAndCreateTable($table);
 
         $this->connection2 = TestUtil::getConnection();
 
-        if ($this->connection2->getSchemaManager()->tableExists('users')) {
+        if ($this->connection2->createSchemaManager()->tableExists('users')) {
             return;
         }
 
@@ -69,7 +69,7 @@ public function tearDown(): void
 
         $this->connection2->close();
 
-        $this->connection->getSchemaManager()->dropTable('users');
+        $this->connection->createSchemaManager()->dropTable('users');
 
         if (! $this->connection->getDatabasePlatform() instanceof SQLServer2012Platform) {
             return;

tests/Functional/ModifyLimitQueryTest.php

@@ -34,7 +34,7 @@ protected function setUp(): void
             $table2->addColumn('test_int', 'integer');
             $table2->setPrimaryKey(['id']);
 
-            $sm = $this->connection->getSchemaManager();
+            $sm = $this->connection->createSchemaManager();
             $sm->createTable($table);
             $sm->createTable($table2);
             self::$tableCreated = true;

tests/Functional/NamedParametersTest.php

@@ -154,7 +154,7 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        if ($this->connection->getSchemaManager()->tableExists('ddc1372_foobar')) {
+        if ($this->connection->createSchemaManager()->tableExists('ddc1372_foobar')) {
             return;
         }
 
@@ -165,7 +165,7 @@ protected function setUp(): void
             $table->addColumn('bar', 'string', ['length' => 1]);
             $table->setPrimaryKey(['id']);
 
-            $sm = $this->connection->getSchemaManager();
+            $sm = $this->connection->createSchemaManager();
             $sm->createTable($table);
 
             $this->connection->insert('ddc1372_foobar', [

tests/Functional/Platform/AddColumnWithDefaultTest.php

@@ -15,7 +15,7 @@ class AddColumnWithDefaultTest extends FunctionalTestCase
 {
     public function testAddColumnWithDefault(): void
     {
-        $schemaManager = $this->connection->getSchemaManager();
+        $schemaManager = $this->connection->createSchemaManager();
 
         $table = new Table('add_default_test');
 

tests/Functional/Platform/ColumnTest.php

@@ -108,7 +108,7 @@ protected function assertColumn(string $type, array $column, string $value, int
         $table = new Table('column_test');
         $table->addColumn('val', $type, $column);
 
-        $sm = $this->connection->getSchemaManager();
+        $sm = $this->connection->createSchemaManager();
         $sm->dropAndCreateTable($table);
 
         self::assertSame(1, $this->connection->insert('column_test', ['val' => $value], [$bindType]));

tests/Functional/Platform/DateExpressionTest.php

@@ -20,7 +20,7 @@ public function testDifference(string $date1, string $date2, int $expected): voi
         $table = new Table('date_expr_test');
         $table->addColumn('date1', 'datetime');
         $table->addColumn('date2', 'datetime');
-        $this->connection->getSchemaManager()->dropAndCreateTable($table);
+        $this->connection->createSchemaManager()->dropAndCreateTable($table);
         $this->connection->insert('date_expr_test', [
             'date1' => $date1,
             'date2' => $date2,

tests/Functional/Platform/DefaultExpressionTest.php

@@ -60,7 +60,7 @@ private function assertDefaultExpression(string $type, callable $expression): vo
         $table = new Table('default_expr_test');
         $table->addColumn('actual_value', $type);
         $table->addColumn('default_value', $type, ['default' => $defaultSql]);
-        $this->connection->getSchemaManager()->dropAndCreateTable($table);
+        $this->connection->createSchemaManager()->dropAndCreateTable($table);
 
         $this->connection->executeStatement(
             sprintf(

tests/Functional/Platform/NewPrimaryKeyWithNewAutoIncrementColumnTest.php

@@ -34,7 +34,7 @@ protected function setUp(): void
      */
     public function testAlterPrimaryKeyToAutoIncrementColumn(): void
     {
-        $schemaManager = $this->connection->getSchemaManager();
+        $schemaManager = $this->connection->createSchemaManager();
         $schema        = $schemaManager->createSchema();
 
         $table = $schema->createTable('dbal2807');

tests/Functional/Platform/PlatformRestrictionsTest.php

@@ -27,8 +27,8 @@ public function testMaxIdentifierLengthLimitWithAutoIncrement(): void
         $table      = new Table($tableName);
         $table->addColumn($columnName, 'integer', ['autoincrement' => true]);
         $table->setPrimaryKey([$columnName]);
-        $this->connection->getSchemaManager()->dropAndCreateTable($table);
-        $createdTable = $this->connection->getSchemaManager()->listTableDetails($tableName);
+        $this->connection->createSchemaManager()->dropAndCreateTable($table);
+        $createdTable = $this->connection->createSchemaManager()->listTableDetails($tableName);
 
         self::assertTrue($createdTable->hasColumn($columnName));
         self::assertTrue($createdTable->hasPrimaryKey());

tests/Functional/PortabilityTest.php

@@ -39,7 +39,7 @@ protected function setUp(): void
         $table->setPrimaryKey(['Test_Int']);
 
         try {
-            $sm = $this->connection->getSchemaManager();
+            $sm = $this->connection->createSchemaManager();
             $sm->createTable($table);
 
             $this->connection->insert('portability_table', [

tests/Functional/PrimaryReadReplicaConnectionTest.php

@@ -36,7 +36,7 @@ protected function setUp(): void
             $table->addColumn('test_int', 'integer');
             $table->setPrimaryKey(['test_int']);
 
-            $sm = $this->connection->getSchemaManager();
+            $sm = $this->connection->createSchemaManager();
             $sm->createTable($table);
         } catch (Throwable $e) {
         }

tests/Functional/ResultCacheTest.php

@@ -42,7 +42,7 @@ protected function setUp(): void
         ]);
         $table->setPrimaryKey(['test_int']);
 
-        $sm = $this->connection->getSchemaManager();
+        $sm = $this->connection->createSchemaManager();
         $sm->dropAndCreateTable($table);
 
         foreach ($this->expectedResult as $row) {

tests/Functional/Schema/ColumnCommentTest.php

@@ -33,7 +33,7 @@ protected function setUp(): void
             $table->addColumn($name, $type, $options);
         }
 
-        $this->connection->getSchemaManager()
+        $this->connection->createSchemaManager()
             ->dropAndCreateTable($table);
     }
 
@@ -92,7 +92,7 @@ public function testAlterColumnComment(string $comment1, string $comment2): void
         $table1 = new Table('column_comments');
         $table1->addColumn('id', 'integer', ['comment' => $comment1]);
 
-        $this->connection->getSchemaManager()
+        $this->connection->createSchemaManager()
             ->dropAndCreateTable($table1);
 
         $table2 = clone $table1;
@@ -101,7 +101,7 @@ public function testAlterColumnComment(string $comment1, string $comment2): void
         $diff = (new Comparator())->diffTable($table1, $table2);
         self::assertNotNull($diff);
 
-        $sm = $this->connection->getSchemaManager();
+        $sm = $this->connection->createSchemaManager();
         $sm->alterTable($diff);
 
         $this->assertColumnComment('column_comments', 'id', $comment2);
@@ -125,7 +125,7 @@ private function assertColumnComment(string $table, string $column, string $expe
     {
         self::assertSame(
             $expectedComment,
-            $this->connection->getSchemaManager()
+            $this->connection->createSchemaManager()
                 ->listTableDetails($table)
                 ->getColumn($column)
                 ->getComment()

tests/Functional/Schema/ComparatorTest.php

@@ -21,7 +21,7 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        $this->schemaManager = $this->connection->getSchemaManager();
+        $this->schemaManager = $this->connection->createSchemaManager();
         $this->comparator    = new Comparator();
     }
 

tests/Functional/Schema/DefaultValueTest.php

@@ -35,7 +35,7 @@ protected function setUp(): void
             ]);
         }
 
-        $this->connection->getSchemaManager()
+        $this->connection->createSchemaManager()
             ->dropAndCreateTable($table);
 
         $this->connection->insert('default_value', ['id' => 1]);
@@ -49,7 +49,7 @@ public function testEscapedDefaultValueCanBeIntrospected(string $name, ?string $
         self::assertSame(
             $expectedDefault,
             $this->connection
-                ->getSchemaManager()
+                ->createSchemaManager()
                 ->listTableDetails('default_value')
                 ->getColumn($name)
                 ->getDefault()

tests/Functional/Schema/MySQLSchemaManagerTest.php

@@ -560,7 +560,7 @@ public function testListTableColumnsThrowsDatabaseRequired(): void
         unset($params['dbname']);
 
         $connection    = DriverManager::getConnection($params);
-        $schemaManager = $connection->getSchemaManager();
+        $schemaManager = $connection->createSchemaManager();
 
         $this->expectException(DatabaseRequired::class);
         $this->expectExceptionMessage(

tests/Functional/Schema/OracleSchemaManagerTest.php

@@ -117,7 +117,7 @@ public function testAlterTableColumnNotNull(): void
     public function testListDatabases(): void
     {
         // We need a privileged connection to create the database.
-        $sm = TestUtil::getPrivilegedConnection()->getSchemaManager();
+        $sm = TestUtil::getPrivilegedConnection()->createSchemaManager();
 
         $sm->dropAndCreateDatabase('c##test_create_database');
 
@@ -248,7 +248,7 @@ public function testListTableColumnsSameTableNamesInDifferentSchemas(): void
 
         $otherTable = new Table($table->getName());
         $otherTable->addColumn('id', Types::STRING, ['length' => 32]);
-        TestUtil::getPrivilegedConnection()->getSchemaManager()->dropAndCreateTable($otherTable);
+        TestUtil::getPrivilegedConnection()->createSchemaManager()->dropAndCreateTable($otherTable);
 
         $columns = $this->schemaManager->listTableColumns($table->getName(), $this->connection->getDatabase());
         self::assertCount(7, $columns);