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