Change DB_URL config value to just DB and simplify scheme.

Author: defnull

bbblb/api/__init__.py

@@ -17,7 +17,7 @@
 
 @asynccontextmanager
 async def lifespan(app: Starlette):
-    await model.init_engine(config.DB_URI, echo=False)
+    await model.init_engine(config.DB, echo=False)
     poll_worker = poller.Poller()
     importer = recordings.RecordingImporter(
         basedir=pathlib.Path(config.RECORDING_PATH),

bbblb/model.py

@@ -62,6 +62,12 @@ def utcnow():
 
 async def init_engine(db: str, echo=False):
     global async_engine, AsyncSessionMaker, ScopedSession
+
+    if db.startswith("sqlite://"):
+        db = db.replace("sqlite://", "sqlite+aiosqlite://")
+    elif db.startswith("postgres://"):
+        db = db.replace("postgres://", "postgres+asyncpg://")
+
     async_engine = create_async_engine(db, echo=echo)
     AsyncSessionMaker = async_sessionmaker(async_engine, expire_on_commit=False)
 

bbblb/settings.py

@@ -137,9 +137,10 @@ def __getattr__(self, name: str):
 
 
 class BBBLBConfig(BaseConfig):
-    #: An sqlalchemy-style database URL. MUST be an async-capable engine
-    #: Supportet are sqlite+aiosqlite:// and postgresql+asyncpg:// schemes.
-    DB_URI: str
+    #: An sqlalchemy compatible database connection string, starting with either
+    #: `sqlite://` or `postgresql://`. For example `sqlite:////path/to/file.db`
+    #: or `postgresql://user:pass@host/name`.
+    DB: str
 
     #: Primary domain for this service. This will be added as bbblb-origin
     #: metadata to meetings and is used by e.g. the recording upload script

docs/config.md

@@ -13,9 +13,10 @@ See `examples/bbblb.env.example` for a full list.
 The options here are lossely ordered by topic.
 
 <!-- snip_start -->
-`DB_URI` (type: `str`, **REQUIRED**)  
-An sqlalchemy-style database URL. MUST be an async-capable engine
-Supportet are sqlite+aiosqlite:// and postgresql+asyncpg:// schemes.
+`DB` (type: `str`, **REQUIRED**)  
+An sqlalchemy compatible database connection string, starting with either
+`sqlite://` or `postgresql://`. For example `sqlite:////path/to/file.db`
+or `postgresql://user:pass@host/name`.
 
 `DOMAIN` (type: `str`, **REQUIRED**)  
 Primary domain for this service. This will be added as bbblb-origin

examples/bbblb.env.example

@@ -1,7 +1,8 @@
-# An sqlalchemy-style database URL. MUST be an async-capable engine
-# Supportet are sqlite+aiosqlite:// and postgresql+asyncpg:// schemes.
+# An sqlalchemy compatible database connection string, starting with either
+# `sqlite://` or `postgresql://`. For example `sqlite:////path/to/file.db`
+# or `postgresql://user:pass@host/name`.
 # (REQUIRED; type: str)
-#BBBLB_DB_URI=
+#BBBLB_DB=
 
 # Primary domain for this service. This will be added as bbblb-origin
 # metadata to meetings and is used by e.g. the recording upload script

examples/compose/docker-compose.yaml

@@ -9,7 +9,7 @@ services:
       target: app
     restart: unless-stopped
     environment:
-      - BBBLB_DB=postgresql+asyncpg://bbblb:bbblb@postgres/bbblb
+      - BBBLB_DB=postgresql://bbblb:bbblb@postgres/bbblb
       - BBBLB_RECORDING_PATH=/data/recordings
     volumes:
       - ./data/recordings:/data/recordings