feat(db): introduce a ignoreConflictsOnInsert method on the QueryBuilder

Since the DB adapters insertIgnoreConflict methods are using the conn directly to alter the produced
SQL, bypassing the ShardedQueryBuilder logic, hinting for sharded keys didn't work. We need to
expose to the QueryBuilder the information that we want to ignore conflicts, and how to handle it.

Signed-off-by: Thomas Citharel <tcit@tcit.fr>

Author: tcitworld

lib/private/DB/Adapter.php

@@ -129,4 +129,8 @@ public function insertIgnoreConflict(string $table, array $values, array $hintSh
 			throw $e;
 		}
 	}
+
+	public function getInsertIgnoreSqlTransformer(): ?callable {
+		return null;
+	}
 }

lib/private/DB/AdapterMySQL.php

@@ -47,23 +47,22 @@ public function insertIgnoreConflict(string $table, array $values, array $hintSh
 			$builder->hintShardKey($hintShardKey['column'], $hintShardKey['value'], $hintShardKey['overwrite'] ?? false);
 		}
 
-		/*
-		 * We can't use ON DUPLICATE KEY UPDATE here because Nextcloud use the CLIENT_FOUND_ROWS flag
-		 * With this flag the MySQL returns the number of selected rows
-		 * instead of the number of affected/modified rows
-		 * It's impossible to change this behaviour at runtime or for a single query
-		 * Then, the result is 1 if a row is inserted and also 1 if a row is updated with same or different values
-		 *
-		 * With INSERT IGNORE, the result is 1 when a row is inserted, 0 otherwise
-		 *
-		 * Risk: it can also ignore other errors like type mismatch or truncated data…
-		 */
-		$res = $this->conn->executeStatement(
-			preg_replace('/^INSERT/i', 'INSERT IGNORE', $builder->getSQL()),
-			$builder->getParameters(),
-			$builder->getParameterTypes()
-		);
+		$builder->ignoreConflictsOnInsert();
+		return $builder->executeStatement();
+	}
 
-		return $res;
+	/**
+	 * We can't use ON DUPLICATE KEY UPDATE here because Nextcloud use the CLIENT_FOUND_ROWS flag
+	 * With this flag the MySQL returns the number of selected rows
+	 * instead of the number of affected/modified rows
+	 * It's impossible to change this behaviour at runtime or for a single query
+	 * Then, the result is 1 if a row is inserted and also 1 if a row is updated with same or different values
+	 *
+	 * With INSERT IGNORE, the result is 1 when a row is inserted, 0 otherwise
+	 *
+	 * Risk: it can also ignore other errors like type mismatch or truncated data…
+	 */
+	public function getInsertIgnoreSqlTransformer(): callable {
+		return fn (string $sql) => preg_replace('/^INSERT/i', 'INSERT IGNORE', $sql);
 	}
 }

lib/private/DB/AdapterPgSql.php

@@ -34,7 +34,11 @@ public function insertIgnoreConflict(string $table, array $values, array $hintSh
 		if (isset($hintShardKey['column'], $hintShardKey['value'])) {
 			$builder->hintShardKey($hintShardKey['column'], $hintShardKey['value'], $hintShardKey['overwrite'] ?? false);
 		}
-		$queryString = $builder->getSQL() . ' ON CONFLICT DO NOTHING';
-		return $this->conn->executeUpdate($queryString, $builder->getParameters(), $builder->getParameterTypes());
+		$builder->ignoreConflictsOnInsert();
+		return $builder->executeStatement();
+	}
+
+	public function getInsertIgnoreSqlTransformer(): callable {
+		return fn (string $sql) => $sql . ' ON CONFLICT DO NOTHING';
 	}
 }

lib/private/DB/AdapterSqlite.php

@@ -88,10 +88,11 @@ public function insertIgnoreConflict(string $table, array $values, array $hintSh
 			$builder->hintShardKey($hintShardKey['column'], $hintShardKey['value'], $hintShardKey['overwrite'] ?? false);
 		}
 
