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