Class Doctrine\DBAL\DriverManager

`final`

Factory for creating {@see Connection} instances.

Type aliases
`OverrideParams`	`array{application_name?: string, charset?: string, dbname?: string, default_dbname?: string, driver?: key-of<self::DRIVER_MAP>, driverClass?: class-string<Driver>, driverOptions?: array<mixed>, host?: string, password?: string, path?: string, persistent?: bool, platform?: AbstractPlatform, port?: int, serverVersion?: string, url?: string, user?: string, unix_socket?: string}`	#
`Params`	array{application_name?: string, charset?: string, dbname?: string, defaultTableOptions?: array<string, mixed>, default_dbname?: string, driver?: key-of<self::DRIVER_MAP>, driverClass?: class-string<Driver>, driverOptions?: array<mixed>, host?: string, keepSlave?: bool, keepReplica?: bool, master?: OverrideParams, memory?: bool, password?: string, path?: string, persistent?: bool, platform?: AbstractPlatform, port?: int, primary?: OverrideParams, replica?: array<OverrideParams>, serverVersion?: string, sharding?: array<string, mixed>, slaves?: array<OverrideParams>, url?: string, user?: string, wrapperClass?: class-string<Connection>, unix_socket?: string}	#

Methods


					
	private

__construct()

Private constructor. This class cannot be instantiated.


					
	public
					static

getConnection<T is Connection>(
	Params $params,
	Configuration|null $config = null,
	EventManager|null $eventManager = null,
): Connection

Creates a connection object based on the specified parameters. This method returns a Doctrine\DBAL\Connection which…

Creates a connection object based on the specified parameters. This method returns a Doctrine\DBAL\Connection which wraps the underlying driver connection.

$params must contain at least one of the following.

Either 'driver' with one of the array keys of {@see DRIVER_MAP}, OR 'driverClass' that contains the full class name (with namespace) of the driver class to instantiate.

Other (optional) parameters:

user (string): The username to use when connecting.

password (string): The password to use when connecting.

driverOptions (array): Any additional driver-specific options for the driver. These are just passed through to the driver.

wrapperClass: You may specify a custom wrapper class through the 'wrapperClass' parameter but this class MUST inherit from Doctrine\DBAL\Connection.

driverClass: The driver class to use.

Parameters

`$config`	The configuration to use.
`$eventManager`	The event manager to use.

Throws

Doctrine\DBAL\Exception


					
	public
					static

getAvailableDrivers(): string[]

Returns the list of supported drivers.


					
	private
					static

createDriver(?string $driver, ?string $driverClass): Driver

Throws

Doctrine\DBAL\Exception


					
	private
					static

parseDatabaseUrl(Params $params): mixed[]

Extracts parts from a database URL, if present, and returns an updated list of parameters.

Returns

A modified list of parameters with info from a database URL extracted into indidivual parameter parts.

Throws

Doctrine\DBAL\Exception

Constants
`private`	`DRIVER_MAP = [ 'pdo_mysql' => Driver::class, 'pdo_sqlite' => Driver::class, 'pdo_pgsql' => Driver::class, 'pdo_oci' => Driver::class, 'oci8' => Driver::class, 'ibm_db2' => Driver::class, 'pdo_sqlsrv' => Driver::class, 'mysqli' => Driver::class, 'pgsql' => Driver::class, 'sqlsrv' => Driver::class, 'sqlite3' => Driver::class, ]` List of supported drivers and their mappings to the driver classes. List of supported drivers and their mappings to the driver classes. To add your own driver use the 'driverClass' parameter to {@see DriverManager::getConnection()}.	#

Properties
`private static`	`array<string, string>`	`$driverSchemeAliases = [ 'db2' => 'ibm_db2', 'mssql' => 'pdo_sqlsrv', 'mysql' => 'pdo_mysql', 'mysql2' => 'pdo_mysql', 'postgres' => 'pdo_pgsql', 'postgresql' => 'pdo_pgsql', 'pgsql' => 'pdo_pgsql', 'sqlite' => 'pdo_sqlite', 'sqlite3' => 'pdo_sqlite', ]`	#

Namespaces

Classes

Interfaces

Exceptions

Class Doctrine\DBAL\DriverManager

Parameters

Throws

Throws

Returns

Throws