From 97855d5d6aa19bb1b02934b8415fb56651e63304 Mon Sep 17 00:00:00 2001
From: Bernhard Posselt <nukeawhale@gmail.com>
Date: Wed, 20 Mar 2013 17:55:03 +0100
Subject: updated docs

---
 doc/mapper spec.md | 49 +++++++++++++++++++++++++++++++++++++------------
 1 file changed, 37 insertions(+), 12 deletions(-)

(limited to 'doc')

diff --git a/doc/mapper spec.md b/doc/mapper spec.md
index 0b82354e2..f9b28fe94 100644
--- a/doc/mapper spec.md	
+++ b/doc/mapper spec.md	
@@ -1,24 +1,49 @@
+itemmapper
 
-update($item)
-delete($item)
-findAllFromUser($userId)
 find(int $feedId, $userId)
-create($item)
-findAllFromFeedWithStatus($status, $feedId, $userId);
+
+
+
+findAll()
+
+request: get just starred items of a user 
+	SELECT * FROM items 
+		WHERE user_id = ? AND status = ?
+		(AND id < ? LIMIT ?)
+		(AND items.lastmodified >= ?)
+
+request: get all items of a user (unread and read) 
+	SELECT * FROM items 
+		WHERE user_id = ? AND status = ?
+		(AND id < ? LIMIT ?) 
+		(AND items.lastmodified >= ?)
+
+request: get all items of a folder of a user (unread and read)
+	SELECT * FROM items 
+		JOIN feeds
+			ON feed.id = feed_id
+		WHERE user_id = ? AND status = ? AND feed.folder_id = ?
+		(AND id < ? LIMIT ?)
+		(AND items.lastmodified >= ?)
+
+
+request: get all items of a feed of a user (unread and read)
+	SELECT * FROM items 
+		WHERE user_id = ? AND status = ? AND feed_id = ?
+		(AND id < ? LIMIT ?)
+		(AND items.lastmodified >= ?)
+
+
+all requests: can be specified using an (offset (id), limit) or (updatedSince (timestamp))
 
 foldermapper
 
 find($feedId, $userId)
-update($folder)
-delete($folder)
-create($folder)
+findAllFromUser($userId)
 
 feedmapper
 
 find($feedId, $userId)
-update($folder)
-delete($folder)
-create($folder)
 findAll()
 findAllFromUser($userId)
-
+getStarredCount($userId)
-- 
cgit v1.2.3