feat!: remove support for postgresql (#263)

BREAKING CHANGE: This commit removes support for postgresql as it was
unmaintained and untested. Removing the code will make maintenance easier.

Please note that this does not mean that postgresql will never be supported,
if there is demand for other databases than SQLite, it will be evaluated.

Author: morremeyer

.vscode/launch.json

@@ -12,22 +12,6 @@
         "GIN_MODE": "debug"
       },
       "console": "integratedTerminal"
-    },
-    {
-      "name": "Run API (postgresql in compose)",
-      "type": "go",
-      "request": "launch",
-      "mode": "auto",
-      "cwd": "${workspaceFolder}",
-      "program": "${workspaceFolder}/main.go",
-      "env": {
-        "LOG_LEVEL": "debug",
-        "DB_HOST": "localhost",
-        "DB_USER": "ez",
-        "DB_PASSWORD": "thisisunsafe",
-        "DB_NAME": "postgres"
-      },
-      "console": "integratedTerminal"
     }
   ]
 }

README.md

@@ -21,7 +21,7 @@ See [docs/upgrading.md](docs/upgrading.md).
 
 ### Configuration
 
-:warning: If you do not configure a postgresql database, sqlite will automatically be used. Mount a persistent volume to the `/data` directory - this is where the sqlite database is stored. If you do not do this, you will lose all data every time the container is deleted.
+:warning: You need to configure a persistent storage to be mounted to `/data`, e.g. a docker volume. If you do not do this, upon deleting the container, all your data will be lost.
 
 The backend can be configured with the following environment variables.
 
@@ -31,10 +31,6 @@ The backend can be configured with the following environment variables.
 | `GIN_MODE`           | One of `release`, `debug` | `release`                                            | The mode that gin runs in. Only set this to `debug` on your development environment!                                                                              |
 | `PORT`               | `number`                  | `8080`                                               | The port the backend listens on                                                                                                                                   |
 | `LOG_FORMAT`         | One of `json`, `human`    | `json` if `GIN_MODE` is `release`, otherwise `human` | If log output is written human readable or as JSON.                                                                                                               |
-| `DB_HOST`            | `string`                  | `""`                                                 | hostname or address of postgresql                                                                                                                                 |
-| `DB_USER`            | `string`                  | `""`                                                 | username for the postgresql connection                                                                                                                            |
-| `DB_PASSWORD`        | `string`                  | `""`                                                 | password for `DB_USER`                                                                                                                                            |
-| `DB_NAME`            | `string`                  | `""`                                                 | name of the database to use                                                                                                                                       |
 | `CORS_ALLOW_ORIGINS` | `string`                  | `""`                                                 | hosts that are allowed to use cross origin requests, separated by spaces. Only set this when your frontend runs on a different host and/or port than the backend! |
 
 ### Deployment methods

docker-compose.yml

@@ -1,17 +1,6 @@
 version: "3"
 
 services:
-  db:
-    image: postgres:14.4-alpine
-    restart: always
-    environment:
-      - POSTGRES_USER=ez
-      - POSTGRES_PASSWORD=thisisunsafe
-    ports:
-      - 5432:5432
-    volumes:
-      - db:/var/lib/postgresql/data
-
   backend:
     build: .
     depends_on:
@@ -20,10 +9,8 @@ services:
       - 8080:8080
     environment:
       GIN_MODE: debug
-      DB_HOST: db
-      DB_USER: ez
-      DB_PASSWORD: thisisunsafe
-      DB_NAME: postgres
+    volumes:
+      - data:/data
 
 volumes:
-  db:
+  data:

docs/upgrading.md

@@ -2,6 +2,15 @@
 
 If upgrades between versions require manual actions, those are described here.
 
+## v0.32.0 to v0.33.0
+
+[v0.33.0](https://github.com/envelope-zero/backend/releases/tag/v0.33.0) removes support for postgresql.
+
+If you are currently using postgresql, you need to:
+
+1. Export your data with `pg_dump --data-only`.
+2. Upgrade to `v0.33.0` and then re-import the data with `.read database-dump.sql` to the sqlite database.
+
 ## v0.31.0 to v0.31.1
 
 [v0.31.1](https://github.com/envelope-zero/backend/releases/tag/v0.31.1), fixes buggy behaviour from `v0.31.0` and simplifies base URL configuration at the same time.

go.mod

@@ -17,7 +17,6 @@ require (
 	github.com/swaggo/gin-swagger v1.5.1
 	github.com/swaggo/swag v1.8.4
 	github.com/wei840222/gorm-zerolog v0.0.0-20210303025759-235c42bb33fa
-	gorm.io/driver/postgres v1.3.8
 	gorm.io/gorm v1.23.8
 )
 
@@ -33,14 +32,6 @@ require (
 	github.com/go-playground/universal-translator v0.18.0 // indirect
 	github.com/go-playground/validator/v10 v10.11.0 // indirect
 	github.com/goccy/go-json v0.9.8 // indirect
-	github.com/jackc/chunkreader/v2 v2.0.1 // indirect
-	github.com/jackc/pgconn v1.12.1 // indirect
-	github.com/jackc/pgio v1.0.0 // indirect
-	github.com/jackc/pgpassfile v1.0.0 // indirect
-	github.com/jackc/pgproto3/v2 v2.3.0 // indirect
-	github.com/jackc/pgservicefile v0.0.0-20200714003250-2b9c44734f2b // indirect
-	github.com/jackc/pgtype v1.11.0 // indirect
-	github.com/jackc/pgx/v4 v4.16.1 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/josharian/intern v1.0.0 // indirect