renamed Nette\Database\Driver -> Nette\Database\Drivers\Engine (BC br…

…eak)
nette · Aug 19, 2024 · 4cf644b · 4cf644b
1 parent f15da15
commit 4cf644b
Show file tree

Hide file tree

Showing 45 changed files with 339 additions and 315 deletions.
diff --git a/src/Database/Connection.php b/src/Database/Connection.php
@@ -26,7 +26,7 @@ class Connection
 
 	/** @var array<callable(self, ResultSet|DriverException): void>  Occurs after query is executed */
 	public array $onQuery = [];
-	private Driver $driver;
+	private Drivers\Engine $engine;
 	private SqlPreprocessor $preprocessor;
 	private ?PDO $pdo = null;
 
@@ -68,9 +68,9 @@ public function connect(): void
 		$class = empty($this->options['driverClass'])
 			? 'Nette\Database\Drivers\\' . ucfirst(str_replace('sql', 'Sql', $this->pdo->getAttribute(PDO::ATTR_DRIVER_NAME))) . 'Driver'
 			: $this->options['driverClass'];
-		$this->driver = new $class;
+		$this->engine = new $class;
 		$this->preprocessor = new SqlPreprocessor($this);
-		$this->driver->initialize($this, $this->options);
+		$this->engine->initialize($this, $this->options);
 		Arrays::invoke($this->onConnect, $this);
 	}
 
@@ -101,25 +101,25 @@ public function getPdo(): PDO
 	}
 
 
-	public function getDriver(): Driver
+	/** @deprecated use getDriver() */
+	public function getSupplementalDriver(): Drivers\Engine
 	{
+		trigger_error(__METHOD__ . '() is deprecated, use getDriver()', E_USER_DEPRECATED);
 		$this->connect();
-		return $this->driver;
+		return $this->engine;
 	}
 
 
-	/** @deprecated use getDriver() */
-	public function getSupplementalDriver(): Driver
+	public function getDatabaseEngine(): Drivers\Engine
 	{
-		trigger_error(__METHOD__ . '() is deprecated, use getDriver()', E_USER_DEPRECATED);
 		$this->connect();
-		return $this->driver;
+		return $this->engine;
 	}
 
 
 	public function getReflection(): Reflection
 	{
-		return new Reflection($this->getDriver());
+		return new Reflection($this->getDatabaseEngine());
 	}
 
 
@@ -136,7 +136,7 @@ public function getInsertId(?string $sequence = null): string
 			$res = $this->getPdo()->lastInsertId($sequence);
 			return $res === false ? '0' : $res;
 		} catch (PDOException $e) {
-			throw $this->driver->convertException($e);
+			throw $this->engine->convertException($e);
 		}
 	}
 

diff --git a/src/Database/Driver.php → src/Database/Drivers/Engine.php b/src/Database/Driver.php → src/Database/Drivers/Engine.php
@@ -7,13 +7,15 @@
 
 declare(strict_types=1);
 
-namespace Nette\Database;
+namespace Nette\Database\Drivers;
+
+use Nette\Database;
 
 
 /**
- * Supplemental PDO database driver.
+ * Engine-specific behaviors, features and SQL dialects.
  */
