feat(db): add optional hintShardKey parameter to insertIgnoreConflict

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

Author: tcitworld

lib/private/DB/Adapter.php

@@ -111,13 +111,16 @@ public function insertIfNotExist($table, $input, ?array $compare = null) {
 	/**
 	 * @throws \OCP\DB\Exception
 	 */
-	public function insertIgnoreConflict(string $table, array $values) : int {
+	public function insertIgnoreConflict(string $table, array $values, array $hintShardKey = []) : int {
 		try {
 			$builder = $this->conn->getQueryBuilder();
 			$builder->insert($table);
 			foreach ($values as $key => $value) {
 				$builder->setValue($key, $builder->createNamedParameter($value));
 			}
+			if (isset($hintShardKey['column'], $hintShardKey['value'])) {
+				$builder->hintShardKey($hintShardKey['column'], $hintShardKey['value'], $hintShardKey['overwrite'] ?? false);
+			}
 			return $builder->executeStatement();
 		} catch (DbalException $e) {
 			if ($e->getReason() === \OCP\DB\Exception::REASON_UNIQUE_CONSTRAINT_VIOLATION) {

lib/private/DB/AdapterMySQL.php

@@ -36,14 +36,17 @@ protected function getCollation(): string {
 		return $this->collation;
 	}
 
-	public function insertIgnoreConflict(string $table, array $values): int {
+	public function insertIgnoreConflict(string $table, array $values, array $hintShardKey = []): int {
 		$builder = $this->conn->getQueryBuilder();
 		$builder->insert($table);
-		$updates = [];
 		foreach ($values as $key => $value) {
 			$builder->setValue($key, $builder->createNamedParameter($value));
 		}
 
+		if (isset($hintShardKey['column'], $hintShardKey['value'])) {
+			$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

lib/private/DB/AdapterPgSql.php

@@ -23,14 +23,17 @@ public function fixupStatement($statement) {
 		return $statement;
 	}
 
-	public function insertIgnoreConflict(string $table, array $values) : int {
+	public function insertIgnoreConflict(string $table, array $values, array $hintShardKey = []) : int {
 		// "upsert" is only available since PgSQL 9.5, but the generic way
 		// would leave error logs in the DB.
 		$builder = $this->conn->getQueryBuilder();
 		$builder->insert($table);
 		foreach ($values as $key => $value) {
 			$builder->setValue($key, $builder->createNamedParameter($value));
 		}
+		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());
 	}

lib/private/DB/AdapterSqlite.php

@@ -77,14 +77,17 @@ public function insertIfNotExist($table, $input, ?array $compare = null) {
 		}
 	}
 
-	public function insertIgnoreConflict(string $table, array $values): int {
+	public function insertIgnoreConflict(string $table, array $values, array $hintShardKey = []): int {
 		$builder = $this->conn->getQueryBuilder();
 		$builder->insert($table);
-		$updates = [];
 		foreach ($values as $key => $value) {
 			$builder->setValue($key, $builder->createNamedParameter($value));
 		}
 
+		if (isset($hintShardKey['column'], $hintShardKey['value'])) {
+			$builder->hintShardKey($hintShardKey['column'], $hintShardKey['value'], $hintShardKey['overwrite'] ?? false);
+		}
+
 		return $this->conn->executeStatement(
 			$builder->getSQL() . ' ON CONFLICT DO NOTHING',
 			$builder->getParameters(),

lib/private/DB/Connection.php

@@ -548,9 +548,9 @@ public function insertIfNotExist($table, $input, ?array $compare = null) {
 		}
 	}
 
-	public function insertIgnoreConflict(string $table, array $values) : int {
+	public function insertIgnoreConflict(string $table, array $values, array $hintShardKey = []) : int {
 		try {
-			return $this->adapter->insertIgnoreConflict($table, $values);
+			return $this->adapter->insertIgnoreConflict($table, $values, $hintShardKey);
 		} catch (\Exception $e) {
 			$this->logDatabaseException($e);
 			throw $e;

lib/private/DB/ConnectionAdapter.php

@@ -89,9 +89,9 @@ public function insertIfNotExist(string $table, array $input, ?array $compare =
 		}
 	}
 
-	public function insertIgnoreConflict(string $table, array $values): int {
+	public function insertIgnoreConflict(string $table, array $values, array $hintShardKey = []): int {
 		try {
-			return $this->inner->insertIgnoreConflict($table, $values);
+			return $this->inner->insertIgnoreConflict($table, $values, $hintShardKey);
 		} catch (Exception $e) {
 			throw DbalException::wrap($e);
 		}

lib/public/IDBConnection.php

@@ -168,10 +168,12 @@ public function insertIfNotExist(string $table, array $input, ?array $compare =
 	 *
 	 * @param string $table The table name (will replace *PREFIX* with the actual prefix)
 	 * @param array $values data that should be inserted into the table  (column name => value)
+	 * @param array{column: string, value: mixed, overwrite?: bool}|array{} $hintShardKey An array representing the shard key to hint
 	 * @return int number of inserted rows
+	 * @since 34.0.0 Parameter $hintShardKey was added
 	 * @since 16.0.0
 	 */
-	public function insertIgnoreConflict(string $table, array $values) : int;
+	public function insertIgnoreConflict(string $table, array $values, array $hintShardKey = []) : int;
 
 	/**
 	 * Insert or update a row value