diff --git a/NEWS b/NEWS index 83d60b1a..7658fe71 100644 --- a/NEWS +++ b/NEWS @@ -4,6 +4,8 @@ snapshotting these source directories. * #1192, #1163: Document potential interactions between security settings in borgmatic's sample systemd service file and the ZFS, LVM, and Btrfs hooks. + * #1193: In the documentation for the MariaDB/MySQL database hooks, clarify how to set custom + command-line flags for database commands. * #1194: Fix for an incorrect diff command shown when running the "generate config" action with a source configuration file. * #1195: Fix a regression in the ZFS, LVM, and Btrfs hooks in which snapshotted paths ignored diff --git a/borgmatic/config/schema.yaml b/borgmatic/config/schema.yaml index dbcc54a3..0cbd4b0c 100644 --- a/borgmatic/config/schema.yaml +++ b/borgmatic/config/schema.yaml @@ -1757,18 +1757,21 @@ properties: mariadb_dump_command: type: string description: | - Command to use instead of "mariadb-dump". This can be - used to run a specific mariadb_dump version (e.g., one - inside a running container). If you run it from within a - container, make sure to mount the path in the - "user_runtime_directory" option from the host into the - container at the same location. Defaults to - "mariadb-dump". + Command to use instead of "mariadb-dump". But set any + additional command-line flags in "options", not here. + This command can be used to run a specific mariadb_dump + version (e.g., one inside a running container). If you + run it from within a container, make sure to mount the + path in the "user_runtime_directory" option from the + host into the container at the same location. Defaults + to "mariadb-dump". example: docker exec mariadb_container mariadb-dump mariadb_command: type: string description: | - Command to run instead of "mariadb". This can be used to + Command to run instead of "mariadb". But set any + additional command-line flags in "list_options" or + "restore_options", not here. This command can be used to run a specific mariadb version (e.g., one inside a running container). Defaults to "mariadb". example: docker exec mariadb_container mariadb @@ -1948,17 +1951,21 @@ properties: mysql_dump_command: type: string description: | - Command to use instead of "mysqldump". This can be used - to run a specific mysql_dump version (e.g., one inside a - running container). If you run it from within a - container, make sure to mount the path in the - "user_runtime_directory" option from the host into the - container at the same location. Defaults to "mysqldump". + Command to use instead of "mysqldump". But set any + additional command-line flags in "options", not here. + This command can be used to run a specific mysql_dump + version (e.g., one inside a running container). If you + run it from within a container, make sure to mount the + path in the "user_runtime_directory" option from the + host into the container at the same location. Defaults + to "mysqldump". example: docker exec mysql_container mysqldump mysql_command: type: string description: | - Command to run instead of "mysql". This can be used to + Command to run instead of "mysql". But set any + additional command-line flags in "list_options" or + "restore_options", not here. This command can be used to run a specific mysql version (e.g., one inside a running container). Defaults to "mysql". example: docker exec mysql_container mysql diff --git a/docs/how-to/backup-your-databases.md b/docs/how-to/backup-your-databases.md index 69c9d17d..762cebf6 100644 --- a/docs/how-to/backup-your-databases.md +++ b/docs/how-to/backup-your-databases.md @@ -249,6 +249,10 @@ container separate from borgmatic. A similar approach can work with MySQL, using `mysql_dump_command` instead of `mariadb_dump_command` to run `mysqldump` in a container. +Note: With MariaDB and MySQL, use `options`, `list_options`, and/or +`restore_options` to override command-line flags rather than putting flags into +`mariadb_dump_command`, `mysql_dump_command`, etc. + #### Database client in a temporary container