Skip to content

Bulk asynchronous downloader for multiple file hosts

refactor: add schema table to db (#1302)

NTFSvolume9063a42a4df0
diff --git a/cyberdrop_dl/database/__init__.py b/cyberdrop_dl/database/__init__.py
index 02b874af4..d880ddca9 100644
--- a/cyberdrop_dl/database/__init__.py
+++ b/cyberdrop_dl/database/__init__.py
@@ -4,7 +4,7 @@ from typing import TYPE_CHECKING
import aiosqlite
-from .tables import HashTable, HistoryTable, TempRefererTable
+from .tables import HashTable, HistoryTable, SchemaVersionTable, TempRefererTable
from .tables.history import get_db_path
if TYPE_CHECKING:
@@ -27,11 +27,13 @@ class Database:
self.history_table = HistoryTable(self)
self.hash_table = HashTable(self)
self.temp_referer_table = TempRefererTable(self)
+ self._schema_versions = SchemaVersionTable(self)
await self._pre_allocate()
await self.history_table.startup()
await self.hash_table.startup()
await self.temp_referer_table.startup()
+ await self._schema_versions.startup()
async def close(self) -> None:
"""Close the DBManager."""
diff --git a/cyberdrop_dl/database/tables/__init__.py b/cyberdrop_dl/database/tables/__init__.py
index 32cd78ef0..63dd2e9ae 100644
--- a/cyberdrop_dl/database/tables/__init__.py
+++ b/cyberdrop_dl/database/tables/__init__.py
@@ -1,5 +1,6 @@
from .hash import HashTable
from .history import HistoryTable
+from .schema import SchemaVersionTable
from .temp_referer import TempRefererTable
-__all__ = ["HashTable", "HistoryTable", "TempRefererTable"]
+__all__ = ["HashTable", "HistoryTable", "SchemaVersionTable", "TempRefererTable"]
diff --git a/cyberdrop_dl/database/tables/definitions.py b/cyberdrop_dl/database/tables/definitions.py
index 68500d8d9..55507e507 100644
--- a/cyberdrop_dl/database/tables/definitions.py
+++ b/cyberdrop_dl/database/tables/definitions.py
@@ -28,6 +28,13 @@ create_fixed_history = """CREATE TABLE IF NOT EXISTS media_copy (
create_temp_referer = """CREATE TABLE IF NOT EXISTS temp_referer (referer TEXT);"""
+create_schema_version = """
+CREATE TABLE IF NOT EXISTS schema_version (
+ version VARCHAR(50) NOT NULL PRIMARY KEY,
+ applied_on TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
+);
+"""
+
create_files = """
CREATE TABLE IF NOT EXISTS files (
folder TEXT,
diff --git a/cyberdrop_dl/database/tables/schema.py b/cyberdrop_dl/database/tables/schema.py
new file mode 100644
index 000000000..133d7151f
--- /dev/null
+++ b/cyberdrop_dl/database/tables/schema.py
@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import aiosqlite
+from packaging.version import Version
+
+from cyberdrop_dl.utils.logger import log, log_spacer
+
+from .definitions import create_schema_version
+
+if TYPE_CHECKING:
+ import aiosqlite
+
+ from cyberdrop_dl.database import Database
+
+
+CURRENT_APP_SCHEMA_VERSION = "8.0.0"
+
+
+class SchemaVersionTable:
+ def __init__(self, database: Database) -> None:
+ self._database = database
+
+ @property
+ def db_conn(self) -> aiosqlite.Connection:
+ return self._database._db_conn
+
+ async def get_version(self) -> Version | None:
+ if not await self.__exists():
+ return
+ query = "SELECT version FROM schema_version;"
+ cursor = await self.db_conn.execute(query)
+ result = await cursor.fetchone()
+ if result:
+ return Version(result["version"])
+
+ async def __exists(self) -> bool:
+ query = "SELECT name FROM sqlite_master WHERE type='table' AND name='schema_version';"
+ cursor = await self.db_conn.execute(query)
+ result = await cursor.fetchone()
+ return result is not None
+
+ async def __create_if_not_exists(self) -> None:
+ await self.db_conn.execute(create_schema_version)
+ await self.db_conn.commit()
+
+ async def __update_schema_version(self) -> None:
+ await self.__create_if_not_exists()
+ query = "INSERT INTO schema_version (version) VALUES (?)"
+ await self.db_conn.execute(query, (CURRENT_APP_SCHEMA_VERSION,))
+ await self.db_conn.commit()
+
+ async def startup(self) -> None:
+ log_spacer(10)
+ log(f"Expected database schema version: {CURRENT_APP_SCHEMA_VERSION}")
+ version = await self.get_version()
+ log(f"Database reports installed version: {version}")
+ if version is not None and version >= Version(CURRENT_APP_SCHEMA_VERSION):
+ return
+
+ # TODO: on v9, raise SystemExit if db version is None or older than 8.0.0
+ log(f"Updating database version to {CURRENT_APP_SCHEMA_VERSION}")
+ await self.__update_schema_version()