Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/facile-it/doctrine-mysql-come-back
Doctrine DBAL able to try reconnect on MySQL has gone away exceptions
https://github.com/facile-it/doctrine-mysql-come-back
doctrine-dbal hacktoberfest mysql php
Last synced: 7 days ago
JSON representation
Doctrine DBAL able to try reconnect on MySQL has gone away exceptions
- Host: GitHub
- URL: https://github.com/facile-it/doctrine-mysql-come-back
- Owner: facile-it
- License: apache-2.0
- Created: 2014-08-20T14:53:51.000Z (over 10 years ago)
- Default Branch: 3.x
- Last Pushed: 2024-12-17T07:56:18.000Z (25 days ago)
- Last Synced: 2024-12-28T10:06:39.626Z (14 days ago)
- Topics: doctrine-dbal, hacktoberfest, mysql, php
- Language: PHP
- Homepage:
- Size: 388 KB
- Stars: 199
- Watchers: 39
- Forks: 39
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/facile-it/doctrine-mysql-come-back)
[](https://packagist.org/packages/facile-it/doctrine-mysql-come-back)
[](https://packagist.org/packages/facile-it/doctrine-mysql-come-back)
[]( https://github.com/facile-it/doctrine-mysql-come-back/actions?query=workflow%3A%22Continuous+Integration%22+branch%3Amaster)
[](https://codecov.io/gh/facile-it/doctrine-mysql-come-back)
[](https://packagist.org/packages/facile-it/doctrine-mysql-come-back)
# DoctrineMySQLComeBack
This library tries to solve the infamous "MySQL has gone away" issue, and similar ones.
It does so by providing a `doctrine/dbal` driver wrapper that automatically reconnects to the database server when applicable; to avoid consistency issues, the reconnection is not attempted when writes are concerned (i.e. open transaction, timeout on write queries).
# Installation
If you're using DBAL 4.0+
```console
$ composer require facile-it/doctrine-mysql-come-back ^3.0
```
If you're using DBAL 3.6+
```console
$ composer require facile-it/doctrine-mysql-come-back ^2.0
```
If you're using DBAL `^2.3`
```console
$ composer require facile-it/doctrine-mysql-come-back ^1.0
```
# Configuration
In order to use DoctrineMySQLComeBack you have to set the `wrapperClass` connection parameter.
You can choose how many times Doctrine should be able to reconnect, setting `x_reconnect_attempts` driver option. Its value must be an int.
If you're using DBAL v2, you also need to set the `driverClass` parameter too; please refer to the [previous version of this readme](https://github.com/facile-it/doctrine-mysql-come-back/blob/1.10.1/README.md#configuration) for that.
An example of configuration at connection instantiation time:
```php
use Doctrine\DBAL\Configuration;
use Doctrine\DBAL\DriverManager;
$config = new Configuration();
//..
$connectionParams = [
'dbname' => 'mydb',
'user' => 'user',
'password' => 'secret',
'host' => 'localhost',
// [doctrine-mysql-come-back] settings
'wrapperClass' => 'Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Connection',
'driverOptions' => [
'x_reconnect_attempts' => 3
],
];
$conn = DriverManager::getConnection($connectionParams, $config);
//..
```
An example of yaml configuration on Symfony projects:
```yaml
doctrine:
dbal:
connections:
default:
# DATABASE_URL would be of "mysql://db_user:[email protected]:3306/db_name"
url: '%env(resolve:DATABASE_URL)%'
wrapper_class: 'Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Connection'
options:
x_reconnect_attempts: 3
```
An example of configuration on Laminas Framework 2projects:
```php
return [
'doctrine' => [
'connection' => [
'orm_default' => [
'wrapperClass' => \Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Connection::class,
'params' => [
'host' => 'localhost',
'port' => '3307',
'user' => '##user##',
'password' => '##password##',
'dbname' => '##database##',
'charset' => 'UTF8',
'driverOptions' => [
'x_reconnect_attempts' => 9,
]
],
],
],
],
];
```
You can use wrapper class `Facile\DoctrineMySQLComeBack\Doctrine\DBAL\Connections\PrimaryReadReplicaConnection` if you are using a primary/replica Doctrine configuration:
```php
use Doctrine\DBAL\Configuration;
use Doctrine\DBAL\DriverManager;
$config = new Configuration();
//..
$connectionParams = [
'wrapperClass' => 'Facile\DoctrineMySQLComeBack\Doctrine\DBAL\PrimaryReadReplicaConnection',
'primary' => [
// ...
'driverOptions' => [
'x_reconnect_attempts' => 3
],
],
];
$conn = DriverManager::getConnection($connectionParams, $config);
//..
```
# Usage
Since DBAL v3, `Connection::refresh` does not exist anymore, so you don't need to do anything else to leverage the reconnection, it will be automagically done.
From `v1.6` of this library automagically reconnection is enabled also during `$em->getConnection()->beginTransaction()` calls,
and this works also during simple `$em->flush()`, if out of a previous transaction.
# Thanks
Thanks to Dieter Peeters and his proposal on [DBAL-275](https://github.com/doctrine/dbal/issues/1454).
Check it out if you are using doctrine/dbal <2.3.