Fixed #79: added DATABASES_OPTIONS

kiwix · May 2, 2024 · be72dcd · be72dcd
1 parent e8684a5
commit be72dcd
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -25,6 +25,8 @@ ENV BACKUP_HOUR=3
 ENV BACKUP_MINUTE=12
 # No database to backup in default
 ENV DATABASES=""
+# options to pass to the database hook
+ENV DATABASES_OPTIONS=""
 # Retry paramaeters when setup a new repo
 ENV MAX_BORGMATIC_RETRY="10"
 ENV WAIT_BEFORE_BORGMATIC_RETRY="30"

diff --git a/README.md b/README.md
@@ -132,6 +132,7 @@ Other parameters can be configured via Docker environment variables:
   - `KEEP_YEARLY`: keep last archive of this many latest years (default: `1`)
 - Databases backup:
   - `DATABASES`: DSNs of the database to backup.
+  - `DATABASES_OPTIONS`: Options passed to all databases hookd. eg: `--ignore-table=wp1.too_large_table`
 
 Database DSN should be in the form: `type://user:password@host:port/dbname`. It only supports `mysql`, `postgresql` and `mongodb`. `dbname` can be `all` to backup all databases of that host/connexion.
 

diff --git a/bin/init_borgbase_repository.py b/bin/init_borgbase_repository.py
@@ -121,6 +121,7 @@ def write_config(
     keep_monthly,
     keep_yearly,
     databases,
+    databases_options,
     cross_fs_glob,
 ):
 
@@ -177,14 +178,23 @@ def write_config(
                 FILE,
                 "mysql",
                 databases_mysql,
-                "--single-transaction --quick --lock-tables=false "
-                "--max-allowed-packet=128M",
+                options=(
+                    "--single-transaction --quick --lock-tables=false "
+                    + "--max-allowed-packet=128M "
+                    + databases_options
+                ),
             )
         if databases_postgresql:
-            write_config_databases(FILE, "postgresql", databases_postgresql)
+            write_config_databases(
+                FILE, "postgresql", databases_postgresql, options=databases_options
+            )
         if databases_mongodb:
             write_config_databases(
-                FILE, "mongodb", databases_mongodb, authentication_database="admin"
+                FILE,
+                "mongodb",
+                databases_mongodb,
+                options=databases_options,
+                authentication_database="admin",
             )
 
 
@@ -201,6 +211,7 @@ def main(
     quota,
     alert,
     databases,
+    databases_options,
     cross_fs_glob,
     max_retry,
     initial_delay_retry,
@@ -235,6 +246,7 @@ def main(
             keep_monthly,
             keep_yearly,
             databases,
+            databases_options,
             cross_fs_glob,
         )
 
@@ -276,6 +288,7 @@ def main(
     KNOWN_HOSTS_FILE = os.environ.get("KNOWN_HOSTS_FILE")
 
     DATABASES = os.environ.get("DATABASES")
+    DATABASES_OPTIONS = os.environ.get("DATABASES_OPTIONS", "")
     CROSS_FS_GLOB = os.environ.get("CROSS_FS_GLOB")
 
     KEEP_WITHIN = os.environ.get("KEEP_WITHIN")
@@ -314,6 +327,7 @@ def main(
                 QUOTA,
                 ALERT,
                 list(map(urlparse, DATABASES.split(DB_SEPARATOR))) if DATABASES else [],
+                DATABASES_OPTIONS,
                 bool(CROSS_FS_GLOB),
                 MAX_BORGMATIC_RETRY,
                 WAIT_BEFORE_BORGMATIC_RETRY,