Driver
in
Driver interface.
Interface that all DBAL drivers must implement.
Table of Contents
- connect() : Connection
- Attempts to create a connection with the database.
- getDatabasePlatform() : AbstractPlatform
- Gets the DatabasePlatform instance that provides all the metadata about the platform this driver connects to.
- getExceptionConverter() : ExceptionConverter
- Gets the ExceptionConverter that can be used to convert driver-level exceptions into DBAL exceptions.
- getSchemaManager() : AbstractSchemaManager
- Gets the SchemaManager that can be used to inspect and change the underlying database schema of the platform this driver connects to.
Methods
connect()
Attempts to create a connection with the database.
public
connect(array<string|int, mixed> $params) : Connection
Parameters
- $params : array<string|int, mixed>
-
All connection parameters.
Tags
Return values
Connection —The database connection.
getDatabasePlatform()
Gets the DatabasePlatform instance that provides all the metadata about the platform this driver connects to.
public
getDatabasePlatform() : AbstractPlatform
Return values
AbstractPlatform —The database platform.
getExceptionConverter()
Gets the ExceptionConverter that can be used to convert driver-level exceptions into DBAL exceptions.
public
getExceptionConverter() : ExceptionConverter
Return values
ExceptionConverter —getSchemaManager()
Gets the SchemaManager that can be used to inspect and change the underlying database schema of the platform this driver connects to.
public
getSchemaManager(Connection $conn, AbstractPlatform $platform) : AbstractSchemaManager
Parameters
- $conn : Connection
- $platform : AbstractPlatform