pub/mongoengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added create_index method, warnings for drop_dups and a geohaystack test

Browse Source
This commit is contained in:
Matthieu Rigal 2015-06-01 23:12:43 +02:00
parent 283e92d55d
commit f35d0b2b37
2 changed files with 69 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
mongoengine/document.py
View File

@ -1,4 +1,4 @@
import warnings
import pymongo import pymongo
import re import re
@ -17,6 +17,7 @@ from mongoengine.base import (
get_document get_document
) )
from mongoengine.errors import InvalidQueryError, InvalidDocumentError from mongoengine.errors import InvalidQueryError, InvalidDocumentError
from mongoengine.python_support import IS_PYMONGO_3
from mongoengine.queryset import (OperationError, NotUniqueError, from mongoengine.queryset import (OperationError, NotUniqueError,
QuerySet, transform) QuerySet, transform)
from mongoengine.connection import get_db, DEFAULT_CONNECTION_NAME from mongoengine.connection import get_db, DEFAULT_CONNECTION_NAME
@ -629,28 +630,51 @@ class Document(BaseDocument):
db = cls._get_db() db = cls._get_db()
db.drop_collection(cls._get_collection_name()) db.drop_collection(cls._get_collection_name())
@classmethod
def create_index(cls, keys, background=False, **kwargs):
"""Creates the given indexes if required.
:param keys: a single index key or a list of index keys (to
construct a multi-field index); keys may be prefixed with a **+**
or a **-** to determine the index ordering
:param background: Allows index creation in the background
"""
index_spec = cls._build_index_spec(keys)
index_spec = index_spec.copy()
fields = index_spec.pop('fields')
drop_dups = kwargs.get('drop_dups', False)
if IS_PYMONGO_3 and drop_dups:
msg = "drop_dups is deprecated and is removed when using PyMongo 3+."
warnings.warn(msg, DeprecationWarning)
elif not IS_PYMONGO_3:
index_spec['drop_dups'] = drop_dups
index_spec['background'] = background
index_spec.update(kwargs)
if IS_PYMONGO_3:
return cls._get_collection().create_index(fields, **index_spec)
else:
return cls._get_collection().ensure_index(fields, **index_spec)
@classmethod @classmethod
def ensure_index(cls, key_or_list, drop_dups=False, background=False, def ensure_index(cls, key_or_list, drop_dups=False, background=False,
**kwargs): **kwargs):
"""Ensure that the given indexes are in place. """Ensure that the given indexes are in place. Deprecated in favour
of create_index.
:param key_or_list: a single index key or a list of index keys (to :param key_or_list: a single index key or a list of index keys (to
construct a multi-field index); keys may be prefixed with a **+** construct a multi-field index); keys may be prefixed with a **+**
or a **-** to determine the index ordering or a **-** to determine the index ordering
:param background: Allows index creation in the background :param background: Allows index creation in the background
:param drop_dups: Was removed with MongoDB 3. The value will be :param drop_dups: Was removed/ignored with MongoDB >2.7.5. The value
removed if PyMongo3+ is used will be removed if PyMongo3+ is used
""" """
index_spec = cls._build_index_spec(key_or_list) if IS_PYMONGO_3 and drop_dups:
index_spec = index_spec.copy() msg = "drop_dups is deprecated and is removed when using PyMongo 3+."
fields = index_spec.pop('fields') warnings.warn(msg, DeprecationWarning)
index_spec['drop_dups'] = drop_dups elif not IS_PYMONGO_3:
# TODO: raise warning if dropdups given and remove with PyMongo3+ kwargs.update({'drop_dups': drop_dups})
index_spec['background'] = background return cls.create_index(key_or_list, background=background, **kwargs)
index_spec.update(kwargs)
# TODO: ensure_index is deprecated
return cls._get_collection().ensure_index(fields, **index_spec)
@classmethod @classmethod
def ensure_indexes(cls): def ensure_indexes(cls):
@ -665,6 +689,9 @@ class Document(BaseDocument):
drop_dups = cls._meta.get('index_drop_dups', False) drop_dups = cls._meta.get('index_drop_dups', False)
index_opts = cls._meta.get('index_opts') or {} index_opts = cls._meta.get('index_opts') or {}
index_cls = cls._meta.get('index_cls', True) index_cls = cls._meta.get('index_cls', True)
if IS_PYMONGO_3 and drop_dups:
msg = "drop_dups is deprecated and is removed when using PyMongo 3+."
warnings.warn(msg, DeprecationWarning)
collection = cls._get_collection() collection = cls._get_collection()
# 746: when connection is via mongos, the read preference is not necessarily an indication that # 746: when connection is via mongos, the read preference is not necessarily an indication that
@ -693,9 +720,11 @@ class Document(BaseDocument):
if 'cls' in opts: if 'cls' in opts:
del opts['cls'] del opts['cls']
# TODO: ensure_index is deprecated in PyMongo 3+ and drop_dups removed if IS_PYMONGO_3:
collection.ensure_index(fields, background=background, collection.create_index(fields, background=background, **opts)
drop_dups=drop_dups, **opts) else:
collection.ensure_index(fields, background=background,
drop_dups=drop_dups, **opts)
# If _cls is being used (for polymorphism), it needs an index, # If _cls is being used (for polymorphism), it needs an index,
# only if another index doesn't begin with _cls # only if another index doesn't begin with _cls
@ -707,9 +736,12 @@ class Document(BaseDocument):
if 'cls' in index_opts: if 'cls' in index_opts:
del index_opts['cls'] del index_opts['cls']
# TODO: ensure_index is deprecated in PyMongo 3+ if IS_PYMONGO_3:
collection.ensure_index('_cls', background=background, collection.create_index('_cls', background=background,
**index_opts) **index_opts)
else:
collection.ensure_index('_cls', background=background,
**index_opts)
@classmethod @classmethod
def list_indexes(cls, go_up=True, go_down=True): def list_indexes(cls, go_up=True, go_down=True):

