interface Driver (View source)

Driver interface.

Interface that all DBAL drivers must implement.

Methods

connect(array $params, string|null $username = null, string|null $password = null, array $driverOptions = array())

Attempts to create a connection with the database.

getDatabasePlatform()

Gets the DatabasePlatform instance that provides all the metadata about the platform this driver connects to.

getSchemaManager(Connection $conn)

Gets the SchemaManager that can be used to inspect and change the underlying database schema of the platform this driver connects to.

string
getName()

Gets the name of the driver.

string
getDatabase(Connection $conn)

Gets the name of the database connected to for this driver.

Details

Connection connect(array $params, string|null $username = null, string|null $password = null, array $driverOptions = array())

Attempts to create a connection with the database.

Parameters

array $params All connection parameters passed by the user.
string|null $username The username to use when connecting.
string|null $password The password to use when connecting.
array $driverOptions The driver options to use when connecting.

Return Value

Connection The database connection.

AbstractPlatform getDatabasePlatform()

Gets the DatabasePlatform instance that provides all the metadata about the platform this driver connects to.

Return Value

AbstractPlatform The database platform.

AbstractSchemaManager getSchemaManager(Connection $conn)

Gets the SchemaManager that can be used to inspect and change the underlying database schema of the platform this driver connects to.

Parameters

Connection $conn

Return Value

AbstractSchemaManager

string getName()

Gets the name of the driver.

Return Value

string The name of the driver.

string getDatabase(Connection $conn)

Gets the name of the database connected to for this driver.

Parameters

Connection $conn

Return Value

string The name of the database.