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 The views are separated into groups, based on the databases they are indexed
   9 on.
  10
  11 General
  12 -------
  13
  14 This group of views is available on the general database, called ``mygpo`` by
  15 default.
  16
  17
  18 Chapters
  19 ^^^^^^^^
  20
  21 Doc-Types: EpisodeUserState
  22
  23 **Views**
  24
  25 * `chapters/by_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/chapters/views/by_episode>`_
  26
  27
  28 Clients
  29 ^^^^^^^
  30
  31 Doc-Types: User
  32
  33 **Views**
  34
  35 * `clients/by_ua_string <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/clients/views/by_ua_string>`_
  36
  37
  38 Episode Actions
  39 ^^^^^^^^^^^^^^^
  40
  41 Doc-Types: EpisodeUserState
  42
  43 **Views**
  44
  45 * `episode_actions/by_device <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_actions/views/by_device>`_
  46 * `episode_actions/by_podcast_device <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_actions/views/by_podcast_device>`_
  47 * `episode_actions/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_actions/views/by_podcast>`_
  48 * `episode_actions/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_actions/views/by_user>`_
  49
  50
  51 Episode States
  52 ^^^^^^^^^^^^^^
  53
  54 Doc-Types: EpisodeUserState
  55
  56 **Views**
  57
  58 * `episode_states/by_podcast_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_states/views/by_podcast_episode>`_
  59 * `episode_states/by_ref_urls <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_states/views/by_ref_urls>`_
  60 * `episode_states/by_user_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_states/views/by_user_episode>`_
  61 * `episode_states/by_user_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_states/views/by_user_podcast>`_
  62
  63
  64 Episode Statistics
  65 ^^^^^^^^^^^^^^^^^^
  66
  67 Doc-Types: Episode
  68
  69 **Views**
  70
  71 * `episode_stats/filetypes <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_stats/views/filetypes>`_
  72
  73
  74 Episodes
  75 ^^^^^^^^
  76
  77 Doc-Types: Episode
  78
  79 **Views**
  80
  81 * `episodes/by_id <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episodes/views/by_id>`_
  82 * `episodes/by_oldid <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episodes/views/by_oldid>`_
  83 * `episodes/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episodes/views/by_podcast>`_
  84 * `episodes/by_podcast_url <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episodes/views/by_podcast_url>`_
  85 * `episodes/by_slug <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episodes/views/by_slug>`_
  86 * `episodes/need_update <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episodes/views/need_update>`_
  87
  88
  89 Favorites
  90 ^^^^^^^^^
  91
  92 Doc-Types: EpisodeUserState
  93
  94 **Views**
  95
  96 * `episodes/favorites_by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/favorites/views/episodes_by_user>`_
  97
  98
  99 Heatmap
 100 ^^^^^^^
 101
 102 Doc-Types: EpisodeUserState
 103
 104 **Views**
 105
 106 * `heatmap/by_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/heatmap/views/by_episode>`_
 107
 108
 109 History
 110 ^^^^^^^
 111
 112 Doc-Types: EpisodeUserState, PodcastUserState
 113
 114 **Views**
 115
 116 * `history/by_device <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/history/views/by_device>`_
 117 * `history/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/history/views/by_user>`_
 118
 119
 120 Listeners
 121 ^^^^^^^^^
 122
 123 Doc-Types: EpisodeUserState
 124
 125 **Views**
 126
 127 * `listeners/by_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/by_episode>`_
 128 * `listeners/by_podcast_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/by_podcast_episode>`_
 129 * `listeners/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/by_podcast>`_
 130 * `listeners/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/by_user>`_
 131 * `listeners/by_user_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/by_user_podcast>`_
 132 * `listeners/times_played_by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/times_played_by_user>`_
 133
 134
 135 Podcast Lists
 136 ^^^^^^^^^^^^^
 137
 138 Doc-Types: PodcastList
 139
 140 **Views**
 141
 142 * `podcastlists/by_rating <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcastlists/views/by_rating>`_
 143 * `podcastlists/by_user_slug <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcastlists/views/by_user_slug>`_
 144 * `podcastlists/random <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcastlists/views/random>`_
 145
 146
 147 Podcast States
 148 ^^^^^^^^^^^^^^
 149
 150 Doc-Types: PodcastUserState
 151
 152 **Views**
 153
 154 * `podcast_states/by_device <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcast_states/views/by_device>`_
 155 * `podcast_states/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcast_states/views/by_podcast>`_
 156 * `podcast_states/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcast_states/views/by_user>`_
 157
 158
 159 Podcasts
 160 ^^^^^^^^
 161
 162 Doc-Types: Podcast, PodcastGroup, PodcastSubscriberData
 163
 164 **Views**
 165
 166 * `podcasts/by_id <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_id>`_
 167 * `podcasts/by_language <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_language>`_
 168 * `podcasts/by_last_update <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_last_update>`_
 169 * `podcasts/by_oldid <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_oldid>`_
 170 * `podcasts/by_slug <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_slug>`_
 171 * `podcasts/by_tag <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_tag>`_
 172 * `podcasts/by_url <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_url>`_
 173 * `podcasts/flattr <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/flattr>`_
 174 * `podcasts/groups_by_oldid <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/groups_by_oldid>`_
 175 * `podcasts/podcasts_groups <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/podcasts_groups>`_
 176 * `podcasts/random <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/random>`_
 177 * `podcasts/subscriber_data <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/subscriber_data>`_
 178
 179
 180 Slugs
 181 ^^^^^
 182
 183 Doc-Types: Podcast, PodcastGroup, Episode
 184
 185 **Views**
 186
 187 * `slugs/missing <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/slugs/views/missing>`_
 188
 189
 190 Subscribers
 191 ^^^^^^^^^^^
 192
 193 Doc-Types: PodcastUserState
 194
 195 **Views**
 196
 197 * `subscribers/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/subscribers/views/by_podcast>`_
 198
 199
 200 Subscriptions
 201 ^^^^^^^^^^^^^
 202
 203 Doc-Types: PodcastUserState
 204
 205 **Views**
 206
 207 * `subscriptions/by_device <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/subscriptions/views/by_device>`_
 208 * `subscriptions/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/subscriptions/views/by_podcast>`_
 209 * `subscriptions/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/subscriptions/views/by_user>`_
 210
 211
 212 Suggestions
 213 ^^^^^^^^^^^
 214
 215 Doc-Types: Suggestions
 216
 217 **Views**
 218
 219 * `suggestions/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/suggestions/views/by_user>`_
 220
 221
 222 Tags
 223 ^^^^
 224
 225 Doc-Types: Podcast, PodcastGroup
 226
 227 **Views**
 228
 229 * `tags/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/tags/views/by_podcast>`_
 230 * `tags/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/tags/views/by_user>`_
 231
 232
 233 Toplists
 234 ^^^^^^^^
 235
 236 Doc-Types: Episode, Podcast, PodcastGroup
 237
 238 **Views**
 239
 240 * `toplist/episodes <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/toplist/views/episodes>`_
 241 * `toplist/podcasts <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/toplist/views/podcasts>`_
 242
 243
 244 Trending
 245 ^^^^^^^^
 246
 247 Doc-Types: Podcast, PodcastGroup
 248
 249 **Views**
 250
 251 * `trending/podcasts <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/trending/views/podcasts>`_
 252
 253
 254 Users
 255 ^^^^^
 256
 257 Doc-Types: User
 258
 259 **Views**
 260
 261 * `users/by_google_email <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/users/views/by_google_email>`_
 262 * `users/deleted <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/users/views/deleted>`_
 263
 264
 265 User-Tags
 266 ^^^^^^^^^
 267
 268 Doc-Types: PodcastUserState
 269
 270 **Views**
 271
 272 * `usertags/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/usertags/views/by_podcast>`_
 273 * `usertags/podcasts <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/usertags/views/podcasts>`_
 274
 275
 276
 277
 278 Categories
 279 ----------
 280
 281 This group of views is available on the categories database, called
 282 ``mygpo_categories`` by default.
 283
 284
 285 Categories
 286 ^^^^^^^^^^
 287
 288 Doc-Types: Category
 289
 290 **Views**
 291
 292 * `categories/by_tags <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/categories/views/by_tags>`_
 293 * `categories/by_update <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/categories/views/by_update>`_
 294
 295
 296 Pubsub
 297 ------
 298
 299 The following views and design documents relate to the "pubsub" database.
 300
 301 Subscriptions
 302 ^^^^^^^^^^^^^
 303
 304 Doc-Types: Subscription
 305
 306 **Views**
 307
 308 * `subscriptions/by_topic <https://github.com/gpodder/mygpo/tree/master/couchdb/pubsub/_design/subscriptions/views/by_topic>`_