23
tests/document/indexes.py
View File

@ -298,19 +298,18 @@ class IndexesTest(unittest.TestCase):
def test_explicit_geohaystack_index(self): def test_explicit_geohaystack_index(self):
"""Ensure that geohaystack indexes work when created via meta[indexes] """Ensure that geohaystack indexes work when created via meta[indexes]
""" """
raise SkipTest('GeoHaystack index creation seems broken on PyMongo' raise SkipTest('GeoHaystack index creation is not supported for now'
'side, as it requires a bucketSize parameter.') 'from meta, as it requires a bucketSize parameter.')
class Place(Document): class Place(Document):
location = DictField() location = DictField()
name = StringField()
meta = { meta = {
'allow_inheritance': True,
'indexes': [ 'indexes': [
')location.point', (')location.point', 'name')
] ]
} }
self.assertEqual([{'fields': [('location.point', 'geoHaystack'), ('name', 1)]}],
self.assertEqual([{'fields': [('location.point', 'geoHaystack')]}],
Place._meta['index_specs']) Place._meta['index_specs'])
Place.ensure_indexes() Place.ensure_indexes()
@ -318,6 +317,18 @@ class IndexesTest(unittest.TestCase):
info = [value['key'] for key, value in info.iteritems()] info = [value['key'] for key, value in info.iteritems()]
self.assertTrue([('location.point', 'geoHaystack')] in info) self.assertTrue([('location.point', 'geoHaystack')] in info)
def test_create_geohaystack_index(self):
"""Ensure that geohaystack indexes can be created
"""
class Place(Document):
location = DictField()
name = StringField()
Place.ensure_index({'fields': (')location.point', 'name')}, bucketSize=10)
info = Place._get_collection().index_information()
info = [value['key'] for key, value in info.iteritems()]
self.assertTrue([('location.point', 'geoHaystack'), ('name', 1)] in info)
def test_dictionary_indexes(self): def test_dictionary_indexes(self):
"""Ensure that indexes are used when meta[indexes] contains """Ensure that indexes are used when meta[indexes] contains
dictionaries instead of lists. dictionaries instead of lists.