doc

Author: antgonza

CONTRIBUTING.md

@@ -94,6 +94,18 @@ After the initial production release of Qiita, changes to the database schema wi
 2. We keep fully patched versions of the DBS and HTML files in the repository
 3. We keep a patch file for each patch as required in the `qiita_db/support_files/patches` directory. Note that **the patches will be applied in order based on the natural sort order of their filename** (e.g., `2.sql` will be applied before `10.sql`, and `10.sql` will be applied before `a.sql`)
 
+### Patch 91.sql
+
+In May 2024 we decided to:
+* Merge all patches into the main database, this means that there are no patches younger than 92.sql.
+* Not allow INSERT/UPDATE queries within the main *.sql patches, to minimize the possibility of unnexpected changes.
+* Added a new folder `patches/test_db_sql/` where we can store sql files that will only be applied for the test environment.
+
+Note that these changes mean:
+1. 92.sql is the current first sql file to patch the database.
+2. If you need to make changes to both the production and tests database you will need to use the *.py.
+3. If you need to make changes _only_ to the tests database you need to add a patch to `patches/test_db_sql/`.
+
 ### Developer Workflow
 
 1. Load the fully patched DBS file (e.g., `qiita-db.dbs`) in [DBSchema](http://www.dbschema.com/)

qiita_db/environment_manager.py

@@ -397,6 +397,7 @@ def patch(patches_dir=PATCHES_DIR, verbose=False, test=False):
         with qdb.sql_connection.TRN:
             _populate_test_db()
 
+    not_allowed_matches = ["insert", "update"]
     patch_update_sql = "UPDATE settings SET current_patch = %s"
     for sql_patch_fp in sql_patch_files[next_patch_index:]:
         sql_patch_filename = basename(sql_patch_fp)
@@ -410,7 +411,19 @@ def patch(patches_dir=PATCHES_DIR, verbose=False, test=False):
                 if verbose:
                     print('\tApplying patch %s...' % sql_patch_filename)
 
-                qdb.sql_connection.TRN.add(patch_file.read())
+                sql = patch_file.read()
+                sql_test = any([m in l
+                                for l in sql.split('\n')
+                                if not l.startswith('--')
+                                for m in not_allowed_matches])
+                if sql_test:
+                     msg = (
+                         f"Patch '{basename(sql_patch_fp)}' has an invalid "
+                         f"'match {not_allowed_matches}'; please move them a "
+                         f"test patch.\n*********{sql}\n*********")
+                     raise ValueError(msg)
+
+                qdb.sql_connection.TRN.add(sql)
                 qdb.sql_connection.TRN.add(
                     patch_update_sql, [sql_patch_filename])