add missing import
[mygpo.git] / doc / couch / views.txt
blobd06b1573a68085b2fd24a1c4493e952c6151b975
3                          View Overview
4                          ~~~~~~~~~~~~~
7 This file describes the views that will be used in the CouchDB based backend of
8 the gpodder.net webservice.
10 View groups are roughly divided into those that access use-generated documents
11 (e.g. PodcastUserState, EpisodeUserState) and those that don't.
14 Categories
15 ==========
17 Doc-Types: Category
19 Views:
20 * categories/by_tags
21 * categories/by_weight
24 Chapters
25 ========
27 Doc-Types: EpisodeUserState
29 Views:
30 * chapters/by_episode
33 Episode Actions
34 ===============
36 Doc-Types: EpisodeUserState
38 Views:
39 * episode_actions/by_device
40 * episode_actions/by_podcast
41 * episode_actions/by_podcast_device
42 * episode_actions/by_user
45 Episodes
46 ========
48 Doc-Types: Episode
50 Views:
51 * episodes/by_id
52 * episodes/by_oldid
53 * episodes/by_podcast
54 * episodes/by_podcast_url
55 * episodes/by_slug
56 * episodes/need_update
59 Favorites
60 =========
61 Doc-Types: EpisodeUserState
63 Views:
64 * episodes/favorites_by_user
67 Episode States
68 ==============
70 Doc-Types: EpisodeUserState
72 Views:
73 * episode_states/by_podcast_episode
74 * episode_states/by_ref_urls
75 * episode_states/by_user_episode
76 * episode_states/by_user_podcast
79 Heatmap
80 =======
82 Doc-Types: EpisodeUserState
84 Views:
85 * heatmap/by_episode
88 History
89 =======
91 Doc-Types: EpisodeUserState, PodcastUserState
93 Views:
94 * history/by_device
95 * history/by_user
98 Listeners
99 =========
101 Doc-Types: EpisodeUserState
103 Views:
104 * listeners/by_episode
105 * listeners/by_podcast
106 * listeners/by_podcast_episode
109 Podcast Lists
110 =============
112 Doc-Types: PodcastList
114 Views:
115 * podcastlists/by_rating
116 * podcastlists/by_user_slug
119 Podcasts
120 ========
122 Doc-Types: Podcast, PodcastGroup
124 Views:
125 * podcasts/by_id
126 * podcasts/by_language
127 * podcasts/by_last_update
128 * podcasts/by_oldid
129 * podcasts/by_slug
130 * podcasts/by_tag
131 * podcasts/by_url
132 * podcasts/groups_by_oldid
133 * podcasts/podcasts_groups
134 * podcasts/subscriber_data
137 Podcast States
138 ==============
140 Doc-Types: PodcastUserState
142 Views:
143 * podcast_states/by_device
146 Sanitizing Rules
147 ================
149 Doc-Types: SanitizingRule
151 Views:
152 * sanitizing_rules/by_slug
153 * sanitizing_rules/by_target
156 Slugs
157 =====
159 Doc-Types: Podcast, PodcastGroup, Episode
161 Views:
162 * slugs/missing
166 Subscriptions
167 =============
169 Doc-Types: PodcastUserState
171 Views:
172 * subscriptions/by_device
173 * subscriptions/by_podcast
174 * subscriptions/by_user
177 Suggestions
178 ===========
180 Doc-Types: Suggestions
182 Views:
183 * suggestions/by_user
186 Tags
187 ====
189 Doc-Types: Podcast, PodcastGroup
191 Views:
192 * tags/by_podcast
193 * tags/by_user
196 User-Tags
197 =========
199 Doc-Types: PodcastUserState
200 * usertags/by_podcast
201 * usertags/podcasts
204 Toplists
205 ========
207 Doc-Types: Episode, Podcast, PodcastGroup
209 Views:
210 * toplist/episodes
211 * toplist/podcasts
214 Users
215 =====
217 Doc-Types: User
219 Views:
220 * users/deleted