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