Documentation on geospatial indexes and how to create them explicitly
This commit is contained in:
parent
d3962c4f7d
commit
734986c1b5
@ -382,11 +382,26 @@ If a dictionary is passed then the following options are available:
|
||||
:attr:`unique` (Default: False)
|
||||
Whether the index should be sparse.
|
||||
|
||||
.. note::
|
||||
|
||||
Geospatial indexes
|
||||
---------------------------
|
||||
Geospatial indexes will be automatically created for all
|
||||
:class:`~mongoengine.GeoPointField`\ s
|
||||
|
||||
It is also possible to explicitly define geospatial indexes. This is
|
||||
useful if you need to define a geospatial index on a subfield of a
|
||||
:class:`~mongoengine.DictField` or a custom field that contains a
|
||||
point. To create a geospatial index you must prefix the field with the
|
||||
***** sign. ::
|
||||
|
||||
class Place(Document):
|
||||
location = DictField()
|
||||
meta = {
|
||||
'indexes': [
|
||||
'*location.point',
|
||||
],
|
||||
}
|
||||
|
||||
Ordering
|
||||
========
|
||||
A default ordering can be specified for your
|
||||
|
Loading…
x
Reference in New Issue
Block a user