Diff

mod_log_messages_sql/README.md @ 6209:d611ed13df7e draft

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:16:25 +0700
parent 3438:b74c86d137c9
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_log_messages_sql/README.md	Tue Mar 18 00:16:25 2025 +0700
@@ -0,0 +1,33 @@
+# Introduction
+
+::: {.alert .alert-danger}
+Consider using [mod_mam][doc:modules:mod_mam] together with
+[mod_readonly] instead.
+:::
+
+This module logs messages to a SQL database.
+
+SQL connection options are configured in a `message_log_sql` option,
+which has the same syntax as the `sql` option for
+[mod_storage_sql][doc:modules:mod_storage_sql].
+
+# Usage
+
+You will need to create the following table in the configured database:
+
+``` sql
+CREATE TABLE `prosodyarchive` (
+        `host` TEXT,
+        `user` TEXT,
+        `store` TEXT,
+        `id` INTEGER PRIMARY KEY AUTOINCREMENT,
+        `when` INTEGER,
+        `with` TEXT,
+        `resource` TEXT,
+        `stanza` TEXT);
+```
+
+# Compatibility
+
+Does *NOT* work with 0.10 due to a conflict with the new archiving
+support in `mod_storage_sql`·