Mercurial > prosody-modules
changeset 1886:e502c05c0608
mod_storage_multi: Add README
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 01 Oct 2015 17:27:23 +0200 (2015-10-01) |
parents | b42eb10dc7d2 |
children | a7fdab9c14e2 |
files | mod_storage_multi/README.markdown |
diffstat | 1 files changed, 34 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_storage_multi/README.markdown Thu Oct 01 17:27:23 2015 +0200 @@ -0,0 +1,34 @@ +--- +summary: Multi-backend storage module (WIP) +labels: +- NeedDocs +... + +Introduction +============ + +This module attemtps to provide a storage driver that is really multiple +storage drivers. This could be used for storage error tolerance or +caching of data in a faster storage driver. + +Configuration +============= + +An example: + +``` {.lua} +storage = "multi" +storage_multi_policy = "all" +storage_multi = { + "memory", + "internal", + "sql" +} +``` + +Here data would be first read from or written to [mod\_storage\_memory], +then internal storage, then SQL storage. For reads, the first successful +read will be used. For writes, it depends on the `storage_multi_policy` +option. If set to `"all"`, then all storage backends must report success +for the write to be considered successful. Other options are `"one"` and +`"majority"`.