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

Merge pull request #1691 from rcscott/document-auto-create-index

Browse Source 
Add documentation for auto_create_index to the Indexing section of the Docs
This commit is contained in:
erdenezul 2018-05-21 08:55:25 +08:00 committed by GitHub
commit 765038274c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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

@ -528,8 +528,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
} }
@ -542,6 +543,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