http://www.doctrine-project.org/jira This file is an XML representation of an issue en-us 5.2.7 850 21-02-2013 http://www.doctrine-project.org/jira/browse/DBAL-20 Doctrine DBAL <p>There should be an additional, optional "connectionResolver" which returns a driver instance for differentation between different drivers in Doctrine\DBAL\Connection instead of using $this-&gt;_conn (which stays the default case)</p> <p>This is useful for master/slave, master/master or failover strategies inside the application</p> DBAL-20

Add Connection Resolver

New Feature Major Resolved Fixed Benjamin Eberlei Benjamin Eberlei Sun, 13 Jun 2010 06:32:54 +0000 Sun, 1 Apr 2012 16:10:21 +0000 Mon, 19 Dec 2011 14:56:53 +0000 2.2 3 3 <p>I have done some working code, I extended \Doctrine\DBAL\Connection:</p> <p>From the controllers/ service layer:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">$em-&gt;getConnection()-&gt;setConnection('write'); <span class="code-keyword">try</span> { $em-&gt;persist($user); } <span class="code-keyword">catch</span> (Exception $e) { echo $e-&gt;getMessage(); } $em-&gt;getConnection()-&gt;setConnection('read_1'); ... $em-&gt;getConnection()-&gt;setConnection('read_2'); </pre> </div></div> <p>Obviously all the statements related with a unit of work will be associated with only one connection.</p> <p>_________________________________________</p> <p>When setting the event manager:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> $connectionOptions = array( 'driver' =&gt; $doctrineConfig['conn']['driv'], 'user' =&gt; $doctrineConfig['conn']['user'], 'password' =&gt; $doctrineConfig['conn']['pass'], 'dbname' =&gt; $doctrineConfig['conn']['dbname'], 'host' =&gt; $doctrineConfig['conn']['host'], 'wrapperClass' =&gt;'\Fishpond\Doctrine\DBAL\Connections\Multiple' ); $connectionOptions['multiple_connections']['read'] = array( <span class="code-quote">"driver"</span> =&gt; <span class="code-quote">"pdo_mysql"</span>, <span class="code-quote">"user"</span> = <span class="code-quote">"password"</span> =&gt; <span class="code-quote">"dbname"</span>=&gt; <span class="code-quote">"host"</span> =&gt; ); $connectionOptions['multiple_connections']['write'] = array( <span class="code-quote">"driver"</span> =&gt; <span class="code-quote">"pdo_mysql"</span>, <span class="code-quote">"user"</span> =&gt; <span class="code-quote">"password"</span> =&gt; <span class="code-quote">"dbname"</span>=&gt; <span class="code-quote">"host"</span> =&gt; ); $em = \Doctrine\ORM\EntityManager::create($connectionOptions, $config); </pre> </div></div> <p>_________________________________________</p> <p>The new connection class itself:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">namespace Fishpond\Doctrine\DBAL\Connections; class Multiple <span class="code-keyword">extends</span> \Doctrine\DBAL\Connection { /** * An array with the different database connection used by the EntityManager. * * @<span class="code-keyword">var</span> array of Doctrine\DBAL\Connection */ <span class="code-keyword">private</span> $_connections; /** * The index that indicate which * connection is used, <span class="code-keyword">if</span> <span class="code-keyword">this</span> index is <span class="code-keyword">null</span> * the defaul connection is used * * @<span class="code-keyword">var</span> <span class="code-object">String</span> */ <span class="code-keyword">private</span> $_selectedConnection; /** * Initializes a <span class="code-keyword">new</span> instance of the Connection class. * * @param array $params The connection parameters. * @param Driver $driver * @param Configuration $config * @param EventManager $eventManager */ <span class="code-keyword">public</span> function __construct(array $params, Driver $driver, Configuration $config = <span class="code-keyword">null</span>, EventManager $eventManager = <span class="code-keyword">null</span>) { parent::__construct($params, $driver, $config, $eventManager); foreach ($params['multiple_connections'] as $connectionKey =&gt; $paramsMultipleConnection) { $<span class="code-keyword">this</span>-&gt;_connections[$connectionKey] = <span class="code-keyword">new</span> \Doctrine\DBAL\Connection($paramsMultipleConnection, $driver, $config, $eventManager); } } <span class="code-keyword">public</span> function setConnection($selectedConnection) { $<span class="code-keyword">this</span>-&gt;_selectedConnection = $selectedConnection; <span class="code-keyword">return</span> $<span class="code-keyword">this</span>; } /** * Establishes the connection with the database. * * @<span class="code-keyword">return</span> <span class="code-object">boolean</span> TRUE <span class="code-keyword">if</span> the connection was successfully established, FALSE <span class="code-keyword">if</span> * the connection is already open. */ <span class="code-keyword">public</span> function connect() { $status = parent::connect(); <span class="code-keyword">if</span> ($status == <span class="code-keyword">false</span>) { <span class="code-keyword">return</span> <span class="code-keyword">false</span>; } foreach ($<span class="code-keyword">this</span>-&gt;_connections as $connection) { $connection-&gt;connect(); } <span class="code-keyword">return</span> <span class="code-keyword">true</span>; } /** * Executes an, optionally parameterized, SQL query. * * If the query is parameterized, a prepared statement is used. * If an SQLLogger is configured, the execution is logged. * * @param string $query The SQL query to execute. * @param array $params The parameters to bind to the query, <span class="code-keyword">if</span> any. * @<span class="code-keyword">return</span> Doctrine\DBAL\Driver\Statement The executed statement. * @internal PERF: Directly prepares a driver statement, not a wrapper. */ <span class="code-keyword">public</span> function executeQuery($query, array $params = array(), $types = array()) { <span class="code-keyword">if</span> ($<span class="code-keyword">this</span>-&gt;_selectedConnection == <span class="code-keyword">null</span>) { <span class="code-keyword">return</span> parent::executeQuery($query, $params, $types); } <span class="code-keyword">return</span> $<span class="code-keyword">this</span>-&gt;_connections[$<span class="code-keyword">this</span>-&gt;_selectedConnection]-&gt;executeQuery($query, $params, $types); } /** * Starts a transaction by suspending auto-commit mode. * * @<span class="code-keyword">return</span> void */ <span class="code-keyword">public</span> function beginTransaction() { parent::beginTransaction(); foreach ($<span class="code-keyword">this</span>-&gt;_connections as $connection) { $connection-&gt;beginTransaction(); } } /** * Commits the current transaction. * * @<span class="code-keyword">return</span> void * @<span class="code-keyword">throws</span> ConnectionException If the commit failed due to no active transaction or * because the transaction was marked <span class="code-keyword">for</span> rollback only. */ <span class="code-keyword">public</span> function commit() { parent::commit(); foreach ($<span class="code-keyword">this</span>-&gt;_connections as $connection) { $connection-&gt;commit(); } } /** * Gets the wrapped driver connection. * * @<span class="code-keyword">return</span> Doctrine\DBAL\Driver\Connection */ <span class="code-keyword">public</span> function getWrappedConnection() { <span class="code-keyword">if</span> ($<span class="code-keyword">this</span>-&gt;_selectedConnection == <span class="code-keyword">null</span>) { <span class="code-keyword">return</span> parent::getWrappedConnection(); } <span class="code-keyword">return</span> $<span class="code-keyword">this</span>-&gt;_connections[$<span class="code-keyword">this</span>-&gt;_selectedConnection]-&gt;getWrappedConnection(); } </pre> </div></div> <p> ..........<br/> ........</p> <p>The class is working so far (need much more testing), but the idea is if is not selected a connection it will work as it is now. Also, an 'automatic' selection of the connection could happen in an event listener, where we could define rules about which connection should be used for different conditions/entities.</p> <p>Rescheduled for Beta4</p> <p>We could even move this post-2.0 since this is a new feature and carries the risk of opening a set of new issues.</p> <p>Here is what we use in production for a few weeks now:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">&lt;?php namespace Jarlssen\Doctrine2\DBAL; use Doctrine\DBAL\Connection, Doctrine\DBAL\Driver, Doctrine\ORM\Configuration, Doctrine\Common\EventManager, Doctrine\DBAL\Events; class MasterSlaveConnection <span class="code-keyword">extends</span> Connection { /** * Master connection * * @<span class="code-keyword">var</span> Doctrine\DBAL\Driver\Connection */ <span class="code-keyword">protected</span> $_masterConn; /** * Slave connection * * @<span class="code-keyword">var</span> Doctrine\DBAL\Driver\Connection */ <span class="code-keyword">protected</span> $_slaveConn; <span class="code-keyword">public</span> function __construct( array $params, Driver $driver, Configuration $config = <span class="code-keyword">null</span>, EventManager $eventManager = <span class="code-keyword">null</span> ) { <span class="code-keyword">if</span> (!isset($params['slaves']) or !isset($params['master'])) { <span class="code-keyword">throw</span> <span class="code-keyword">new</span> \InvalidArgumentsException('master or slaves configuration missing'); } $params['master']['driver'] = $params['driver']; foreach ($params['slaves'] as &amp;$slave) { $slave['driver'] = $params['driver']; } parent::__construct($params, $driver, $config, $eventManager); } <span class="code-keyword">public</span> function connect($connectionName = 'slave') { $forceMasterAsSlave = <span class="code-keyword">false</span>; <span class="code-keyword">if</span> ($<span class="code-keyword">this</span>-&gt;getTransactionNestingLevel() &gt; 0) { $connectionName = 'master'; $forceMasterAsSlave = <span class="code-keyword">true</span>; } $connectionProperty = '_' . $connectionName . 'Conn'; <span class="code-keyword">if</span> ($<span class="code-keyword">this</span>-&gt;{$connectionProperty}) { <span class="code-keyword">if</span> ($forceMasterAsSlave) { $<span class="code-keyword">this</span>-&gt;_slaveConn = $<span class="code-keyword">this</span>-&gt;_conn = $<span class="code-keyword">this</span>-&gt;_masterConn; } <span class="code-keyword">else</span> { $<span class="code-keyword">this</span>-&gt;_conn = $<span class="code-keyword">this</span>-&gt;{$connectionProperty}; } <span class="code-keyword">return</span> <span class="code-keyword">false</span>; } <span class="code-keyword">if</span> ($connectionName === 'master') { /** Set master and slave connection to master to avoid invalid reads */ $<span class="code-keyword">this</span>-&gt;_masterConn = $<span class="code-keyword">this</span>-&gt;_slaveConn = $<span class="code-keyword">this</span>-&gt;_conn = $<span class="code-keyword">this</span>-&gt;_connectTo($connectionName); } <span class="code-keyword">else</span> { $<span class="code-keyword">this</span>-&gt;_slaveConn = $<span class="code-keyword">this</span>-&gt;_conn = $<span class="code-keyword">this</span>-&gt;_connectTo($connectionName); } <span class="code-keyword">if</span> ($<span class="code-keyword">this</span>-&gt;_eventManager-&gt;hasListeners(Events::postConnect)) { $eventArgs = <span class="code-keyword">new</span> Event\ConnectionEventArgs($<span class="code-keyword">this</span>); $<span class="code-keyword">this</span>-&gt;_eventManager-&gt;dispatchEvent(Events::postConnect, $eventArgs); } <span class="code-keyword">return</span> <span class="code-keyword">true</span>; } <span class="code-keyword">protected</span> function _connectTo($connectionName) { $params = $<span class="code-keyword">this</span>-&gt;getParams(); $driverOptions = isset($params['driverOptions']) ? $params['driverOptions'] : array(); $connectionParams = $<span class="code-keyword">this</span>-&gt;_chooseConnectionConfiguration($connectionName, $params); $user = isset($connectionParams['user']) ? $connectionParams['user'] : <span class="code-keyword">null</span>; $password = isset($connectionParams['password']) ? $connectionParams['password'] : <span class="code-keyword">null</span>; <span class="code-keyword">return</span> $<span class="code-keyword">this</span>-&gt;_driver-&gt;connect($connectionParams, $user, $password, $driverOptions); } <span class="code-keyword">protected</span> function _chooseConnectionConfiguration($connectionName, $params) { <span class="code-keyword">if</span> ($connectionName === 'master') { <span class="code-keyword">return</span> $params['master']; } <span class="code-keyword">return</span> $params['slaves'][array_rand($params['slaves'])]; } <span class="code-keyword">public</span> function executeUpdate($query, array $params = array(), array $types = array()) { <span class="code-keyword">try</span> { <span class="code-keyword">if</span> (strpos(strtolower($query), 'delete from member_profile') === 0) { <span class="code-keyword">throw</span> <span class="code-keyword">new</span> \Exception($query); } $<span class="code-keyword">this</span>-&gt;connect('master'); <span class="code-keyword">return</span> parent::executeUpdate($query, $params, $types); } <span class="code-keyword">catch</span>(\Exception $e) { $errorLog = 'error_'.'log'; $errorLog(__METHOD__); $errorLog($e-&gt;getMessage()); $errorLog($e-&gt;getTraceAsString()); <span class="code-keyword">return</span> <span class="code-keyword">false</span>; } } <span class="code-keyword">public</span> function beginTransaction() { $<span class="code-keyword">this</span>-&gt;connect('master'); <span class="code-keyword">return</span> parent::beginTransaction(); } <span class="code-keyword">public</span> function commit() { $<span class="code-keyword">this</span>-&gt;connect('master'); <span class="code-keyword">return</span> parent::commit(); } <span class="code-keyword">public</span> function rollback() { $<span class="code-keyword">this</span>-&gt;connect('master'); <span class="code-keyword">return</span> parent::rollback(); } <span class="code-keyword">public</span> function delete($tableName, array $identifier) { $<span class="code-keyword">this</span>-&gt;connect('master'); <span class="code-keyword">return</span> parent::delete($tableName, $identifier); } <span class="code-keyword">public</span> function update($tableName, array $data, array $identifier) { $<span class="code-keyword">this</span>-&gt;connect('master'); <span class="code-keyword">return</span> parent::update($tableName, $data, $identifier); } <span class="code-keyword">public</span> function insert($tableName, array $data) { $<span class="code-keyword">this</span>-&gt;connect('master'); <span class="code-keyword">return</span> parent::insert($tableName, $data); } <span class="code-keyword">public</span> function exec($statement) { $<span class="code-keyword">this</span>-&gt;connect('master'); <span class="code-keyword">return</span> parent::exec($statement); } <span class="code-keyword">public</span> function getWrappedConnection() { $<span class="code-keyword">this</span>-&gt;connect('master'); <span class="code-keyword">return</span> $<span class="code-keyword">this</span>-&gt;_conn; } } </pre> </div></div> <p>Hello.</p> <p>Is there are any news? When you planed to implement this feature?</p> <p>PLEASE add master/slave support to Doctrine DBAL 2. It's very important feature!</p> <p>Implemented</p> <p>I would consider this experimental, i have tested this in a master slave setup, but i can't guarantee it works 100% in combination with the ORM.</p> <p>See the class docblock comments of lib/doctrine/DBAL/connections/MasterSlaveConnection.php for more information on how it works.</p> <p>Thank you, Benjamin Eberlei!</p>