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