Merge pull request #6939 from kenjis/feat-sqlite3-busyTimeout

feat: add SQLite3 Config busyTimeout

Author: kenjis

app/Config/Database.php

@@ -67,6 +67,7 @@ class Database extends Config
         'failover'    => [],
         'port'        => 3306,
         'foreignKeys' => true,
+        'busyTimeout' => 1000,
     ];
 
     public function __construct()

system/Database/SQLite3/Connection.php

@@ -45,13 +45,26 @@ class Connection extends BaseConnection
      */
     protected $foreignKeys = false;
 
+    /**
+     * The milliseconds to sleep
+     *
+     * @var int|null milliseconds
+     *
+     * @see https://www.php.net/manual/en/sqlite3.busytimeout
+     */
+    protected $busyTimeout;
+
     public function initialize()
     {
         parent::initialize();
 
         if ($this->foreignKeys) {
             $this->enableForeignKeyChecks();
         }
+
+        if (is_int($this->busyTimeout)) {
+            $this->connID->busyTimeout($this->busyTimeout);
+        }
     }
 
     /**

user_guide_src/source/changelogs/v4.3.0.rst

@@ -225,6 +225,7 @@ Forge
 Others
 ------
 
+- SQLite3 has a new Config item ``busyTimeout`` to set timeout when a table is locked.
 - ``BaseConnection::escape()`` now excludes the ``RawSql`` data type. This allows passing SQL strings into data.
 - Improved data returned by :ref:`BaseConnection::getForeignKeyData() <metadata-getforeignkeydata>`. All DBMS returns the same structure.
 - SQLite :ref:`BaseConnection::getIndexData() <db-metadata-getindexdata>` now can return pseudo index named ``PRIMARY`` for `AUTOINCREMENT` column, and each returned index data has ``type`` property.

user_guide_src/source/database/configuration.rst

@@ -148,6 +148,7 @@ Explanation of Values:
                 .. important:: SQLite3 Foreign Key constraint is disabled by default.
                     See `SQLite documentation <https://www.sqlite.org/pragma.html#pragma_foreign_keys>`_.
                     To enforce Foreign Key constraint, set this config item to true.
+**busyTimeout** milliseconds (int) - Sleeps for a specified amount of time when a table is locked (``SQLite3`` only).
 =============== ===========================================================================================================
 
 .. note:: Depending on what database driver you are using (``MySQLi``, ``Postgres``,