mod_storage_sql2: Add some comments
authorMatthew Wild <mwild1@gmail.com>
Wed, 24 Jun 2015 21:54:17 +0000 (22:54 +0100)
committerMatthew Wild <mwild1@gmail.com>
Wed, 24 Jun 2015 21:54:17 +0000 (22:54 +0100)
plugins/mod_storage_sql2.lua

index d5e0494faf5636f18a0dc0eb43fca331332a57b8..74f95417c170cc324131ddab817c4a5253923670 100644 (file)
@@ -192,6 +192,8 @@ local function keyval_store_set(data)
        return true;
 end
 
+--- Key/value store API (default store type)
+
 local keyval_store = {};
 keyval_store.__index = keyval_store;
 function keyval_store:get(username)
@@ -214,6 +216,8 @@ function keyval_store:users()
        return iterator(result);
 end
 
+--- Archive store API
+
 local archive_store = {}
 archive_store.__index = archive_store
 function archive_store:append(username, key, when, with, value)
@@ -342,6 +346,10 @@ local stores = {
        archive = archive_store;
 };
 
+--- Implement storage driver API
+
+-- FIXME: Some of these operations need to operate on the archive store(s) too
+
 local driver = {};
 
 function driver:open(store, typ)