Merge pull request #6050 from kenjis/fix-sqlite-foreign_keys

fix: add config for SQLite3 Foreign Keys
codeigniter4 · May 30, 2022 · 4cf4f0f · 4cf4f0f
2 parents c605069 + 214f2d9
commit 4cf4f0f
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/system/Database/SQLite3/Connection.php b/system/Database/SQLite3/Connection.php
@@ -37,6 +37,20 @@ class Connection extends BaseConnection
      */
     public $escapeChar = '`';
 
+    /**
+     * @var bool Enable Foreign Key constraint or not
+     */
+    protected $foreignKeys = false;
+
+    public function initialize()
+    {
+        parent::initialize();
+
+        if ($this->foreignKeys) {
+            $this->enableForeignKeyChecks();
+        }
+    }
+
     /**
      * Connect to the database.
      *

diff --git a/user_guide_src/source/database/configuration.rst b/user_guide_src/source/database/configuration.rst
@@ -105,9 +105,9 @@ default group's configuration settings. The values should be name following this
 Explanation of Values:
 **********************
 
-==============  ===========================================================================================================
+=============== ===========================================================================================================
  Name Config    Description
-==============  ===========================================================================================================
+=============== ===========================================================================================================
 **dsn**         The DSN connect string (an all-in-one configuration sequence).
 **hostname**    The hostname of your database server. Often this is 'localhost'.
 **username**    The username used to connect to the database.
@@ -140,8 +140,12 @@ Explanation of Values:
 **port**        The database port number. To use this value you have to add a line to the database config array.
 
                 .. literalinclude:: configuration/009.php
+**foreignKeys** true/false (boolean) - Whether or not to enable Foreign Key constraint (``SQLite3`` only).
 
-==============  ===========================================================================================================
+                .. 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.
+=============== ===========================================================================================================
 
 .. note:: Depending on what database platform you are using (MySQL, PostgreSQL,
     etc.) not all values will be needed. For example, when using SQLite you