Merge pull request #221 from nextras/sequence-casing

Fix sequence casing escaping & add support for FQN for last inserted id (BC break!)
nextras · Oct 15, 2023 · 510e6b7 · 510e6b7
2 parents 0718360 + 5475de2
commit 510e6b7
Show file tree

Hide file tree

Showing 11 changed files with 112 additions and 52 deletions.
diff --git a/src/Connection.php b/src/Connection.php
@@ -6,6 +6,7 @@
 use Exception;
 use Nextras\Dbal\Drivers\IDriver;
 use Nextras\Dbal\Exception\InvalidArgumentException;
+use Nextras\Dbal\Platforms\Data\Fqn;
 use Nextras\Dbal\Platforms\IPlatform;
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
 use Nextras\Dbal\Result\Result;
@@ -144,7 +145,7 @@ public function queryByQueryBuilder(QueryBuilder $queryBuilder): Result
 
 
 	/** @inheritdoc */
-	public function getLastInsertedId(?string $sequenceName = null)
+	public function getLastInsertedId(string|Fqn|null $sequenceName = null)
 	{
 		if (!$this->connected) {
 			$this->connect();

diff --git a/src/Drivers/IDriver.php b/src/Drivers/IDriver.php
@@ -8,6 +8,7 @@
 use Nextras\Dbal\Exception\NotSupportedException;
 use Nextras\Dbal\IConnection;
 use Nextras\Dbal\ILogger;
+use Nextras\Dbal\Platforms\Data\Fqn;
 use Nextras\Dbal\Platforms\IPlatform;
 use Nextras\Dbal\Result\Result;
 
@@ -64,7 +65,7 @@ public function query(string $query): Result;
 	 * Returns the last inserted id.
 	 * @internal
 	 */
-	public function getLastInsertedId(?string $sequenceName = null): mixed;
+	public function getLastInsertedId(string|Fqn|null $sequenceName = null): mixed;
 
 
 	/**
@@ -135,23 +136,23 @@ public function rollbackTransaction(): void;
 	 * @throws DriverException
 	 * @internal
 	 */
-	public function createSavepoint(string $name): void;
+	public function createSavepoint(string|Fqn $name): void;
 
 
 	/**
 	 * Releases the savepoint.
 	 * @throws DriverException
 	 * @internal
 	 */
-	public function releaseSavepoint(string $name): void;
+	public function releaseSavepoint(string|Fqn $name): void;
 
 
 	/**
 	 * Rollbacks the savepoint.
 	 * @throws DriverException
 	 * @internal
 	 */
-	public function rollbackSavepoint(string $name): void;
+	public function rollbackSavepoint(string|Fqn $name): void;
 
 
 	/**

diff --git a/src/Drivers/Mysqli/MysqliDriver.php b/src/Drivers/Mysqli/MysqliDriver.php
@@ -17,6 +17,7 @@
 use Nextras\Dbal\Exception\NotSupportedException;
 use Nextras\Dbal\IConnection;
 use Nextras\Dbal\ILogger;
+use Nextras\Dbal\Platforms\Data\Fqn;
 use Nextras\Dbal\Platforms\IPlatform;
 use Nextras\Dbal\Platforms\MySqlPlatform;
 use Nextras\Dbal\Result\Result;
@@ -95,7 +96,7 @@ public function connect(array $params, ILogger $logger): void
 			throw $this->createException(
 				$this->connection->connect_error ?? $this->connection->error, // @phpstan-ignore-line
 				$this->connection->connect_errno,
-				'HY000'
+				'HY000',
 			);
 		}
 
@@ -147,7 +148,7 @@ public function query(string $query): Result
 				$this->connection->error,
 				$this->connection->errno,
 				$this->connection->sqlstate,
-				$query
+				$query,
 			);
 		}
 
@@ -159,7 +160,7 @@ public function query(string $query): Result
 	}
 
 
-	public function getLastInsertedId(?string $sequenceName = null): mixed
+	public function getLastInsertedId(string|Fqn|null $sequenceName = null): mixed
 	{
 		$this->checkConnection();
 		assert($this->connection !== null);
@@ -249,27 +250,24 @@ public function rollbackTransaction(): void
 	}
 
 
-	public function createSavepoint(string $name): void
+	public function createSavepoint(string|Fqn $name): void
 	{
 		$this->checkConnection();
-		$identifier = str_replace(['`', '.'], ['``', '`.`'], $name);
-		$this->loggedQuery("SAVEPOINT $identifier");
+		$this->loggedQuery('SAVEPOINT ' . $this->convertIdentifierToSql($name));
 	}
 
 
-	public function releaseSavepoint(string $name): void
+	public function releaseSavepoint(string|Fqn $name): void
 	{
 		$this->checkConnection();
-		$identifier = str_replace(['`', '.'], ['``', '`.`'], $name);
-		$this->loggedQuery("RELEASE SAVEPOINT $identifier");
+		$this->loggedQuery('RELEASE SAVEPOINT ' . $this->convertIdentifierToSql($name));
 	}
 
 
-	public function rollbackSavepoint(string $name): void
+	public function rollbackSavepoint(string|Fqn $name): void
 	{
 		$this->checkConnection();
-		$identifier = str_replace(['`', '.'], ['``', '`.`'], $name);
-		$this->loggedQuery("ROLLBACK TO SAVEPOINT $identifier");
+		$this->loggedQuery('ROLLBACK TO SAVEPOINT ' . $this->convertIdentifierToSql($name));
 	}
 
 
@@ -296,7 +294,7 @@ protected function setupSsl(array $params): void
 			$params['sslCert'] ?? '',
 			$params['sslCa'] ?? '',
 			$params['sslCapath'] ?? '',
-			$params['sslCipher'] ?? ''
+			$params['sslCipher'] ?? '',
 		);
 	}
 
@@ -345,6 +343,17 @@ public function convertStringToSql(string $value): string
 	}
 
 
+	protected function convertIdentifierToSql(string|Fqn $identifier): string
+	{
+		$escaped = match (true) {
+			$identifier instanceof Fqn => str_replace('`', '``', $identifier->schema) . '.'
+				. str_replace('`', '``', $identifier->name),
+			default => str_replace('`', '``', $identifier),
+		};
+		return '`' . $escaped . '`';
+	}
+
+
 	/**
 	 * This method is based on Doctrine\DBAL project.
 	 * @link www.doctrine-project.org

diff --git a/src/Drivers/Pdo/PdoDriver.php b/src/Drivers/Pdo/PdoDriver.php
@@ -9,6 +9,7 @@
 use Nextras\Dbal\Drivers\IDriver;
 use Nextras\Dbal\Exception\InvalidStateException;
 use Nextras\Dbal\ILogger;
+use Nextras\Dbal\Platforms\Data\Fqn;
 use Nextras\Dbal\Result\IResultAdapter;
 use Nextras\Dbal\Result\Result;
 use Nextras\Dbal\Utils\LoggerHelper;
@@ -108,7 +109,7 @@ public function query(string $query): Result
 	}
 
 
-	public function getLastInsertedId(?string $sequenceName = null): mixed
+	public function getLastInsertedId(string|Fqn|null $sequenceName = null): mixed
 	{
 		$this->checkConnection();
 		assert($this->connection !== null);
@@ -207,23 +208,23 @@ public function rollbackTransaction(): void
 	}
 
 
-	public function createSavepoint(string $name): void
+	public function createSavepoint(string|Fqn $name): void
 	{
 		$this->checkConnection();
 		$identifier = $this->convertIdentifierToSql($name);
 		$this->loggedQuery("SAVEPOINT $identifier");
 	}
 
 
-	public function releaseSavepoint(string $name): void
+	public function releaseSavepoint(string|Fqn $name): void
 	{
 		$this->checkConnection();
 		$identifier = $this->convertIdentifierToSql($name);
 		$this->loggedQuery("RELEASE SAVEPOINT $identifier");
 	}
 
 
-	public function rollbackSavepoint(string $name): void
+	public function rollbackSavepoint(string|Fqn $name): void
 	{
 		$this->checkConnection();
 		$identifier = $this->convertIdentifierToSql($name);
@@ -245,7 +246,7 @@ public function convertStringToSql(string $value): string
 	abstract protected function createResultAdapter(PDOStatement $statement): IResultAdapter;
 
 
-	abstract protected function convertIdentifierToSql(string $identifier): string;
+	abstract protected function convertIdentifierToSql(string|Fqn $identifier): string;
 
 
 	abstract protected function createException(

diff --git a/src/Drivers/PdoMysql/PdoMysqlDriver.php b/src/Drivers/PdoMysql/PdoMysqlDriver.php
@@ -17,6 +17,7 @@
 use Nextras\Dbal\Exception\NotSupportedException;
 use Nextras\Dbal\IConnection;
 use Nextras\Dbal\ILogger;
+use Nextras\Dbal\Platforms\Data\Fqn;
 use Nextras\Dbal\Platforms\IPlatform;
 use Nextras\Dbal\Platforms\MySqlPlatform;
 use Nextras\Dbal\Result\IResultAdapter;
@@ -100,7 +101,7 @@ public function createPlatform(IConnection $connection): IPlatform
 	}
 
 
-	public function getLastInsertedId(?string $sequenceName = null): int
+	public function getLastInsertedId(string|Fqn|null $sequenceName = null): int
 	{
 		return (int) parent::getLastInsertedId($sequenceName);
 	}
@@ -128,9 +129,13 @@ protected function createResultAdapter(PDOStatement $statement): IResultAdapter
 	}
 
 
-	protected function convertIdentifierToSql(string $identifier): string
+	protected function convertIdentifierToSql(string|Fqn $identifier): string
 	{
-		return str_replace(['`', '.'], ['``', '`.`'], $identifier);
+		return match (true) {
+			$identifier instanceof Fqn => str_replace('`', '``', $identifier->schema) . '.'
+				. str_replace('`', '``', $identifier->name),
+			default => str_replace('`', '``', $identifier),
+		};
 	}
 
 

diff --git a/src/Drivers/PdoPgsql/PdoPgsqlDriver.php b/src/Drivers/PdoPgsql/PdoPgsqlDriver.php
@@ -17,6 +17,7 @@
 use Nextras\Dbal\Exception\NotSupportedException;
 use Nextras\Dbal\IConnection;
 use Nextras\Dbal\ILogger;
+use Nextras\Dbal\Platforms\Data\Fqn;
 use Nextras\Dbal\Platforms\IPlatform;
 use Nextras\Dbal\Platforms\PostgreSqlPlatform;
 use Nextras\Dbal\Result\IResultAdapter;
@@ -72,15 +73,21 @@ public function createPlatform(IConnection $connection): IPlatform
 	}
 
 
-	public function getLastInsertedId(?string $sequenceName = null): mixed
+	public function getLastInsertedId(string|Fqn|null $sequenceName = null): mixed
 	{
 		if ($sequenceName === null) {
 			throw new InvalidArgumentException('PgsqlDriver requires to pass sequence name for getLastInsertedId() method.');
 		}
 
 		$this->checkConnection();
 		assert($this->connection !== null);
-		$sql = 'SELECT CURRVAL(' . $this->convertStringToSql($sequenceName) . ')';
+
+		$sequenceName = match (true) {
+			$sequenceName instanceof Fqn => $this->convertIdentifierToSql($sequenceName->schema) . '.' .
+				$this->convertIdentifierToSql($sequenceName->name),
+			default => $this->convertIdentifierToSql($sequenceName),
+		};
+		$sql = 'SELECT CURRVAL(\'' . $sequenceName . '\')';
 		return $this->loggedQuery($sql)->fetchField();
 	}
 
@@ -108,9 +115,14 @@ protected function createResultAdapter(PDOStatement $statement): IResultAdapter
 	}
 
 
-	protected function convertIdentifierToSql(string $identifier): string
+	protected function convertIdentifierToSql(string|Fqn $identifier): string
 	{
-		return '"' . str_replace(['"', '.'], ['""', '"."'], $identifier) . '"';
+		$escaped = match (true) {
+			$identifier instanceof Fqn => str_replace('"', '""', $identifier->schema) . '.'
+				. str_replace('"', '""', $identifier->name),
+			default => str_replace('"', '""', $identifier),
+		};
+		return '"' . $escaped . '"';
 	}
 
 

diff --git a/src/Drivers/PdoSqlsrv/PdoSqlsrvDriver.php b/src/Drivers/PdoSqlsrv/PdoSqlsrvDriver.php
@@ -14,6 +14,7 @@
 use Nextras\Dbal\Exception\NotSupportedException;
 use Nextras\Dbal\IConnection;
 use Nextras\Dbal\ILogger;
+use Nextras\Dbal\Platforms\Data\Fqn;
 use Nextras\Dbal\Platforms\IPlatform;
 use Nextras\Dbal\Platforms\SqlServerPlatform;
 use Nextras\Dbal\Result\IResultAdapter;
@@ -94,7 +95,7 @@ public function createPlatform(IConnection $connection): IPlatform
 	}
 
 
-	public function getLastInsertedId(?string $sequenceName = null): mixed
+	public function getLastInsertedId(string|Fqn|null $sequenceName = null): mixed
 	{
 		$this->checkConnection();
 		return $this->loggedQuery('SELECT SCOPE_IDENTITY()')->fetchField();
@@ -117,21 +118,21 @@ public function setTransactionIsolationLevel(int $level): void
 	}
 
 
-	public function createSavepoint(string $name): void
+	public function createSavepoint(string|Fqn $name): void
 	{
 		$this->checkConnection();
 		$this->loggedQuery('SAVE TRANSACTION ' . $this->convertIdentifierToSql($name));
 	}
 
 
-	public function releaseSavepoint(string $name): void
+	public function releaseSavepoint(string|Fqn $name): void
 	{
 		// transaction are released automatically
 		// http://stackoverflow.com/questions/3101312/sql-server-2008-no-release-savepoint-for-current-transaction
 	}
 
 
-	public function rollbackSavepoint(string $name): void
+	public function rollbackSavepoint(string|Fqn $name): void
 	{
 		$this->checkConnection();
 		$this->loggedQuery('ROLLBACK TRANSACTION ' . $this->convertIdentifierToSql($name));
@@ -145,9 +146,14 @@ protected function createResultAdapter(PDOStatement $statement): IResultAdapter
 	}
 
 
-	protected function convertIdentifierToSql(string $identifier): string
+	protected function convertIdentifierToSql(string|Fqn $identifier): string
 	{
-		return '[' . str_replace([']', '.'], [']]', '].['], $identifier) . ']';
+		$escaped = match (true) {
+			$identifier instanceof Fqn => str_replace(']', ']]', $identifier->schema) . '.'
+				. str_replace(']', ']]', $identifier->name),
+			default => str_replace(']', ']]', $identifier),
+		};
+		return '[' . $escaped . ']';
 	}