annotate mod_log_messages_sql/README.markdown @ 3437:ce5d1fa69ba3

mod_readonly: Add a stub README
author Kim Alvefur <zash@zash.se>
date Mon, 07 Jan 2019 20:07:57 +0100
parents a216be9b1d6e
children b74c86d137c9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2406
a216be9b1d6e mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
1 # Introduction
a216be9b1d6e mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
2
2323
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 This module logs messages to a SQL database.
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 SQL connection options are configured in a `message_log_sql` option,
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 which has the same syntax as the `sql` option for
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 [mod_storage_sql][doc:modules:mod_storage_sql].
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
2406
a216be9b1d6e mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
9 # Usage
a216be9b1d6e mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
10
2323
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 You will need to create the following table in the configured database:
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 ``` sql
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 CREATE TABLE `prosodyarchive` (
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 `host` TEXT,
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 `user` TEXT,
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 `store` TEXT,
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 `id` INTEGER PRIMARY KEY AUTOINCREMENT,
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 `when` INTEGER,
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 `with` TEXT,
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 `resource` TEXT,
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 `stanza` TEXT);
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 ```
2406
a216be9b1d6e mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
24
a216be9b1d6e mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
25 # Compatibility
a216be9b1d6e mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
26
a216be9b1d6e mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
27 Does *NOT* work with 0.10 due to a conflict with the new archiving
a216be9b1d6e mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
28 support in `mod_storage_sql`ยท