Mirrors_Framework/mosquitto
1
0
Fork 0
mirror of https://github.com/eclipse-mosquitto/mosquitto.git synced 2026-03-23 08:23:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve sqlite docs

Browse Source 
Including removing the errant references to acl files.

Closes #3508. Thanks to Ulrich Berkmueller.
This commit is contained in:
Roger A. Light
2026-02-17 00:19:24 +00:00
parent d0152406e3
commit 66486e4748
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
www/pages/documentation/persistence/sqlite.md
View File

@@ -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 <path to save mosquitto.sqlite3>
global_plugin C:\Program Files\Mosquitto\mosquitto_persist_sqlite.dll
plugin_opt_acl_file <my acl file path>
```
Other:
```
persistence_location <path to save mosquitto.sqlite3>
global_plugin /path/to/mosquitto_persist_sqlite.so
plugin_opt_acl_file <my acl file path>
```
# 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.