1 # GNU MediaGoblin -- federated, autonomous media hosting
2 # Copyright (C) 2011 Free Software Foundation, Inc
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU Affero General Public License as published by
6 # the Free Software Foundation, either version 3 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU Affero General Public License for more details.
14 # You should have received a copy of the GNU Affero General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 Indexes for the local database.
23 Indexes are recorded in the following format:
27 'identifier': { # key identifier used for possibly deprecating later
28 'index': [index_foo_goes_here]}}
30 ... and anything else being parameters to the create_index function
31 (including unique=True, etc)
33 Current indexes must be registered in ACTIVE_INDEXES... deprecated
34 indexes should be marked in DEPRECATED_INDEXES.
36 Remember, ordering of compound indexes MATTERS. Read below for more.
39 - http://kylebanker.com/blog/2010/09/21/the-joy-of-mongodb-indexes/
41 - http://www.mongodb.org/display/DOCS/Indexes
42 - http://www.mongodb.org/display/DOCS/Indexing+Advice+and+FAQ
45 To remove deprecated indexes
46 ----------------------------
48 Removing deprecated indexes is the same, just move the index into the
49 deprecated indexes mapping.
51 DEPRECATED_INDEXES = {
53 'deprecated_index_identifier1': {
54 'index': [index_foo_goes_here]}}
58 If an index has been deprecated that identifier should NEVER BE USED
59 AGAIN. Eg, if you previously had 'awesomepants_unique', you shouldn't
60 use 'awesomepants_unique' again, you should create a totally new name
61 or at worst use 'awesomepants_unique2'.
64 from pymongo
import ASCENDING
, DESCENDING
75 MEDIAENTRY_INDEXES
= {
76 'uploader_slug_unique': {
77 # Matching an object to an uploader + slug.
78 # MediaEntries are unique on these two combined, eg:
79 # /u/${myuser}/m/${myslugname}/
80 'index': [('uploader', ASCENDING
),
85 # A global index for all media entries created, in descending
86 # order. This is used for the site's frontpage.
87 'index': [('created', DESCENDING
)]},
90 # Indexing on uploaders and when media entries are created.
91 # Used for showing a user gallery, etc.
92 'index': [('uploader', ASCENDING
),
93 ('created', DESCENDING
)]},
95 'state_uploader_tags_created': {
96 # Indexing on processed?, media uploader, associated tags, and timestamp
97 # Used for showing media items matching a tag search, most recent first.
98 'index': [('state', ASCENDING
),
99 ('uploader', ASCENDING
),
100 ('tags.slug', DESCENDING
),
101 ('created', DESCENDING
)]},
103 'state_tags_created': {
104 # Indexing on processed?, media tags, and timestamp (across all users)
105 # This is used for a front page tag search.
106 'index': [('state', ASCENDING
),
107 ('tags.slug', DESCENDING
),
108 ('created', DESCENDING
)]}}
111 ACTIVE_INDEXES
['media_entries'] = MEDIAENTRY_INDEXES
119 # Index usernames, and make sure they're unique.
120 # ... I guess we might need to adjust this once we're federated :)
124 # All most recently created users
128 ACTIVE_INDEXES
['users'] = USER_INDEXES
131 # MediaComment indexes
133 MEDIA_COMMENT_INDEXES
= {
134 'mediaentry_created': {
135 'index': [('media_entry', ASCENDING
),
136 ('created', DESCENDING
)]}}
138 ACTIVE_INDEXES
['media_comments'] = MEDIA_COMMENT_INDEXES
145 DEPRECATED_INDEXES
= {}