-interface Driver
+interface Engine
 {
 	public const
 		SupportSequence = 'sequence',
@@ -26,12 +28,12 @@ interface Driver
 	/**
 	 * Initializes connection.
 	 */
-	function initialize(Connection $connection, array $options): void;
+	function initialize(Database\Connection $connection, array $options): void;
 
 	/**
 	 * Converts PDOException to DriverException or its descendant.
 	 */
-	function convertException(\PDOException $e): DriverException;
+	function convertException(\PDOException $e): Database\DriverException;
 
 	/**
 	 * Delimites identifier for use in a SQL statement.

diff --git a/src/Database/Drivers/MsSqlDriver.php b/src/Database/Drivers/MsSqlDriver.php
@@ -15,7 +15,7 @@
 /**
  * Supplemental MS SQL database driver.
  */
-class MsSqlDriver implements Nette\Database\Driver
+class MsSqlDriver implements Engine
 {
 	private Nette\Database\Connection $connection;
 

diff --git a/src/Database/Drivers/MySqlDriver.php b/src/Database/Drivers/MySqlDriver.php
@@ -15,7 +15,7 @@
 /**
  * Supplemental MySQL database driver.
  */
-class MySqlDriver implements Nette\Database\Driver
+class MySqlDriver implements Engine
 {
 	private Nette\Database\Connection $connection;
 	private bool $convertBoolean;

diff --git a/src/Database/Drivers/OciDriver.php b/src/Database/Drivers/OciDriver.php
@@ -15,7 +15,7 @@
 /**
  * Supplemental Oracle database driver.
  */
-class OciDriver implements Nette\Database\Driver
+class OciDriver implements Engine
 {
 	private Nette\Database\Connection $connection;
 	private string $fmtDateTime;

diff --git a/src/Database/Drivers/OdbcDriver.php b/src/Database/Drivers/OdbcDriver.php
@@ -15,7 +15,7 @@
 /**
  * Supplemental ODBC database driver.
  */
-class OdbcDriver implements Nette\Database\Driver
+class OdbcDriver implements Engine
 {
 	public function initialize(Nette\Database\Connection $connection, array $options): void
 	{

diff --git a/src/Database/Drivers/PgSqlDriver.php b/src/Database/Drivers/PgSqlDriver.php
@@ -15,7 +15,7 @@
 /**
  * Supplemental PostgreSQL database driver.
  */
-class PgSqlDriver implements Nette\Database\Driver
+class PgSqlDriver implements Engine
 {
 	private Nette\Database\Connection $connection;
 

diff --git a/src/Database/Drivers/SqliteDriver.php b/src/Database/Drivers/SqliteDriver.php
@@ -15,7 +15,7 @@
 /**
  * Supplemental SQLite3 database driver.
  */
-class SqliteDriver implements Nette\Database\Driver
+class SqliteDriver implements Engine
 {
 	private Nette\Database\Connection $connection;
 	private string $fmtDateTime;

diff --git a/src/Database/Drivers/SqlsrvDriver.php b/src/Database/Drivers/SqlsrvDriver.php
@@ -15,7 +15,7 @@
 /**
  * Supplemental SQL Server 2005 and later database driver.
  */
-class SqlsrvDriver implements Nette\Database\Driver
+class SqlsrvDriver implements Engine
 {
 	private Nette\Database\Connection $connection;
 

diff --git a/src/Database/Explorer.php b/src/Database/Explorer.php
@@ -92,6 +92,12 @@ public function getConnection(): Connection
 	}
 
 
+	public function getDatabaseEngine(): Drivers\Engine
+	{
+		return $this->connection->getDatabaseEngine();
+	}
+
+
 	public function getStructure(): IStructure
 	{
 		return $this->structure;

diff --git a/src/Database/Reflection.php b/src/Database/Reflection.php
@@ -19,7 +19,7 @@ final class Reflection
 
 
 	public function __construct(
-		private readonly Driver $driver,
+		private readonly Drivers\Engine $engine,
 	) {
 		unset($this->tables);
 	}
@@ -67,16 +67,16 @@ private function getFullName(string $name): string
 
 
 	/** @internal */
-	public function getDriver(): Driver
+	public function getDatabaseEngine(): Drivers\Engine
 	{
-		return $this->driver;
+		return $this->engine;
 	}
 
 
 	private function initTables(): void
 	{
 		$res = [];
-		foreach ($this->driver->getTables() as $row) {
+		foreach ($this->engine->getTables() as $row) {
 			$res[$row['fullName'] ?? $row['name']] = new Table($this, $row['name'], $row['view'], $row['fullName'] ?? null);
 		}
 		$this->tables = $res;

diff --git a/src/Database/Reflection/Table.php b/src/Database/Reflection/Table.php
@@ -48,7 +48,7 @@ public function getColumn(string $name): Column
 	private function initColumns(): void
 	{
 		$res = [];
-		foreach ($this->reflection->getDriver()->getColumns($this->name) as $row) {
+		foreach ($this->reflection->getDatabaseEngine()->getColumns($this->name) as $row) {
 			$row['table'] = $this;
 			$res[$row['name']] = new Column(...$row);
 		}
@@ -65,7 +65,7 @@ private function initIndexes(): void
 				$row['primary'],
 				is_string($row['name']) ? $row['name'] : null,
 			),
-			$this->reflection->getDriver()->getIndexes($this->name),
+			$this->reflection->getDatabaseEngine()->getIndexes($this->name),
 		);
 	}
 
@@ -83,7 +83,7 @@ private function initPrimaryKey(): void
 	private function initForeignKeys(): void
 	{
 		$tmp = [];
-		foreach ($this->reflection->getDriver()->getForeignKeys($this->name) as $row) {
+		foreach ($this->reflection->getDatabaseEngine()->getForeignKeys($this->name) as $row) {
 			$id = $row['name'];
 			$foreignTable = $this->reflection->getTable($row['table']);
 			$tmp[$id][0] = $foreignTable;

diff --git a/src/Database/ResultSet.php b/src/Database/ResultSet.php
@@ -55,7 +55,7 @@ public function __construct(
 				$this->pdoStatement->execute();
 			}
 		} catch (\PDOException $e) {
-			$e = $connection->getDriver()->convertException($e);
+			$e = $connection->getDatabaseEngine()->convertException($e);
 			$e->queryString = $queryString;
 			$e->params = $params;
 			throw $e;
@@ -108,7 +108,7 @@ public function getRowCount(): ?int
 
 	public function getColumnTypes(): array
 	{
-		$this->types ??= $this->connection->getDriver()->getColumnTypes($this->pdoStatement);
+		$this->types ??= $this->connection->getDatabaseEngine()->getColumnTypes($this->pdoStatement);
 		return $this->types;
 	}
 

diff --git a/src/Database/SqlPreprocessor.php b/src/Database/SqlPreprocessor.php
@@ -49,7 +49,7 @@ class SqlPreprocessor
 	];
 
 	private readonly Connection $connection;
-	private readonly Driver $driver;
+	private readonly Drivers\Engine $engine;
 	private array $params;
 	private array $remaining;
 	private int $counter;
@@ -62,7 +62,7 @@ class SqlPreprocessor
 	public function __construct(Connection $connection)
 	{
 		$this->connection = $connection;
-		$this->driver = $connection->getDriver();
+		$this->engine = $connection->getDatabaseEngine();
 	}
 
 
@@ -177,10 +177,10 @@ private function formatValue(mixed $value, ?string $mode = null): string
 				return $res;
 
 			} elseif ($value instanceof \DateTimeInterface) {
-				return $this->driver->formatDateTime($value);
+				return $this->engine->formatDateTime($value);
 
 			} elseif ($value instanceof \DateInterval) {
-				return $this->driver->formatDateInterval($value);
+				return $this->engine->formatDateInterval($value);
 
 			} elseif ($value instanceof \BackedEnum && is_scalar($value->value)) {
 				$this->remaining[] = $value->value;
@@ -231,7 +231,7 @@ private function formatValue(mixed $value, ?string $mode = null): string
 						$vx[] = implode(', ', $vx2);
 					}
 
-					$select = $this->driver->isSupported(Driver::SupportMultiInsertAsSelect);
+					$select = $this->engine->isSupported(Drivers\Engine::SupportMultiInsertAsSelect);
 					return '(' . implode(', ', $kx) . ($select ? ') SELECT ' : ') VALUES (')
 						. implode($select ? ' UNION ALL SELECT ' : '), (', $vx) . ($select ? '' : ')');
 				}
@@ -320,6 +320,6 @@ private function formatValue(mixed $value, ?string $mode = null): string
 
 	private function delimite(string $name): string
 	{
-		return implode('.', array_map($this->driver->delimite(...), explode('.', $name)));
+		return implode('.', array_map($this->engine->delimite(...), explode('.', $name)));
 	}
 }
diff --git a/src/Database/Structure.php b/src/Database/Structure.php
@@ -94,7 +94,7 @@ public function getPrimaryKeySequence(string $table): ?string
 		$this->needStructure();
 		$table = $this->resolveFQTableName($table);
 
-		if (!$this->connection->getDriver()->isSupported(Driver::SupportSequence)) {
+		if (!$this->connection->getDatabaseEngine()->isSupported(Drivers\Engine::SupportSequence)) {
 			return null;
 		}
 
@@ -177,10 +177,10 @@ protected function needStructure(): void
 
 	protected function loadStructure(): array
 	{
-		$driver = $this->connection->getDriver();
+		$engine = $this->connection->getDatabaseEngine();
 
 		$structure = [];
-		$structure['tables'] = $driver->getTables();
+		$structure['tables'] = $engine->getTables();
 
 		foreach ($structure['tables'] as $tablePair) {
 			if (isset($tablePair['fullName'])) {
@@ -190,7 +190,7 @@ protected function loadStructure(): array
 				$table = $tablePair['name'];
 			}
 
-			$structure['columns'][strtolower($table)] = $columns = $driver->getColumns($table);
+			$structure['columns'][strtolower($table)] = $columns = $engine->getColumns($table);
 
 			if (!$tablePair['view']) {
 				$structure['primary'][strtolower($table)] = $this->analyzePrimaryKey($columns);
@@ -233,7 +233,7 @@ protected function analyzeForeignKeys(array &$structure, string $table): void
 	{
 		$lowerTable = strtolower($table);
 
-		$foreignKeys = $this->connection->getDriver()->getForeignKeys($table);
+		$foreignKeys = $this->connection->getDatabaseEngine()->getForeignKeys($table);
 
 		$fksColumnsCounts = [];
 		foreach ($foreignKeys as $foreignKey) {

diff --git a/src/Database/Table/Selection.php b/src/Database/Table/Selection.php
@@ -790,7 +790,7 @@ public function insert(iterable $data): ActiveRow|array|int|bool
 
 		// First check sequence
 		if (!empty($primarySequenceName) && $primaryAutoincrementKey) {
-			$primaryKey[$primaryAutoincrementKey] = $this->explorer->getInsertId($this->explorer->getConnection()->getDriver()->delimite($primarySequenceName));
+			$primaryKey[$primaryAutoincrementKey] = $this->explorer->getInsertId($this->explorer->getConnection()->getDatabaseEngine()->delimite($primarySequenceName));
 
 		// Autoincrement primary without sequence
 		} elseif ($primaryAutoincrementKey) {