Switch from mysql to mysql2 for better database support (#338)

FalveyLibraryTechnology · Dec 19, 2024 · a69a072 · a69a072
1 parent 79255f9
commit a69a072
Show file tree

Hide file tree

Showing 4 changed files with 132 additions and 67 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 2.5 - TBD
+
+### Added
+
+- Nothing.
+
+### Changed
+
+- MySQL connections are now managed by the mysql2 driver instead of mysql for improved support/compatibility. If you use MySQL or MariaDB, be sure to change `mysql` to `mysql2` in your `api/vudl.ini` file!
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
 ## 2.4 - 2024-08-08
 
 ### Added

diff --git a/api/package-lock.json b/api/package-lock.json
diff --git a/api/package.json b/api/package.json
@@ -40,7 +40,7 @@
     "knex": "^2.4.2",
     "locutus": "^2",
     "morgan": "~1.9.1",
-    "mysql": "^2.18.1",
+    "mysql2": "^3.11.5",
     "n3": "^1",
     "nanoid": "^3.1.23",
     "needle": "^2.6.0",

diff --git a/api/vudl.ini.dist b/api/vudl.ini.dist
@@ -134,14 +134,14 @@ admin_user = admin_password
 
 # Database settings
 [Database]
-# Supported values: mysql, sqlite3
+# Supported values: mysql2, sqlite3
 client = sqlite3
 
 # Database connection settings (required values vary based on client setting above)
 [Database.connection]
 # Required when client = sqlite3; filename of database, relative to api directory
 filename = "./data/auth.sqlite3"
-# Required when client = mysql
+# Required when client = mysql2
 # To set up a MySQL/MariaDB database, run these commands in the database client:
 #    create database vudl;
 #    create user 'your_database_user'@'localhost' identified by 'your_database_password';