[3.x-dev] New option to set sql_big_selects on MySQL/MariaDB

src/DatabaseInterface.php

@@ -159,6 +159,28 @@ public function getConnectionEncryption(): string;
      */
     public function isConnectionEncryptionSupported(): bool;
 
+    /**
+     * Method to get the sql_big_selects session variable.
+     *
+     * If the connector doesn't support reporting this value please return false.
+     *
+     * @return  boolean  Whether sql_big_selects is enabled or not.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getSqlBigSelects(): bool;
+
+    /**
+     * Method to get the max_join_size session variable.
+     *
+     * If the connector doesn't support reporting this value please return an empty string.
+     *
+     * @return  string  max_join_size value.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getMaxJoinSize(): string;
+
     /**
      * Method to check whether the installed database version is supported by the database driver
      *

src/Mysql/MysqlDriver.php

@@ -127,6 +127,12 @@ public function __construct(array $options)
         $options['charset']  = $options['charset'] ?? 'utf8';
         $options['sqlModes'] = isset($options['sqlModes']) ? (array) $options['sqlModes'] : $sqlModes;
 
+        // Ignore sqlBigSelects if maxJoinSize is explicitly set.
+        $options['sqlBigSelects'] = isset($options['sqlBigSelects']) && !isset($options['maxJoinSize']) ? (bool) $options['sqlBigSelects'] : null;
+
+        // Ignore maxJoinSize if sqlBigSelects is explicitly enabled.
+        $options['maxJoinSize'] = isset($options['maxJoinSize']) && $options['sqlBigSelects'] !== true ? $options['maxJoinSize'] : null;
+
         $this->charset = $options['charset'];
 
         /*
@@ -221,6 +227,16 @@ public function connect()
             $this->connection->query('SET @@SESSION.sql_mode = \'' . implode(',', $this->options['sqlModes']) . '\';');
         }
 
+        // Set sql_big_selects if value provided in options
+        if ($this->options['sqlBigSelects'] !== null) {
+            $this->connection->query('SET @@SESSION.sql_big_selects = ' . ($this->options['sqlBigSelects'] ? '1' : '0') . ';');
+        }
+
+        // Set max_join_size if value provided in options
+        if ($this->options['maxJoinSize'] !== null) {
+            $this->connection->query('SET @@SESSION.max_join_size = ' . $this->options['maxJoinSize'] . ';');
+        }
+
         $this->setOption(\PDO::ATTR_EMULATE_PREPARES, true);
     }
 
@@ -369,6 +385,36 @@ public function isConnectionEncryptionSupported(): bool
         return !empty($variables['have_ssl']->Value) && $variables['have_ssl']->Value === 'YES';
     }
 
+    /**
+     * Method to get the sql_big_selects session variable.
+     *
+     * If the connector doesn't support reporting this value please return false.
+     *
+     * @return  boolean  Whether sql_big_selects is enabled or not.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getSqlBigSelects(): bool
+    {
+        $this->connect();
+
+        return $this->setQuery('SELECT @@sql_big_selects;')->loadResult() == 1;
+    }
+
+    /**
+     * Method to get the max_join_size session variable.
+     *
+     * If the connector doesn't support reporting this value please return an empty string.
+     *
+     * @return  string  max_join_size value.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getMaxJoinSize(): string
+    {
+        return $this->setQuery('SELECT @@max_join_size;')->loadResult();
+    }
+
     /**
      * Return the query string to create new Database.
      *

src/Mysqli/MysqliDriver.php

@@ -136,6 +136,12 @@ public function __construct(array $options)
             $options['ssl']['verify_server_cert'] = isset($options['ssl']['verify_server_cert']) ? $options['ssl']['verify_server_cert'] : null;
         }
 
+        // Ignore sqlBigSelects if maxJoinSize is explicitly set.
+        $options['sqlBigSelects'] = isset($options['sqlBigSelects']) && !isset($options['maxJoinSize']) ? (bool) $options['sqlBigSelects'] : null;
+
+        // Ignore maxJoinSize if sqlBigSelects is explicitly enabled.
+        $options['maxJoinSize'] = isset($options['maxJoinSize']) && $options['sqlBigSelects'] !== true ? $options['maxJoinSize'] : null;
+
         // Finalize initialisation.
         parent::__construct($options);
     }
@@ -307,6 +313,15 @@ public function connect()
         // And read the real sql mode to mitigate changes in mysql > 5.7.+
         $this->options['sqlModes'] = explode(',', $this->setQuery('SELECT @@SESSION.sql_mode;')->loadResult());
 
+        // Set sql_big_selects if value provided in options
+        if ($this->options['sqlBigSelects'] !== null) {
+            $this->connection->query('SET @@SESSION.sql_big_selects = ' . ($this->options['sqlBigSelects'] ? '1' : '0') . ';');
+        }
+
+        // Set max_join_size if value provided in options
+        if ($this->options['maxJoinSize'] !== null) {
+            $this->connection->query('SET @@SESSION.max_join_size = ' . $this->options['maxJoinSize'] . ';');
+        }
         // If auto-select is enabled select the given database.
         if ($this->options['select'] && !empty($this->options['database'])) {
             $this->select($this->options['database']);
@@ -514,6 +529,36 @@ public function isConnectionEncryptionSupported(): bool
         return !empty($variables['have_ssl']->Value) && $variables['have_ssl']->Value === 'YES';
     }
 
+    /**
+     * Method to get the sql_big_selects session variable.
+     *
+     * If the connector doesn't support reporting this value please return false.
+     *
+     * @return  boolean  Whether sql_big_selects is enabled or not.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getSqlBigSelects(): bool
+    {
+        $this->connect();
+
+        return $this->setQuery('SELECT @@sql_big_selects;')->loadResult() == 1;
+    }
+
+    /**
+     * Method to get the max_join_size session variable.
+     *
+     * If the connector doesn't support reporting this value please return an empty string.
+     *
+     * @return  string  max_join_size value.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getMaxJoinSize(): string
+    {
+        return $this->setQuery('SELECT @@max_join_size;')->loadResult();
+    }
+
     /**
      * Return the query string to create new Database.
      *

src/Pgsql/PgsqlDriver.php

@@ -176,6 +176,34 @@ public function isConnectionEncryptionSupported(): bool
         return !empty($variables['ssl']) && $variables['ssl'] === 'on';
     }
 
+    /**
+     * Method to get the sql_big_selects session variable.
+     *
+     * If the connector doesn't support reporting this value please return false.
+     *
+     * @return  boolean  Whether sql_big_selects is enabled or not.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getSqlBigSelects(): bool
+    {
+        return false;
+    }
+
+    /**
+     * Method to get the max_join_size session variable.
+     *
+     * If the connector doesn't support reporting this value please return an empty string.
+     *
+     * @return  string  max_join_size value.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getMaxJoinSize(): string
+    {
+        return '';
+    }
+
     /**
      * Internal function to get the name of the default schema for the current PostgreSQL connection.
      * That is the schema where tables are created by Joomla.

src/Sqlite/SqliteDriver.php

@@ -203,6 +203,34 @@ public function isConnectionEncryptionSupported(): bool
         return false;
     }
 
+    /**
+     * Method to get the sql_big_selects session variable.
+     *
+     * If the connector doesn't support reporting this value please return false.
+     *
+     * @return  boolean  Whether sql_big_selects is enabled or not.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getSqlBigSelects(): bool
+    {
+        return false;
+    }
+
+    /**
+     * Method to get the max_join_size session variable.
+     *
+     * If the connector doesn't support reporting this value please return an empty string.
+     *
+     * @return  string  max_join_size value.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getMaxJoinSize(): string
+    {
+        return '';
+    }
+
     /**
      * Shows the table CREATE statement that creates the given tables.
      *

src/Sqlsrv/SqlsrvDriver.php

@@ -369,6 +369,34 @@ public function isConnectionEncryptionSupported(): bool
         return false;
     }
 
+    /**
+     * Method to get the sql_big_selects session variable.
+     *
+     * If the connector doesn't support reporting this value please return false.
+     *
+     * @return  boolean  Whether sql_big_selects is enabled or not.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getSqlBigSelects(): bool
+    {
+        return false;
+    }
+
+    /**
+     * Method to get the max_join_size session variable.
+     *
+     * If the connector doesn't support reporting this value please return an empty string.
+     *
+     * @return  string  max_join_size value.
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getMaxJoinSize(): string
+    {
+        return '';
+    }
+
     /**
      * Retrieves field information about the given tables.
      *