Add Postgres support

db/knex_init_db.js

@@ -5,10 +5,11 @@ const { log } = require("../src/util");
  * ⚠️⚠️⚠️⚠️⚠️⚠️ DO NOT ADD ANYTHING HERE!
  * IF YOU NEED TO ADD FIELDS, ADD IT TO ./db/knex_migrations
  * See ./db/knex_migrations/README.md for more information
+ * @param {string} dbType "mariadb" or "postgres"
  * @returns {Promise<void>}
  */
-async function createTables() {
-    log.info("mariadb", "Creating basic tables for MariaDB");
+async function createTables(dbType) {
+    log.info(dbType, "Creating basic tables");
     const knex = R.knex;
 
     // TODO: Should check later if it is really the final patch sql file.

package.json

@@ -151,6 +151,7 @@
         "@fortawesome/vue-fontawesome": "~3.0.0-5",
         "@popperjs/core": "~2.10.2",
         "@types/bootstrap": "~5.1.9",
+        "@types/pg": "^8.10.2",
         "@vitejs/plugin-legacy": "~4.1.0",
         "@vitejs/plugin-vue": "~4.2.3",
         "@vue/compiler-sfc": "~3.3.4",

server/database.js

@@ -6,6 +6,7 @@ const knex = require("knex");
 const path = require("path");
 const { EmbeddedMariaDB } = require("./embedded-mariadb");
 const mysql = require("mysql2/promise");
+const pg = require("pg");
 
 /**
  * Database & App Data Folder
@@ -137,7 +138,7 @@ class Database {
      * Read the database config
      * @throws {Error} If the config is invalid
      * @typedef {string|undefined} envString
-     * @returns {{type: "sqlite"} | {type:envString, hostname:envString, port:envString, database:envString, username:envString, password:envString}} Database config
+     * @returns {{type: "sqlite" | "mariadb" | "embedded-mariadb" | "postgres"} | {type:envString, hostname:envString, port:envString, database:envString, username:envString, password:envString}} Database config
      */
     static readDBConfig() {
         let dbConfig;
@@ -157,13 +158,25 @@ class Database {
 
     /**
      * @typedef {string|undefined} envString
-     * @param {{type: "sqlite"} | {type:envString, hostname:envString, port:envString, database:envString, username:envString, password:envString}} dbConfig the database configuration that should be written
+     * @param {{type: "sqlite" | "mariadb" | "embedded-mariadb" | "postgres"} | {type:envString, hostname:envString, port:envString, database:envString, username:envString, password:envString}} dbConfig the database configuration that should be written
      * @returns {void}
      */
     static writeDBConfig(dbConfig) {
         fs.writeFileSync(path.join(Database.dataDir, "db-config.json"), JSON.stringify(dbConfig, null, 4));
     }
 
+    /**
+     * Validate a database name
+     * @param {string} dbName Database name to validate
+     * @throws {Error} If the database name is invalid
+     * @returns {void}
+     */
+    static validateDBName(dbName) {
+        if (!/^\w+$/.test(dbName)) {
+            throw Error("Invalid database name. A database name can only consist of letters, numbers and underscores");
+        }
+    }
+
     /**
      * Connect to the database
      * @param {boolean} testMode Should the connection be started in test mode?
@@ -195,7 +208,6 @@ class Database {
         log.info("db", `Database Type: ${dbConfig.type}`);
 
         if (dbConfig.type === "sqlite") {
-
             if (! fs.existsSync(Database.sqlitePath)) {
                 log.info("server", "Copying Database");
                 fs.copyFileSync(Database.templatePath, Database.sqlitePath);
@@ -220,9 +232,7 @@ class Database {
                 }
             };
         } else if (dbConfig.type === "mariadb") {
-            if (!/^\w+$/.test(dbConfig.dbName)) {
-                throw Error("Invalid database name. A database name can only consist of letters, numbers and underscores");
-            }
+            this.validateDBName(dbConfig.dbName);
 
             const connection = await mysql.createConnection({
                 host: dbConfig.hostname,
@@ -259,6 +269,24 @@ class Database {
                 },
                 pool: mariadbPoolConfig,
             };
+        } else if (dbConfig.type === "postgres") {
+            this.validateDBName(dbConfig.dbName);
+
+            const clientConfig = {
+                host: dbConfig.hostname,
+                port: dbConfig.port,
+                user: dbConfig.username,
+                password: dbConfig.password,
+                database: dbConfig.dbName,
+            };
+            const client = new pg.Client(clientConfig);
+            await client.execute("CREATE DATABASE IF NOT EXISTS " + dbConfig.dbName);
+            await client.end();
+
+            config = {
+                client: "pg",
+                connection: clientConfig,
+            };
         } else {
             throw new Error("Unknown Database type: " + dbConfig.type);
         }
@@ -291,6 +319,8 @@ class Database {
             await this.initSQLite(testMode, noLog);
         } else if (dbConfig.type.endsWith("mariadb")) {
             await this.initMariaDB();
+        } else if (dbConfig.type === "postgres") {
+            await this.initPostgres();
         }
     }
 
@@ -340,6 +370,22 @@ class Database {
         }
     }
 
+    /**
+     * Initialize PostgresDB
+     * @returns {Promise<void>}
+     */
+    static async initPostgres() {
+        log.debug("db", "Checking if PostgresDB database exists...");
+
+        let hasTable = await R.hasTable("docker_host");
+        if (!hasTable) {
+            const { createTables } = require("../db/knex_init_db");
+            await createTables();
+        } else {
+            log.debug("db", "PostgresDB database already exists");
+        }
+    }
+
     /**
      * Patch the database
      * @returns {void}
@@ -657,13 +703,17 @@ class Database {
 
     /**
      * @returns {string} Get the SQL for the current time plus a number of hours
+     * @throws {Error} If the database type is unknown
      */
     static sqlHourOffset() {
         if (Database.dbConfig.type === "sqlite") {
             return "DATETIME('now', ? || ' hours')";
-        } else {
+        } else if (Database.dbConfig.type.endsWith("mariadb")) {
             return "DATE_ADD(NOW(), INTERVAL ? HOUR)";
+        } else if (Database.dbConfig.type === "postgres") {
+            return "NOW() + INTERVAL '? HOUR'";
         }
+        throw new Error("Unknown database type: " + Database.dbConfig.type);
     }
 
 }