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