-		return $this->conn->executeStatement(
-			$builder->getSQL() . ' ON CONFLICT DO NOTHING',
-			$builder->getParameters(),
-			$builder->getParameterTypes()
-		);
+		$builder->ignoreConflictsOnInsert();
+		return $builder->executeStatement();
+	}
+
+	public function getInsertIgnoreSqlTransformer(): callable {
+		return fn (string $sql) => $sql . ' ON CONFLICT DO NOTHING';
 	}
 }

lib/private/DB/Connection.php

@@ -961,4 +961,8 @@ public function getShardDefinition(string $name): ?ShardDefinition {
 	public function getCrossShardMoveHelper(): CrossShardMoveHelper {
 		return new CrossShardMoveHelper($this->shardConnectionManager);
 	}
+
+	public function getInsertIgnoreSqlTransformer(): ?callable {
+		return $this->adapter->getInsertIgnoreSqlTransformer();
+	}
 }

lib/private/DB/ConnectionAdapter.php

@@ -265,4 +265,8 @@ public function getShardDefinition(string $name): ?ShardDefinition {
 	public function getCrossShardMoveHelper(): CrossShardMoveHelper {
 		return $this->inner->getCrossShardMoveHelper();
 	}
+
+	public function getInsertIgnoreSqlTransformer(): ?callable {
+		return $this->inner->getInsertIgnoreSqlTransformer();
+	}
 }

lib/private/DB/QueryBuilder/ExtendedQueryBuilder.php

@@ -47,6 +47,11 @@ public function getState() {
 		return $this->builder->getState();
 	}
 
+	public function ignoreConflictsOnInsert(): self {
+		$this->builder->ignoreConflictsOnInsert();
+		return $this;
+	}
+
 	public function getSQL() {
 		return $this->builder->getSQL();
 	}

lib/private/DB/QueryBuilder/QueryBuilder.php

@@ -39,6 +39,7 @@ class QueryBuilder extends TypedQueryBuilder {
 	private bool $nonEmptyWhere = false;
 	protected ?string $lastInsertedTable = null;
 	private array $selectedColumns = [];
+	private bool $insertIgnoreConflicts = false;
 
 	/**
 	 * Initializes a new QueryBuilder.
@@ -275,6 +276,13 @@ public function executeStatement(?IDBConnection $connection = null): int {
 		);
 	}
 
+	public function ignoreConflictsOnInsert(): self {
+		if ($this->getType() !== \Doctrine\DBAL\Query\QueryBuilder::INSERT) {
+			throw new \LogicException('ignoreConflictsOnInsert() can only be used on INSERT queries');
+		}
+		$this->insertIgnoreConflicts = true;
+		return $this;
+	}
 
 	/**
 	 * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
@@ -289,7 +297,11 @@ public function executeStatement(?IDBConnection $connection = null): int {
 	 * @return string The SQL query string.
 	 */
 	public function getSQL() {
-		return $this->queryBuilder->getSQL();
+		$sql = $this->queryBuilder->getSQL();
+		if ($this->insertIgnoreConflicts && $this->connection->getInsertIgnoreSqlTransformer() !== null) {
+			return ($this->connection->getInsertIgnoreSqlTransformer())($sql);
+		}
+		return $sql;
 	}
 
 	/**

lib/public/DB/QueryBuilder/IQueryBuilder.php

@@ -216,6 +216,14 @@ public function executeQuery(?IDBConnection $connection = null): IResult;
 	 */
 	public function executeStatement(?IDBConnection $connection = null): int;
 
+	/**
+	 * Set to ignore conflicts on insert
+	 *
+	 * @since 34.0.0
+	 * @return self
+	 */
+	public function ignoreConflictsOnInsert(): self;
+
 	/**
 	 * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
 	 *