arntech/doctrine-timeout-handler

ARNTech Doctrine Timeout handler.

v0.0.2 2020-08-05 09:57 UTC

Requires

• php: ^5.6 || ^7.0
• facile-it/doctrine-mysql-come-back: *
• psr/log: *

GPL-3.0-only

• Alexandru Negrila

• doctrine
• timeout
• doctrine timeout
• time out
• doctrine time out

README

What is this?

It is a library that tries to handle DB connection timeouts and "The MySQL server has gone away (error 2006)" errors.

Installation

The preferred method of installation is via [Composer][]. Run the following command to install the package and add it as a requirement to your project's composer.json:

composer require arntech/doctrine-timeout-handler

Dependency

The library uses [psr/log][https://packagist.org/packages/psr/log] and [facile-it/doctrine-mysql-come-back][https://packagist.org/packages/facile-it/doctrine-mysql-come-back]

Configuration

It a similar configuration as facile-it solution (for a quick migration).

use Doctrine\DBAL\Configuration;
use Doctrine\DBAL\DriverManager;

$config = new Configuration();

$connectionParams = array(
    'dbname' => 'mydb',
    'user' => 'user',
    'password' => 'secret',
    'host' => 'localhost',
    // [doctrine-mysql-come-back] settings
    'wrapperClass' => 'ARNTech\DoctrineTimeout\Connection',
    'driverClass' => 'ARNTech\DoctrineTimeout\Driver\PDOMySql\Driver',
    'driverOptions' => array(
        'x_reconnect_attempts' => 3,
		'check_connection_beforehand' => true //this specifies to check if connection is still alive before executing anything
    )
);

$conn = DriverManager::getConnection($connectionParams, $config);

An example of yaml configuration on Symfony 2 projects:

# Doctrine example Configuration
doctrine:
    dbal:
        default_connection: %connection_name%
        connections:
            %connection_name%:
                host:     %database_host%
                port:     %database_port%
                dbname:   %database_name%
                user:     %database_user%
                password: %database_password%
                charset:  UTF8
                wrapper_class: 'ARNTech\DoctrineTimeout\Connection'
                driver_class: 'ARNTech\DoctrineTimeout\Driver\PDOMySql\Driver'
                options:
                    x_reconnect_attempts: 3
					check_connection_beforehand: true #this specifies to check if connection is still alive before executing anything

If you are setting up your database connection using a DSN/database_url env variable (like the Doctrine Symfony Flex recipe suggests) you need to remove the protocol from your database url. Otherwise, Doctrine is going to ignore your driver_class configuration and use the default protocol driver, which will lead you to an error.

doctrine:
    dbal:
        connections:
            default:
                # DATABASE_URL needs to be without driver protocol.  
                # use "//db_user:db_password@127.0.0.1:3306/db_name"
                # instead of "mysql://db_user:db_password@127.0.0.1:3306/db_name" 
                url: '%env(resolve:DATABASE_URL)%'
                wrapper_class: 'ARNTech\DoctrineTimeout\Connection'
                driver_class: 'ARNTech\DoctrineTimeout\Driver\PDOMySql\Driver'
                options:
                    x_reconnect_attempts: 3
					check_connection_beforehand: true #this specifies to check if connection is still alive before executing anything

An example of configuration on Zend Framework 2/3 projects:

return [
    'doctrine' => [
        'connection' => [
            'orm_default' => [
                'driverClass' => \ARNTech\DoctrineTimeout\Driver\PDOMySql\Driver::class,
                'wrapperClass' => \ARNTech\DoctrineTimeout\Connection::class,
                'params' => [
                    'host' => 'localhost',
                    'port' => '3307',
                    'user' => '##user##',
                    'password' => '##password##',
                    'dbname' => '##database##',
                    'charset' => 'UTF8',
                    'driverOptions' => [
                        'x_reconnect_attempts' => 9,
						'check_connection_beforehand' => true //this specifies to check if connection is still alive before executing anything
                    ]
                ],
            ],
        ],
    ],
];