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

Merge pull request #2475 from bagerard/fix_imprecise_doc_collection_name

Browse Source 
Fix for imprecise doc on collection name (CamelCase -> snake_case)
This commit is contained in:
Bastien Gérard 2021-02-22 19:52:28 +01:00 committed by GitHub
commit d033e3b133
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -432,10 +432,10 @@ Document collections
==================== ====================
Document classes that inherit **directly** from :class:`~mongoengine.Document` Document classes that inherit **directly** from :class:`~mongoengine.Document`
will have their own **collection** in the database. The name of the collection will have their own **collection** in the database. The name of the collection
is by default the name of the class, converted to lowercase (so in the example is by default the name of the class converted to snake_case (e.g if your Document class
above, the collection would be called `page`). If you need to change the name is named `CompanyUser`, the corresponding collection would be `company_user`). If you need
of the collection (e.g. to use MongoEngine with an existing database), then to change the name of the collection (e.g. to use MongoEngine with an existing database),
create a class dictionary attribute called :attr:`meta` on your document, and then create a class dictionary attribute called :attr:`meta` on your document, and
set :attr:`collection` to the name of the collection that you want your set :attr:`collection` to the name of the collection that you want your
document class to use:: document class to use::

2
mongoengine/document.py
View File

@ -109,7 +109,7 @@ class Document(BaseDocument, metaclass=TopLevelDocumentMetaclass):
By default, the MongoDB collection used to store documents created using a By default, the MongoDB collection used to store documents created using a
:class:`~mongoengine.Document` subclass will be the name of the subclass :class:`~mongoengine.Document` subclass will be the name of the subclass
converted to lowercase. A different collection may be specified by converted to snake_case. A different collection may be specified by
providing :attr:`collection` to the :attr:`meta` dictionary in the class providing :attr:`collection` to the :attr:`meta` dictionary in the class
definition. definition.