Ability to disable auto slave select for all read queries (#289)

sartor · web-flow · commit 0d22ee4e5dd2 · 2022-03-25T15:55:23.000+03:00
diff --git a/src/Command/Command.php b/src/Command/Command.php
@@ -280,7 +280,7 @@ public function prepare(?bool $forRead = null): void
 
         $sql = $this->getSql();
 
-        if ($this->db->getTransaction()) {
+        if ($this->db->getTransaction() || !$this->db->isAutoSlaveForReadQueriesEnabled()) {
             /** master is in a transaction. use the same connection. */
             $forRead = false;
         }
diff --git a/src/Connection/Connection.php b/src/Connection/Connection.php
@@ -176,6 +176,7 @@ abstract class Connection implements ConnectionInterface
     private bool $enableSavepoint = true;
     private int $serverRetryInterval = 600;
     private bool $enableSlaves = true;
+    private bool $enableAutoSlaveForReadQueries = true;
     private array $slaves = [];
     private array $masters = [];
     private bool $shuffleMasters = true;
@@ -372,6 +373,11 @@ public function areSlavesEnabled(): bool
         return $this->enableSlaves;
     }
 
+    public function isAutoSlaveForReadQueriesEnabled(): bool
+    {
+        return $this->enableAutoSlaveForReadQueries;
+    }
+
     /**
      * Returns a value indicating whether the DB connection is established.
      *
@@ -888,6 +894,11 @@ public function setEnableSlaves(bool $value): void
         $this->enableSlaves = $value;
     }
 
+    public function setEnableAutoSlaveForReadQueries(bool $value): void
+    {
+        $this->enableAutoSlaveForReadQueries = $value;
+    }
+
     /**
      * Set connection for master server, you can specify multiple connections, adding the id for each one.
      *
diff --git a/src/Connection/ConnectionInterface.php b/src/Connection/ConnectionInterface.php
@@ -69,6 +69,14 @@ public function getServerVersion(): string;
      */
     public function getTableSchema(string $name, $refresh = false): ?TableSchema;
 
+    /**
+     * Whether to enable auto recogintion of read queries and use slave (if enabled) for execute.
+     *
+     * @return bool For default `true` use slave for read queries, `false` use master connection (for reads and writes).
+     * Slave still can be used via $this->getSlave().
+     */
+    public function isAutoSlaveForReadQueriesEnabled(): bool;
+
     /**
      * Whether to enable read/write splitting by using {@see setSlaves()} to read data. Note that if {@see setSlaves()}
      * is empty, read/write splitting will NOT be enabled no matter what value this property takes.
diff --git a/src/TestUtility/TestConnectionTrait.php b/src/TestUtility/TestConnectionTrait.php
@@ -384,4 +384,13 @@ public function testClone(): void
         $this->assertNull($conn3->getTransaction());
         $this->assertNull($conn3->getPDO());
     }
+
+    public function testDisableAutoSlaveForReads(): void
+    {
+        $db = $this->getConnection();
+        $this->assertTrue($db->isAutoSlaveForReadQueriesEnabled());
+
+        $db->setEnableAutoSlaveForReadQueries(false);
+        $this->assertFalse($db->isAutoSlaveForReadQueriesEnabled());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -280,7 +280,7 @@ public function prepare(?bool $forRead = null): void`
`280`	`280`
`281`	`281`	`$sql = $this->getSql();`
`282`	`282`
`283`		`- if ($this->db->getTransaction()) {`
	`283`	`+ if ($this->db->getTransaction() \|\| !$this->db->isAutoSlaveForReadQueriesEnabled()) {`
`284`	`284`	`/** master is in a transaction. use the same connection. */`
`285`	`285`	`$forRead = false;`
`286`	`286`	`}`
Original file line number	Diff line number	Diff line change
`@@ -384,4 +384,13 @@ public function testClone(): void`
`384`	`384`	`$this->assertNull($conn3->getTransaction());`
`385`	`385`	`$this->assertNull($conn3->getPDO());`
`386`	`386`	`}`
	`387`	`+`
	`388`	`+ public function testDisableAutoSlaveForReads(): void`
	`389`	`+ {`
	`390`	`+ $db = $this->getConnection();`
	`391`	`+ $this->assertTrue($db->isAutoSlaveForReadQueriesEnabled());`
	`392`	`+`
	`393`	`+ $db->setEnableAutoSlaveForReadQueries(false);`
	`394`	`+ $this->assertFalse($db->isAutoSlaveForReadQueriesEnabled());`
	`395`	`+ }`
`387`	`396`	`}`