Mercurial > prosody-modules

comparison mod_storage_xmlarchive/README.markdown @ 3434:a6722a35f35e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_storage_xmlarchive: Expand description in README
author Kim Alvefur <zash@zash.se>
date Sun, 06 Jan 2019 10:27:16 +0100
parents 7713cd4fff8f
children 7b97abf26612
comparison
equal deleted inserted replaced
3433:213679266dcb 3434:a6722a35f35e
8 8
9 Introduction 9 Introduction
10 ============ 10 ============
11 11
12 This module implements stanza archives using files, similar to the 12 This module implements stanza archives using files, similar to the
13 default "internal" storage. 13 default "internal" storage. Unlike "internal", it saves messages in two
14 files per day (and per user), one containing metadata and one containing
15 the actual messages in XML format (hence the name).
16
17 Splitting data per day improves performance for larger archives as it
18 does not have to look through data from other days.
14 19
15 Configuration 20 Configuration
16 ============= 21 =============
17 22
18 To use this with [mod\_mam] add this to your config: 23 To use this with [mod\_mam] add this to your config:
85 Queries that are not time based, but limited to a specific contact may 90 Queries that are not time based, but limited to a specific contact may
86 be expensive as potentially the entire archive will be read. 91 be expensive as potentially the entire archive will be read.
87 92
88 Each archive ID is of the form `YYYY-MM-DD-random`, making lookups by 93 Each archive ID is of the form `YYYY-MM-DD-random`, making lookups by
89 archive id just as simple as time based queries. 94 archive id just as simple as time based queries.
95
96 ## Limitations
97
98 - Only XML stanzas can be stored.
99 - The deletion method only supports removing entire days at a time.