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

Document the index option and the fact that additional options gets forwarded to pymongo's create_index method

Browse Source
This commit is contained in:
Bastien Gérard 2018-10-22 21:54:46 +02:00
parent b0148e7860
commit 83fe7f7eef
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/guide/defining-documents.rst
View File

@ -492,7 +492,9 @@ the field name with a **#**::
] ]
} }
If a dictionary is passed then the following options are available: If a dictionary is passed then additional options become available. Valid options include,
but are not limited to:
:attr:`fields` (Default: None) :attr:`fields` (Default: None)
The fields to index. Specified in the same format as described above. The fields to index. Specified in the same format as described above.
@ -516,8 +518,12 @@ If a dictionary is passed then the following options are available:
:attr:`name` (Optional) :attr:`name` (Optional)
Allows you to specify a name for the index Allows you to specify a name for the index
:attr:`collation` (Optional)
Allows to create case insensitive indexes (MongoDB v3.4+ only)
.. note:: .. note::
Additional options are forwarded as **kwargs to pymongo's create_index method.
Inheritance adds extra fields indices see: :ref:`document-inheritance`. Inheritance adds extra fields indices see: :ref:`document-inheritance`.
Global index default options Global index default options
@ -736,7 +742,7 @@ document.::
.. note:: From 0.8 onwards :attr:`allow_inheritance` defaults .. note:: From 0.8 onwards :attr:`allow_inheritance` defaults
to False, meaning you must set it to True to use inheritance. to False, meaning you must set it to True to use inheritance.
Setting :attr:`allow_inheritance` to True should also be used in Setting :attr:`allow_inheritance` to True should also be used in
:class:`~mongoengine.EmbeddedDocument` class in case you need to subclass it :class:`~mongoengine.EmbeddedDocument` class in case you need to subclass it