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_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episodes/views/by_podcast>`_
  47 * `episodes/by_podcast_url <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episodes/views/by_podcast_url>`_
  48 * `episodes/need_update <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episodes/views/need_update>`_
  49
  50
  51 Podcast Lists
  52 ^^^^^^^^^^^^^
  53
  54 Doc-Types: PodcastList
  55
  56 **Views**
  57
  58 * `podcastlists/by_rating <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcastlists/views/by_rating>`_
  59 * `podcastlists/by_user_slug <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcastlists/views/by_user_slug>`_
  60 * `podcastlists/random <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcastlists/views/random>`_
  61
  62
  63 Podcasts
  64 ^^^^^^^^
  65
  66 Doc-Types: Podcast, PodcastGroup, PodcastSubscriberData
  67
  68 **Views**
  69
  70 * `podcasts/by_id <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_id>`_
  71 * `podcasts/by_language <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_language>`_
  72 * `podcasts/by_slug <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_slug>`_
  73 * `podcasts/by_tag <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_tag>`_
  74 * `podcasts/by_url <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/by_url>`_
  75 * `podcasts/podcasts_groups <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/podcasts_groups>`_
  76 * `podcasts/subscriber_data <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcasts/views/subscriber_data>`_
  77
  78
  79 Slugs
  80 ^^^^^
  81
  82 Doc-Types: Podcast, PodcastGroup, Episode
  83
  84 **Views**
  85
  86 * `slugs/missing <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/slugs/views/missing>`_
  87
  88
  89 Suggestions
  90 ^^^^^^^^^^^
  91
  92 Doc-Types: Suggestions
  93
  94 **Views**
  95
  96 * `suggestions/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/suggestions/views/by_user>`_
  97
  98
  99 Tags
 100 ^^^^
 101
 102 Doc-Types: Podcast, PodcastGroup
 103
 104 **Views**
 105
 106 * `tags/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/tags/views/by_podcast>`_
 107
 108
 109 Toplists
 110 ^^^^^^^^
 111
 112 Doc-Types: Episode, Podcast, PodcastGroup
 113
 114 **Views**
 115
 116 * `toplist/episodes <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/toplist/views/episodes>`_
 117 * `toplist/podcasts <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/toplist/views/podcasts>`_
 118
 119
 120 Trending
 121 ^^^^^^^^
 122
 123 Doc-Types: Podcast, PodcastGroup
 124
 125 **Views**
 126
 127 * `trending/podcasts <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/trending/views/podcasts>`_
 128
 129
 130 Users
 131 ^^^^^
 132
 133 Doc-Types: User
 134
 135 **Views**
 136
 137 * `users/by_google_email <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/users/views/by_google_email>`_
 138 * `users/deleted <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/users/views/deleted>`_
 139
 140
 141 Userdata
 142 --------
 143
 144 This group of views is available in the *userdata* database, called
 145 ``mygpo_userdata`` by default.
 146
 147 Chapters
 148 ^^^^^^^^
 149
 150 Doc-Types: EpisodeUserState
 151
 152 **Views**
 153
 154 * `chapters/by_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/chapters/views/by_episode>`_
 155
 156
 157 Episode Actions
 158 ^^^^^^^^^^^^^^^
 159
 160 Doc-Types: EpisodeUserState
 161
 162 **Views**
 163
 164 * `episode_actions/by_device <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_actions/views/by_device>`_
 165 * `episode_actions/by_podcast_device <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_actions/views/by_podcast_device>`_
 166 * `episode_actions/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_actions/views/by_podcast>`_
 167 * `episode_actions/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_actions/views/by_user>`_
 168
 169
 170 Episode States
 171 ^^^^^^^^^^^^^^
 172
 173 Doc-Types: EpisodeUserState
 174
 175 **Views**
 176
 177 * `episode_states/by_podcast_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_states/views/by_podcast_episode>`_
 178 * `episode_states/by_ref_urls <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_states/views/by_ref_urls>`_
 179 * `episode_states/by_user_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_states/views/by_user_episode>`_
 180 * `episode_states/by_user_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/episode_states/views/by_user_podcast>`_
 181
 182
 183 Favorites
 184 ^^^^^^^^^
 185
 186 Doc-Types: EpisodeUserState
 187
 188 **Views**
 189
 190 * `episodes/favorites_by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/favorites/views/episodes_by_user>`_
 191
 192
 193 Heatmap
 194 ^^^^^^^
 195
 196 Doc-Types: EpisodeUserState
 197
 198 **Views**
 199
 200 * `heatmap/by_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/heatmap/views/by_episode>`_
 201
 202
 203 History
 204 ^^^^^^^
 205
 206 Doc-Types: EpisodeUserState, PodcastUserState
 207
 208 **Views**
 209
 210 * `history/by_device <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/history/views/by_device>`_
 211 * `history/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/history/views/by_user>`_
 212
 213
 214 Listeners
 215 ^^^^^^^^^
 216
 217 Doc-Types: EpisodeUserState
 218
 219 **Views**
 220
 221 * `listeners/by_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/by_episode>`_
 222 * `listeners/by_podcast_episode <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/by_podcast_episode>`_
 223 * `listeners/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/by_podcast>`_
 224 * `listeners/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/by_user>`_
 225 * `listeners/by_user_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/by_user_podcast>`_
 226 * `listeners/times_played_by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/listeners/views/times_played_by_user>`_
 227
 228
 229 Podcast States
 230 ^^^^^^^^^^^^^^
 231
 232 Doc-Types: PodcastUserState
 233
 234 **Views**
 235
 236 * `podcast_states/by_device <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcast_states/views/by_device>`_
 237 * `podcast_states/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcast_states/views/by_podcast>`_
 238 * `podcast_states/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/podcast_states/views/by_user>`_
 239
 240
 241 Subscribers
 242 ^^^^^^^^^^^
 243
 244 Doc-Types: PodcastUserState
 245
 246 **Views**
 247
 248 * `subscribers/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/subscribers/views/by_podcast>`_
 249
 250
 251 Subscriptions
 252 ^^^^^^^^^^^^^
 253
 254 Doc-Types: PodcastUserState
 255
 256 **Views**
 257
 258 * `subscriptions/by_device <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/subscriptions/views/by_device>`_
 259 * `subscriptions/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/subscriptions/views/by_podcast>`_
 260 * `subscriptions/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/subscriptions/views/by_user>`_
 261
 262
 263 User-Tags
 264 ^^^^^^^^^
 265
 266 Doc-Types: PodcastUserState
 267
 268 **Views**
 269
 270 * `usertags/by_podcast <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/usertags/views/by_podcast>`_
 271 * `usertags/by_user <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/usertags/views/by_user>`_
 272 * `usertags/podcasts <https://github.com/gpodder/mygpo/tree/master/couchdb/general/_design/usertags/views/podcasts>`_
 273
 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>`_