feat(ISchemaWrapper): Add method to remove an autoincrement and cleanup

Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>

Author: CarlSchwan

lib/private/DB/SchemaWrapper.php

@@ -4,131 +4,118 @@
  * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
+
+declare(strict_types=1);
+
 namespace OC\DB;
 
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\Table;
 use OCP\DB\ISchemaWrapper;
+use Override;
 
 class SchemaWrapper implements ISchemaWrapper {
-	/** @var Connection */
-	protected $connection;
-
-	/** @var Schema */
-	protected $schema;
-
-	/** @var array */
-	protected $tablesToDelete = [];
-
-	public function __construct(Connection $connection, ?Schema $schema = null) {
-		$this->connection = $connection;
+	protected Schema $schema;
+	protected array $tablesToDelete = [];
+	/** @var list<string> */
+	protected $autoincrementsToDelete = [];
+
+	public function __construct(
+		protected readonly Connection $connection,
+		?Schema $schema = null,
+	) {
 		if ($schema) {
 			$this->schema = $schema;
 		} else {
 			$this->schema = $this->connection->createSchema();
 		}
 	}
 
-	public function getWrappedSchema() {
+	public function getWrappedSchema(): Schema {
 		return $this->schema;
 	}
 
-	public function performDropTableCalls() {
+	public function performDropTableCalls(): void {
 		foreach ($this->tablesToDelete as $tableName => $true) {
 			$this->connection->dropTable($tableName);
 			foreach ($this->connection->getShardConnections() as $shardConnection) {
 				$shardConnection->dropTable($tableName);
 			}
 			unset($this->tablesToDelete[$tableName]);
 		}
+
+		// Also delete auto-increments
+		$platform = $this->getDatabasePlatform();
+		if ($platform instanceof OraclePlatform) {
+			foreach ($this->autoincrementsToDelete as $tableName) {
+				/** @psalm-suppress InternalMethod */
+				$platform->getDropAutoincrementSql($tableName);
+			}
+			$this->autoincrementsToDelete = [];
+		}
 	}
 
-	/**
-	 * Gets all table names
-	 *
-	 * @return array
-	 */
-	public function getTableNamesWithoutPrefix() {
-		$tableNames = $this->schema->getTableNames();
-		return array_map(function ($tableName) {
+	#[Override]
+	public function getTableNamesWithoutPrefix(): array {
+		$tableNames = $this->schema->getTables();
+		return array_values(array_map(function (Table $table): string {
+			$tableName = $table->getName();
 			if (str_starts_with($tableName, $this->connection->getPrefix())) {
 				return substr($tableName, strlen($this->connection->getPrefix()));
 			}
 
 			return $tableName;
-		}, $tableNames);
+		}, $tableNames));
 	}
 
-	// Overwritten methods
-
-	/**
-	 * @return array
-	 */
-	public function getTableNames() {
-		return $this->schema->getTableNames();
+	#[Override]
+	public function getTableNames(): array {
+		$tableNames = $this->schema->getTables();
+		return array_values(array_map(fn (Table $table): string => $table->getName(), $tableNames));
 	}
 
-	/**
-	 * @param string $tableName
-	 *
-	 * @return \Doctrine\DBAL\Schema\Table
-	 * @throws \Doctrine\DBAL\Schema\SchemaException
-	 */
-	public function getTable($tableName) {
+	#[Override]
+	public function getTable(string $tableName) {
 		return $this->schema->getTable($this->connection->getPrefix() . $tableName);
 	}
 
-	/**
-	 * Does this schema have a table with the given name?
-	 *
-	 * @param string $tableName
-	 *
-	 * @return boolean
-	 */
-	public function hasTable($tableName) {
+	#[Override]
+	public function hasTable(string $tableName): bool {
 		return $this->schema->hasTable($this->connection->getPrefix() . $tableName);
 	}
 
-	/**
-	 * Creates a new table.
-	 *
-	 * @param string $tableName
-	 * @return \Doctrine\DBAL\Schema\Table
-	 */
-	public function createTable($tableName) {
+	#[Override]
+	public function createTable(string $tableName) {
 		unset($this->tablesToDelete[$tableName]);
 		return $this->schema->createTable($this->connection->getPrefix() . $tableName);
 	}
 
-	/**
-	 * Drops a table from the schema.
-	 *
-	 * @param string $tableName
-	 * @return \Doctrine\DBAL\Schema\Schema
-	 */
-	public function dropTable($tableName) {
+	#[Override]
+	public function dropTable(string $tableName): self {
 		$this->tablesToDelete[$tableName] = true;
-		return $this->schema->dropTable($this->connection->getPrefix() . $tableName);
+		$this->schema->dropTable($this->connection->getPrefix() . $tableName);
+		return $this;
 	}
 
-	/**
-	 * Gets all tables of this schema.
-	 *
-	 * @return \Doctrine\DBAL\Schema\Table[]
-	 */
-	public function getTables() {
+	#[Override]
+	public function getTables(): array {
 		return $this->schema->getTables();
 	}
 
-	/**
-	 * Gets the DatabasePlatform for the database.
-	 *
-	 * @return AbstractPlatform
-	 *
-	 * @throws Exception
-	 */
-	public function getDatabasePlatform() {
+	#[Override]
+	public function getDatabasePlatform(): AbstractPlatform {
 		return $this->connection->getDatabasePlatform();
 	}
+
+	#[Override]
+	public function dropAutoincrement(string $tableName, string $columnName): void {
+		if ($this->schema->hasTable($tableName)) {
+			$table = $this->schema->getTable($tableName);
+			$table->modifyColumn($columnName, ['autoincrement' => false]);
+		}
+
+		$this->autoincrementsToDelete[] = $tableName;
+	}
 }

lib/public/DB/ISchemaWrapper.php

@@ -8,6 +8,7 @@
 
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use OCP\AppFramework\Attribute\Consumable;
 
 /**
  * This interface allows to get information about the database schema.
@@ -19,6 +20,7 @@
  *
  * @since 13.0.0
  */
+#[Consumable(since: '13.0.0')]
 interface ISchemaWrapper {
 	/**
 	 * @param string $tableName
@@ -27,17 +29,16 @@ interface ISchemaWrapper {
 	 * @throws \Doctrine\DBAL\Schema\SchemaException
 	 * @since 13.0.0
 	 */
-	public function getTable($tableName);
+	public function getTable(string $tableName);
 
 	/**
 	 * Does this schema have a table with the given name?
 	 *
 	 * @param string $tableName Prefix is automatically prepended
 	 *
-	 * @return boolean
 	 * @since 13.0.0
 	 */
-	public function hasTable($tableName);
+	public function hasTable(string $tableName): bool;
 
 	/**
 	 * Creates a new table.
@@ -46,40 +47,39 @@ public function hasTable($tableName);
 	 * @return \Doctrine\DBAL\Schema\Table
 	 * @since 13.0.0
 	 */
-	public function createTable($tableName);
+	public function createTable(string $tableName);
 
 	/**
 	 * Drops a table from the schema.
 	 *
 	 * @param string $tableName Prefix is automatically prepended
-	 * @return \Doctrine\DBAL\Schema\Schema
 	 * @since 13.0.0
 	 */
-	public function dropTable($tableName);
+	public function dropTable(string $tableName): self;
 
 	/**
 	 * Gets all tables of this schema.
 	 *
 	 * @return \Doctrine\DBAL\Schema\Table[]
 	 * @since 13.0.0
 	 */
-	public function getTables();
+	public function getTables(): array;
 
 	/**
 	 * Gets all table names, prefixed with table prefix
 	 *
-	 * @return array
+	 * @return list<string>
 	 * @since 13.0.0
 	 */
-	public function getTableNames();
+	public function getTableNames(): array;
 
 	/**
 	 * Gets all table names
 	 *
-	 * @return array
+	 * @return list<string>
 	 * @since 13.0.0
 	 */
-	public function getTableNamesWithoutPrefix();
+	public function getTableNamesWithoutPrefix(): array;
 
 	/**
 	 * Gets the DatabasePlatform for the database.
@@ -89,5 +89,11 @@ public function getTableNamesWithoutPrefix();
 	 * @throws Exception
 	 * @since 23.0.0
 	 */
-	public function getDatabasePlatform();
+	public function getDatabasePlatform(): AbstractPlatform;
+
+	/**
+	 * Drop auto-increment on a table to port it to snowflake-ids.
+	 * @since 33.0.0
+	 */
+	public function dropAutoincrement(string $tableName, string $columnName): void;
 }