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