Skip to content

Commit 2f29d69

Browse files
committed
docs: update documentation based on changes
1 parent d86daba commit 2f29d69

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,3 +263,4 @@ that much better:
263263
* Timothé Perez (https://github.com/AchilleAsh)
264264
* oleksandr-l5 (https://github.com/oleksandr-l5)
265265
* Ido Shraga (https://github.com/idoshr)
266+
* Terence Honles (https://github.com/terencehonles)

docs/changelog.rst

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,41 @@ Changelog
77
Development
88
===========
99
- (Fill this out as you fix issues and develop your features).
10-
- EnumField improvements: now `choices` limits the values of an enum to allow
10+
- EnumField improvements: now ``choices`` limits the values of an enum to allow
1111
- Fix bug that prevented instance queryset from using custom queryset_class #2589
1212
- Fix deepcopy of EmbeddedDocument #2202
1313
- Fix error when using precision=0 with DecimalField #2535
1414
- Add support for regex and whole word text search query #2568
15+
- BREAKING CHANGE: Updates to support pymongo 4.0. Where possible deprecated
16+
functionality has been migrated, but additional care should be taken when
17+
migrating to pymongo 4.0 as existing code may have been using deprecated
18+
features which have now been removed #2614.
19+
20+
For the pymongo migration guide see:
21+
https://pymongo.readthedocs.io/en/stable/migrate-to-pymongo4.html.
22+
23+
In addition to the changes in the migration guide, the following is a high
24+
level overview of the changes made to MongoEngine when using pymongo 4.0:
25+
26+
- limited support of geohaystack indexes has been removed
27+
- ``QuerySet.map_reduce`` has been migrated from ``Collection.map_reduce``
28+
and ``Collection.inline_map_reduce`` to use
29+
``db.command({mapReduce: ..., ...})`` and support between the two may need
30+
additional verification.
31+
- UUIDs are encoded with the ``pythonLegacy`` encoding by default instead of
32+
the newer and cross platform ``standard`` encoding. Existing UUIDs will
33+
need to be migrated before changing the encoding, and this should be done
34+
explicitly by the user rather than switching to a new default by
35+
MongoEngine. This default will change at a later date, but to allow
36+
specifying and then migrating to the new format a default ``json_options``
37+
has been provided.
38+
- ``Queryset.count`` has been using ``Collection.count_documents`` and
39+
transparently falling back to ``Collection.count`` when using features that
40+
are not supported by ``Collection.count_documents``. ``Collection.count``
41+
has been removed and no automatic fallback is possible. The migration guide
42+
documents the extended functionality which is no longer supported. Rewrite
43+
the unsupported queries or fetch the whole result set and perform the count
44+
locally.
1545

1646
Changes in 0.23.1
1747
===========

0 commit comments

Comments
 (0)