From 66486e47485412ec5d6d2c7a4466b2bf9405462f Mon Sep 17 00:00:00 2001 From: "Roger A. Light" Date: Tue, 17 Feb 2026 00:19:24 +0000 Subject: [PATCH] Improve sqlite docs Including removing the errant references to acl files. Closes #3508. Thanks to Ulrich Berkmueller. --- www/pages/documentation/persistence/sqlite.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/www/pages/documentation/persistence/sqlite.md b/www/pages/documentation/persistence/sqlite.md index fad1774ad..debe15c4a 100644 --- a/www/pages/documentation/persistence/sqlite.md +++ b/www/pages/documentation/persistence/sqlite.md @@ -20,10 +20,18 @@ This plugin should be preferred when you are interested in persistence, because it saves changes to disk as they are made, where as the traditional persistence only takes periodic snapshots. +Note that it is not possible to run both the traditional persistence and the +sqlite persistence plugin at the same time. + + ## Usage The plugin requires minimal configuration. +The database is stored at the location specified by the `persistence_location` +option and is named `mosquitto.sqlite3. As an alternative, the file can be +specified directly using the `plugin_opt_db_file` option. + The `plugin_opt_sync` option can be set to `extra`, `full`, `normal`, or `off`, with a default of `normal`. This option controls how hard sqlite works to ensure data is on the disk before continuing. This is better described by @@ -42,12 +50,15 @@ Windows: ``` persistence_location global_plugin C:\Program Files\Mosquitto\mosquitto_persist_sqlite.dll -plugin_opt_acl_file ``` Other: ``` persistence_location global_plugin /path/to/mosquitto_persist_sqlite.so -plugin_opt_acl_file ``` + +# Migration + +A [script](https://raw.githubusercontent.com/eclipse-mosquitto/mosquitto/refs/heads/master/plugins/persist-sqlite/migrate_to_persist_sqlite.py) +is available to help migrate from the traditional persistence.