Make running migrations easier and provide instructions in README

CalPinSW · Nov 19, 2024 · ec40dd0 · ec40dd0
1 parent e4ba9e4
commit ec40dd0
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -78,3 +78,12 @@ The frontend and backend applications are deployed to two Azure Web Applications
 3. Sending a curl request to the appropriate Webhook url:
     - Frontend: `curl -dH -X POST "Frontend Webhook from Azure"`
     - Backend: `curl -dH -X POST "Backend Webhook from Azure"`
+
+
+## Database Migrations
+
+Database migrations can be run with the following steps:
+1. Navigate to the /backend folder.
+3. Run Python locally (e.g. `python3`). 
+4. From the Python terminal import the migration functions you wish to run. (e.g. `from src.database.migrations.m_241030_add_access_tokens_table import up, down`).
+5. Running the desired migration (e.g. `up()`).
diff --git a/backend/src/app.py b/backend/src/app.py
@@ -1,4 +1,4 @@
-from flask import Flask, make_response, redirect
+from flask import Flask, redirect
 from flask_cors import CORS
 from src.controllers.database import database_controller
 from src.controllers.spotify import spotify_controller

diff --git a/backend/src/database/migrations/m_240909_add_tracks_table.py b/backend/src/database/migrations/m_240909_add_tracks_table.py
@@ -1,13 +1,13 @@
 from src.database.models import (
     DbTrack,
     TrackArtistRelationship,
-    db_wrapper,
 )
+from src.database.migrations.setup import database
 
 
 def up():
-    with db_wrapper.database:
-        db_wrapper.database.create_tables(
+    with database:
+        database.create_tables(
             [
                 DbTrack,
                 TrackArtistRelationship,
@@ -16,8 +16,8 @@ def up():
 
 
 def down():
-    with db_wrapper.database:
-        db_wrapper.database.drop_tables(
+    with database:
+        database.drop_tables(
             [
                 DbTrack,
                 TrackArtistRelationship,

diff --git a/backend/src/database/migrations/m_241030_add_access_tokens_table.py b/backend/src/database/migrations/m_241030_add_access_tokens_table.py
@@ -1,18 +1,19 @@
-from src.database.models import DbAccessToken, db_wrapper
+from src.database.models import DbAccessToken
+from src.database.migrations.setup import database
 
 
 def up():
-    with db_wrapper.database:
-        db_wrapper.database.create_tables(
+    with database:
+        database.create_tables(
             [
                 DbAccessToken,
             ]
         )
 
 
 def down():
-    with db_wrapper.database:
-        db_wrapper.database.drop_tables(
+    with database:
+        database.drop_tables(
             [
                 DbAccessToken,
             ]

diff --git a/backend/src/database/migrations/m_init.py b/backend/src/database/migrations/m_init.py
@@ -7,13 +7,13 @@
     DbPlaylist,
     PlaylistAlbumRelationship,
     DbUser,
-    db_wrapper,
 )
+from src.database.migrations.setup import database
 
 
 def up():
-    with db_wrapper.database:
-        db_wrapper.database.create_tables(
+    with database:
+        database.create_tables(
             [
                 DbUser,
                 DbPlaylist,
@@ -28,8 +28,8 @@ def up():
 
 
 def down():
-    with db_wrapper.database:
-        db_wrapper.database.drop_tables(
+    with database:
+        database.drop_tables(
             [
                 DbUser,
                 DbPlaylist,

diff --git a/backend/src/database/migrations/setup.py b/backend/src/database/migrations/setup.py
@@ -0,0 +1,12 @@
+from flask import Flask
+from src.database.models import (
+    db_wrapper,
+)
+from src.flask_config import Config
+from dotenv import load_dotenv
+
+load_dotenv()
+app = Flask(__name__)
+app.config["DATABASE"] = Config().DB_CONNECTION_STRING
+db_wrapper.init_app(app)
+database = db_wrapper.database