doc/couch/views.txt

   1
   2
   3                          View Overview
   4                          ~~~~~~~~~~~~~
   5
   6
   7 This file describes the views that will be used in the CouchDB based backend of
   8 the gpodder.net webservice.
   9
  10 View groups are roughly divided into those that access use-generated documents
  11 (e.g. PodcastUserState, EpisodeUserState) and those that don't.
  12
  13
  14 Categories
  15 ==========
  16
  17 Doc-Types: Category
  18
  19 Views:
  20 * categories/by_tags
  21 * categories/by_weight
  22
  23
  24 Chapters
  25 ========
  26
  27 Doc-Types: EpisodeUserState
  28
  29 Views:
  30 * chapters/by_episode
  31
  32
  33 Episode Actions
  34 ===============
  35
  36 Doc-Types: EpisodeUserState
  37
  38 Views:
  39 * episode_actions/by_device
  40 * episode_actions/by_podcast
  41 * episode_actions/by_podcast_device
  42 * episode_actions/by_user
  43
  44
  45 Episodes
  46 ========
  47
  48 Doc-Types: Episode
  49
  50 Views:
  51 * episodes/by_id
  52 * episodes/by_oldid
  53 * episodes/by_podcast
  54 * episodes/by_podcast_url
  55 * episodes/by_slug
  56 * episodes/need_update
  57
  58
  59 Favorites
  60 =========
  61 Doc-Types: EpisodeUserState
  62
  63 Views:
  64 * episodes/favorites_by_user
  65
  66
  67 Episode States
  68 ==============
  69
  70 Doc-Types: EpisodeUserState
  71
  72 Views:
  73 * episode_states/by_podcast_episode
  74 * episode_states/by_ref_urls
  75 * episode_states/by_user_episode
  76 * episode_states/by_user_podcast
  77
  78
  79 Heatmap
  80 =======
  81
  82 Doc-Types: EpisodeUserState
  83
  84 Views:
  85 * heatmap/by_episode
  86
  87
  88 History
  89 =======
  90
  91 Doc-Types: EpisodeUserState, PodcastUserState
  92
  93 Views:
  94 * history/by_device
  95 * history/by_user
  96
  97
  98 Listeners
  99 =========
 100
 101 Doc-Types: EpisodeUserState
 102
 103 Views:
 104 * listeners/by_episode
 105 * listeners/by_podcast
 106 * listeners/by_podcast_episode
 107
 108
 109 Podcast Lists
 110 =============
 111
 112 Doc-Types: PodcastList
 113
 114 Views:
 115 * podcastlists/by_rating
 116 * podcastlists/by_user_slug
 117
 118
 119 Podcasts
 120 ========
 121
 122 Doc-Types: Podcast, PodcastGroup
 123
 124 Views:
 125 * podcasts/by_id
 126 * podcasts/by_language
 127 * podcasts/by_last_update
 128 * podcasts/by_oldid
 129 * podcasts/by_slug
 130 * podcasts/by_tag
 131 * podcasts/by_url
 132 * podcasts/groups_by_oldid
 133 * podcasts/podcasts_groups
 134 * podcasts/subscriber_data
 135
 136
 137 Podcast States
 138 ==============
 139
 140 Doc-Types: PodcastUserState
 141
 142 Views:
 143 * podcast_states/by_device
 144
 145
 146 Sanitizing Rules
 147 ================
 148
 149 Doc-Types: SanitizingRule
 150
 151 Views:
 152 * sanitizing_rules/by_slug
 153 * sanitizing_rules/by_target
 154
 155
 156 Slugs
 157 =====
 158
 159 Doc-Types: Podcast, PodcastGroup, Episode
 160
 161 Views:
 162 * slugs/missing
 163
 164
 165
 166 Subscriptions
 167 =============
 168
 169 Doc-Types: PodcastUserState
 170
 171 Views:
 172 * subscriptions/by_device
 173 * subscriptions/by_podcast
 174 * subscriptions/by_user
 175
 176
 177 Suggestions
 178 ===========
 179
 180 Doc-Types: Suggestions
 181
 182 Views:
 183 * suggestions/by_user
 184
 185
 186 Tags
 187 ====
 188
 189 Doc-Types: Podcast, PodcastGroup
 190
 191 Views:
 192 * tags/by_podcast
 193 * tags/by_user
 194
 195
 196 User-Tags
 197 =========
 198
 199 Doc-Types: PodcastUserState
 200 * usertags/by_podcast
 201 * usertags/podcasts
 202
 203
 204 Toplists
 205 ========
 206
 207 Doc-Types: Episode, Podcast, PodcastGroup
 208
 209 Views:
 210 * toplist/episodes
 211 * toplist/podcasts
 212
 213
 214 Users
 215 =====
 216
 217 Doc-Types: User
 218
 219 Views:
 220 * users/deleted