Mercurial > prosody-modules
annotate mod_mam_sql/README.wiki @ 1800:669d1208221a
mod_storage_lmdb: Remove redundant table
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 28 Aug 2015 00:38:19 +0200 |
| parents | a946aa422503 |
| children |
| rev | line source |
|---|---|
| 1782 | 1 #summary XEP-0313: Message Archive Management using SQL |
| 2 #labels Stage-Alpha, Deprecated | |
| 3 | |
| 4 *Note:* This module is unsupported and not up to date with the MAM specification | |
| 5 | |
| 6 = Introduction = | |
| 7 | |
|
1797
a946aa422503
mod_mam_sql/README: More obvious pointers to use mod_mam instead
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
8 This is an old fork of mod_mam with the purpose of figuring out and |
|
a946aa422503
mod_mam_sql/README: More obvious pointers to use mod_mam instead
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
9 testing an appropriate schema for future inclusion in prosodys |
|
a946aa422503
mod_mam_sql/README: More obvious pointers to use mod_mam instead
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
10 mod_storage_sql. That work is currently available in mod_storage_sql2, |
|
a946aa422503
mod_mam_sql/README: More obvious pointers to use mod_mam instead
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
11 pending merging with mod_storage_sql. |
| 1782 | 12 |
|
1797
a946aa422503
mod_mam_sql/README: More obvious pointers to use mod_mam instead
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
13 It talks SQL directly, bypassing prosodys storage layer. |
|
a946aa422503
mod_mam_sql/README: More obvious pointers to use mod_mam instead
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
14 |
|
a946aa422503
mod_mam_sql/README: More obvious pointers to use mod_mam instead
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
15 It is no longer maintained and is unlikely to work with modern clients. |
| 1782 | 16 |
| 17 = Details = | |
| 18 | |
| 19 See [mod_mam] for details. | |
| 20 | |
| 21 = Usage = | |
| 22 | |
| 23 First copy the module to the prosody plugins directory. | |
| 24 | |
| 25 Then add "mam_sql" to your modules_enabled list: | |
| 26 {{{ | |
| 27 modules_enabled = { | |
| 28 -- ... | |
| 29 "mam_sql", | |
| 30 -- ... | |
| 31 } | |
| 32 }}} | |
| 33 | |
| 34 You should probably run the SQL to create the archive table/indexes: | |
| 35 | |
| 36 {{{ | |
| 37 CREATE TABLE `prosodyarchive` ( | |
| 38 `host` TEXT, | |
| 39 `user` TEXT, | |
| 40 `store` TEXT, | |
| 41 `id` INTEGER PRIMARY KEY AUTOINCREMENT, | |
| 42 `when` INTEGER, | |
| 43 `with` TEXT, | |
| 44 `resource` TEXT, | |
| 45 `stanza` TEXT | |
| 46 ); | |
| 47 CREATE INDEX `hus` ON `prosodyarchive` (`host`, `user`, `store`); | |
| 48 CREATE INDEX `with` ON `prosodyarchive` (`with`); | |
| 49 CREATE INDEX `thetime` ON `prosodyarchive` (`when`); | |
| 50 }}} | |
| 51 | |
| 52 (*NOTE*: I ran the following SQL to initialize the table/indexes on MySQL): | |
| 53 | |
| 54 {{{ | |
| 55 CREATE TABLE prosodyarchive ( | |
| 56 `host` VARCHAR(1023) NOT NULL, | |
| 57 `user` VARCHAR(1023) NOT NULL, | |
| 58 `store` VARCHAR(1023) NOT NULL, | |
| 59 `id` INTEGER PRIMARY KEY AUTO_INCREMENT, | |
| 60 `when` INTEGER NOT NULL, | |
| 61 `with` VARCHAR(2047) NOT NULL, | |
| 62 `resource` VARCHAR(1023), | |
| 63 `stanza` TEXT NOT NULL | |
| 64 ); | |
| 65 CREATE INDEX hus ON prosodyarchive (host, user, store); | |
| 66 CREATE INDEX `with` ON prosodyarchive (`with`); | |
| 67 CREATE INDEX thetime ON prosodyarchive (`when`); | |
| 68 }}} | |
| 69 | |
| 70 You may want to tweak the column sizes a bit; I did for my own purposes. | |
| 71 | |
| 72 = Configuration = | |
| 73 | |
| 74 This module uses the same configuration settings that [mod_mam] does, in addition to the [http://prosody.im/doc/modules/mod_storage_sql SQL storage settings]. You may also name the SQL connection settings 'mam_sql' if you want. | |
| 75 | |
| 76 = Compatibility = | |
|
1797
a946aa422503
mod_mam_sql/README: More obvious pointers to use mod_mam instead
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
77 |
| 1782 | 78 || 0.8 || ? || |
| 79 || 0.9 || Works || | |
|
1797
a946aa422503
mod_mam_sql/README: More obvious pointers to use mod_mam instead
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
80 || 0.10 || Use mod_mam instead || |
|
a946aa422503
mod_mam_sql/README: More obvious pointers to use mod_mam instead
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
81 || trunk || Use mod_mam instead || |