💿 Change the POSTGRES_DB_URI to DATABASE_URL

Author: momegas

README.md

@@ -71,6 +71,10 @@ Now you're ready to start using Whitebox! Read the [documentation](https://squar
 
 # Set up locally for development
 
+Whitebox supports Postgres and SQLite. You can use either one of them.
+If you want to use SQLite, you need to set up a SQLite database and set the `DATABASE_URL` environment variable to the database URL.
+If you want to use Postgres, you don't need to do anything. Just have a Postgres database running and set the `DATABASE_URL` environment variable to the database URL.
+
 ### Install packages:
 
 ```bash
@@ -85,6 +89,12 @@ pre-commit install
 ENV=dev uvicorn whitebox.main:app --reload
 ```
 
+### Quick way to start a postgres database:
+
+```bash
+docker compose up postgres -d
+```
+
 ### Tests:
 
 - Run: `ENV=test pytest` or `ENV=test pytest -s` to preserve logs.

docker-compose.yml

@@ -22,7 +22,7 @@ services:
     restart: unless-stopped
     environment:
       - APP_NAME=Whitebox | Docker
-      - POSTGRES_DB_URI=postgresql://postgres:postgres@postgres:5432/postgres
+      - DATABASE_URL=postgresql://postgres:postgres@postgres:5432/postgres
     ports:
       - "8000:8000"
     depends_on:

docs/mkdocs/docs/tutorial/installation.md

@@ -51,7 +51,7 @@ services:
     restart: unless-stopped
     environment:
       - APP_NAME=Whitebox | Docker
-      - POSTGRES_DB_URI=postgresql://postgres:postgres@postgres:5432/postgres
+      - DATABASE_URL=postgresql://postgres:postgres@postgres:5432/postgres
     ports:
       - "8000:8000"
     depends_on:

helm_charts/whitebox/templates/deployment.yaml

@@ -30,7 +30,7 @@ spec:
               containerPort: 8000
               protocol: TCP
           env:
-            - name: POSTGRES_DB_URI
+            - name: DATABASE_URL
               value: postgresql://{{ .Values.postgresql.auth.username | default "postgres" }}:{{ .Values.postgresql.auth.password | default "postgres" }}@{{ .Release.Name }}-postgresql/postgres
           resources:
             {{- toYaml .Values.resources | nindent 12 }}

whitebox/core/db.py

@@ -13,8 +13,8 @@
 from secrets import token_hex
 
 settings = get_settings()
-database = databases.Database(settings.POSTGRES_DB_URI)
-engine = sqlalchemy.create_engine(settings.POSTGRES_DB_URI)
+database = databases.Database(settings.DATABASE_URL)
+engine = sqlalchemy.create_engine(settings.DATABASE_URL)
 SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
 
 

whitebox/core/settings.py

@@ -6,7 +6,7 @@
 class Settings(BaseSettings):
     APP_NAME: str = ""
     ENV: str = ""
-    POSTGRES_DB_URI: str = ""
+    DATABASE_URL: str = ""
     VERSION: str = ""
     MODEL_PATH: str = ""
 

whitebox/cron_tasks/monitoring_alerts.py

@@ -17,7 +17,7 @@
 
 settings = get_settings()
 
-engine = create_engine(settings.POSTGRES_DB_URI)
+engine = create_engine(settings.DATABASE_URL)
 SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
 db: Session = SessionLocal()
 

whitebox/cron_tasks/monitoring_metrics.py

@@ -27,7 +27,7 @@
 
 settings = get_settings()
 
-engine = create_engine(settings.POSTGRES_DB_URI)
+engine = create_engine(settings.DATABASE_URL)
 SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
 db: Session = SessionLocal()
 

whitebox/tests/v1/conftest.py

@@ -27,8 +27,8 @@ def client():
 @fixture(scope="session", autouse=True)
 async def db():
     # runs once before all tests
-    engine = sqlalchemy.create_engine(settings.POSTGRES_DB_URI)
-    database = databases.Database(settings.POSTGRES_DB_URI)
+    engine = sqlalchemy.create_engine(settings.DATABASE_URL)
+    database = databases.Database(settings.DATABASE_URL)
     SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
     Base.metadata.create_all(engine)
     await database.connect()