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

Add documentation for auto_create_index to the Indexing section of the Docs

Browse Source
This commit is contained in:
Ryan Scott 2017-11-07 16:26:01 -05:00
parent ea25972257
commit 4f5b0634ad
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -526,8 +526,9 @@ There are a few top level defaults for all indexes that can be set::
meta = { meta = {
'index_options': {}, 'index_options': {},
'index_background': True, 'index_background': True,
'index_cls': False,
'auto_create_index': True,
'index_drop_dups': True, 'index_drop_dups': True,
'index_cls': False
} }
@ -540,6 +541,12 @@ There are a few top level defaults for all indexes that can be set::
:attr:`index_cls` (Optional) :attr:`index_cls` (Optional)
A way to turn off a specific index for _cls. A way to turn off a specific index for _cls.
:attr:`auto_create_index` (Optional)
When this is True (default), MongoEngine will ensure that the correct
indexes exist in MongoDB each time a command is run. This can be disabled
in systems where indexes are managed separately. Disabling this will improve
performance.
:attr:`index_drop_dups` (Optional) :attr:`index_drop_dups` (Optional)
Set the default value for if an index should drop duplicates Set the default value for if an index should drop duplicates