Added example of indexing embedded fields

MongoEngine/mongoengine#75
2012-08-20 17:50:18 +01:00
parent be8d39a48c
commit 1b80193aac
3 changed files with 35 additions and 5 deletions
--- a/docs/guide/defining-documents.rst
+++ b/docs/guide/defining-documents.rst
@@ -467,11 +467,16 @@ If a dictionary is passed then the following options are available:
 :attr:`unique` (Default: False)
    Whether the index should be sparse.

+.. note ::
+
+    To index embedded files / dictionary fields use 'dot' notation eg:
+    `rank.title`
+
 .. warning::

-
-   Inheritance adds extra indices.
-   If don't need inheritance for a document turn inheritance off - see :ref:`document-inheritance`.
+    Inheritance adds extra indices.
+    If don't need inheritance for a document turn inheritance off -
+    see :ref:`document-inheritance`.


 Geospatial indexes