From 00bcc44aa87f7a4ac577cf06686ae55494a8bf29 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Stefan=20K=C3=B6gl?= Date: Sat, 20 Apr 2013 12:01:32 +0200 Subject: [PATCH] update list of CouchDB views in doc --- doc/dev/couchdb-views.rst | 171 ++++++++++++++++++++++++++++++++-------------- 1 file changed, 118 insertions(+), 53 deletions(-) diff --git a/doc/dev/couchdb-views.rst b/doc/dev/couchdb-views.rst index fe316fef..c2dd6bb1 100644 --- a/doc/dev/couchdb-views.rst +++ b/doc/dev/couchdb-views.rst @@ -5,18 +5,16 @@ CouchDB Views This page describes the views that will be used in the CouchDB based backend of the gpodder.net webservice. -View groups are roughly divided into those that access user-generated documents -(e.g. PodcastUserState, EpisodeUserState) and those that don't. - Categories ---------- Doc-Types: Category -Views: +**Views** + * categories/by_tags -* categories/by_weight +* categories/by_update Chapters @@ -24,28 +22,64 @@ Chapters Doc-Types: EpisodeUserState -Views: +**Views** + * chapters/by_episode +Clients +------- + +Doc-Types: User + +**Views** + +* clients/by_ua_string + + Episode Actions --------------- Doc-Types: EpisodeUserState -Views: +**Views** + * episode_actions/by_device -* episode_actions/by_podcast * episode_actions/by_podcast_device +* episode_actions/by_podcast * episode_actions/by_user +Episode States +-------------- + +Doc-Types: EpisodeUserState + +**Views** + +* episode_states/by_podcast_episode +* episode_states/by_ref_urls +* episode_states/by_user_episode +* episode_states/by_user_podcast + + +Episode Statistics +------------------ + +Doc-Types: Episode + +**Views** + +* episode_stats/filetypes + + Episodes -------- Doc-Types: Episode -Views: +**Views** + * episodes/by_id * episodes/by_oldid * episodes/by_podcast @@ -58,20 +92,9 @@ Favorites --------- Doc-Types: EpisodeUserState -Views: -* episodes/favorites_by_user - +**Views** -Episode States --------------- - -Doc-Types: EpisodeUserState - -Views: -* episode_states/by_podcast_episode -* episode_states/by_ref_urls -* episode_states/by_user_episode -* episode_states/by_user_podcast +* episodes/favorites_by_user Heatmap @@ -79,7 +102,8 @@ Heatmap Doc-Types: EpisodeUserState -Views: +**Views** + * heatmap/by_episode @@ -88,7 +112,8 @@ History Doc-Types: EpisodeUserState, PodcastUserState -Views: +**Views** + * history/by_device * history/by_user @@ -98,10 +123,14 @@ Listeners Doc-Types: EpisodeUserState -Views: +**Views** + * listeners/by_episode -* listeners/by_podcast * listeners/by_podcast_episode +* listeners/by_podcast +* listeners/by_user +* listeners/by_user_podcast +* listeners/times_played_by_user Podcast Lists @@ -109,17 +138,32 @@ Podcast Lists Doc-Types: PodcastList -Views: +**Views** + * podcastlists/by_rating * podcastlists/by_user_slug +* podcastlists/random + + +Podcast States +-------------- + +Doc-Types: PodcastUserState + +**Views** + +* podcast_states/by_device +* podcast_states/by_podcast +* podcast_states/by_user Podcasts -------- -Doc-Types: Podcast, PodcastGroup +Doc-Types: Podcast, PodcastGroup, PodcastSubscriberData + +**Views** -Views: * podcasts/by_id * podcasts/by_language * podcasts/by_last_update @@ -127,26 +171,20 @@ Views: * podcasts/by_slug * podcasts/by_tag * podcasts/by_url +* podcasts/flattr * podcasts/groups_by_oldid * podcasts/podcasts_groups +* podcasts/random * podcasts/subscriber_data -Podcast States --------------- - -Doc-Types: PodcastUserState - -Views: -* podcast_states/by_device - - Sanitizing Rules ---------------- Doc-Types: SanitizingRule -Views: +**Views** + * sanitizing_rules/by_slug * sanitizing_rules/by_target @@ -156,17 +194,28 @@ Slugs Doc-Types: Podcast, PodcastGroup, Episode -Views: +**Views** + * slugs/missing +Subscribers +----------- + +Doc-Types: PodcastUserState + +**Views** + +* subscribers/by_podcast + Subscriptions ------------- Doc-Types: PodcastUserState -Views: +**Views** + * subscriptions/by_device * subscriptions/by_podcast * subscriptions/by_user @@ -177,7 +226,8 @@ Suggestions Doc-Types: Suggestions -Views: +**Views** + * suggestions/by_user @@ -186,33 +236,48 @@ Tags Doc-Types: Podcast, PodcastGroup -Views: +**Views** + * tags/by_podcast * tags/by_user -User-Tags ---------- - -Doc-Types: PodcastUserState -* usertags/by_podcast -* usertags/podcasts - - Toplists -------- Doc-Types: Episode, Podcast, PodcastGroup -Views: +**Views** + * toplist/episodes * toplist/podcasts +Trending +-------- + +Doc-Types: Podcast, PodcastGroup + +**Views** + +* trending/podcasts + + Users ----- Doc-Types: User -Views: +**Views** + +* users/by_google_email * users/deleted + + +User-Tags +--------- + +Doc-Types: PodcastUserState + +* usertags/by_podcast +* usertags/podcasts -- 2.11.4.GIT