doc/dev/couchdb-views.rst

   1
   2 CouchDB Views
   3 =============
   4
   5 This page describes the views that will be used in the CouchDB based backend of
   6 the gpodder.net webservice.
   7
   8
   9 Categories
  10 ----------
  11
  12 Doc-Types: Category
  13
  14 **Views**
  15
  16 * categories/by_tags
  17 * categories/by_update
  18
  19
  20 Chapters
  21 --------
  22
  23 Doc-Types: EpisodeUserState
  24
  25 **Views**
  26
  27 * chapters/by_episode
  28
  29
  30 Clients
  31 -------
  32
  33 Doc-Types: User
  34
  35 **Views**
  36
  37 * clients/by_ua_string
  38
  39
  40 Episode Actions
  41 ---------------
  42
  43 Doc-Types: EpisodeUserState
  44
  45 **Views**
  46
  47 * episode_actions/by_device
  48 * episode_actions/by_podcast_device
  49 * episode_actions/by_podcast
  50 * episode_actions/by_user
  51
  52
  53 Episode States
  54 --------------
  55
  56 Doc-Types: EpisodeUserState
  57
  58 **Views**
  59
  60 * episode_states/by_podcast_episode
  61 * episode_states/by_ref_urls
  62 * episode_states/by_user_episode
  63 * episode_states/by_user_podcast
  64
  65
  66 Episode Statistics
  67 ------------------
  68
  69 Doc-Types: Episode
  70
  71 **Views**
  72
  73 * episode_stats/filetypes
  74
  75
  76 Episodes
  77 --------
  78
  79 Doc-Types: Episode
  80
  81 **Views**
  82
  83 * episodes/by_id
  84 * episodes/by_oldid
  85 * episodes/by_podcast
  86 * episodes/by_podcast_url
  87 * episodes/by_slug
  88 * episodes/need_update
  89
  90
  91 Favorites
  92 ---------
  93 Doc-Types: EpisodeUserState
  94
  95 **Views**
  96
  97 * episodes/favorites_by_user
  98
  99
 100 Heatmap
 101 -------
 102
 103 Doc-Types: EpisodeUserState
 104
 105 **Views**
 106
 107 * heatmap/by_episode
 108
 109
 110 History
 111 -------
 112
 113 Doc-Types: EpisodeUserState, PodcastUserState
 114
 115 **Views**
 116
 117 * history/by_device
 118 * history/by_user
 119
 120
 121 Listeners
 122 ---------
 123
 124 Doc-Types: EpisodeUserState
 125
 126 **Views**
 127
 128 * listeners/by_episode
 129 * listeners/by_podcast_episode
 130 * listeners/by_podcast
 131 * listeners/by_user
 132 * listeners/by_user_podcast
 133 * listeners/times_played_by_user
 134
 135
 136 Podcast Lists
 137 -------------
 138
 139 Doc-Types: PodcastList
 140
 141 **Views**
 142
 143 * podcastlists/by_rating
 144 * podcastlists/by_user_slug
 145 * podcastlists/random
 146
 147
 148 Podcast States
 149 --------------
 150
 151 Doc-Types: PodcastUserState
 152
 153 **Views**
 154
 155 * podcast_states/by_device
 156 * podcast_states/by_podcast
 157 * podcast_states/by_user
 158
 159
 160 Podcasts
 161 --------
 162
 163 Doc-Types: Podcast, PodcastGroup, PodcastSubscriberData
 164
 165 **Views**
 166
 167 * podcasts/by_id
 168 * podcasts/by_language
 169 * podcasts/by_last_update
 170 * podcasts/by_oldid
 171 * podcasts/by_slug
 172 * podcasts/by_tag
 173 * podcasts/by_url
 174 * podcasts/flattr
 175 * podcasts/groups_by_oldid
 176 * podcasts/podcasts_groups
 177 * podcasts/random
 178 * podcasts/subscriber_data
 179
 180
 181 Sanitizing Rules
 182 ----------------
 183
 184 Doc-Types: SanitizingRule
 185
 186 **Views**
 187
 188 * sanitizing_rules/by_slug
 189 * sanitizing_rules/by_target
 190
 191
 192 Slugs
 193 -----
 194
 195 Doc-Types: Podcast, PodcastGroup, Episode
 196
 197 **Views**
 198
 199 * slugs/missing
 200
 201
 202 Subscribers
 203 -----------
 204
 205 Doc-Types: PodcastUserState
 206
 207 **Views**
 208
 209 * subscribers/by_podcast
 210
 211
 212 Subscriptions
 213 -------------
 214
 215 Doc-Types: PodcastUserState
 216
 217 **Views**
 218
 219 * subscriptions/by_device
 220 * subscriptions/by_podcast
 221 * subscriptions/by_user
 222
 223
 224 Suggestions
 225 -----------
 226
 227 Doc-Types: Suggestions
 228
 229 **Views**
 230
 231 * suggestions/by_user
 232
 233
 234 Tags
 235 ----
 236
 237 Doc-Types: Podcast, PodcastGroup
 238
 239 **Views**
 240
 241 * tags/by_podcast
 242 * tags/by_user
 243
 244
 245 Toplists
 246 --------
 247
 248 Doc-Types: Episode, Podcast, PodcastGroup
 249
 250 **Views**
 251
 252 * toplist/episodes
 253 * toplist/podcasts
 254
 255
 256 Trending
 257 --------
 258
 259 Doc-Types: Podcast, PodcastGroup
 260
 261 **Views**
 262
 263 * trending/podcasts
 264
 265
 266 Users
 267 -----
 268
 269 Doc-Types: User
 270
 271 **Views**
 272
 273 * users/by_google_email
 274 * users/deleted
 275
 276
 277 User-Tags
 278 ---------
 279
 280 Doc-Types: PodcastUserState
 281
 282 * usertags/by_podcast
 283 * usertags/podcasts