What's Changed

• fix fastapi test version by @CAPITAINMARVEL in #1273
• fix: tests failing due to using outdated supercharge/mongodb-action by @adeelsohailahmed in #1277
• docs: clarify state management description by @smahn9123 in #1248
• PYTHON-4238 - Add Beanie version to handshake metadata by @NoahStapp in #1255
• Fix FindQuery.count() ignoring pymongo_kwargs by @veeceey in #1269
• chore: drop EOL Python 3.9, MongoDB 4.4/6.0, Pydantic v1 by @roman-right in #1287
• added docstring to class DocumentWithSoftDelete #928 by @gugu-py in #1241
• Fix OperationFailure when saving with keep_nulls=False and no None values by @veeceey in #1271
• improve class filter and is/is not for enum comparison by @CAPITAINMARVEL in #1275
• Speed up init by avoiding duplicate db commands by @vvuk in #1276
• chore: Uplift pytest and related dependencies by @staticxterm in #1291
• use class from self.class when serializing BackLinks with fetched data by @alexdlukens in #1207
• remove pydantic v1 by @CAPITAINMARVEL in #1290
• Fix fetch_links=True on View raising AttributeError by @roman-right in #1280
• Fix save() OperationFailure with use_revision=True and keep_nulls=False by @roman-right in #1281
• Do not raise DeprecationWarning internally when accessing bucket_rounding_second deprecated field by @staticxterm in #1238
• fix: preserve fetched BackLink values after save() by @roman-right in #1285
• Fix update() raising RevisionIdWasChanged for non-revision DuplicateKeyError by @veeceey in #1270
• chore: modernize Beanie codebase and types for py310+ by @staticxterm in #1293
• docs: add soft delete tutorial (#928) by @smahn9123 in #1297
• Fix decorator type hint by @CAPITAINMARVEL in #1296
• perf(tests): significantly improve test execution time by @staticxterm in #1298
• fix: global logger override in migrations executor by @staticxterm in #1300
• fix: set module metadata before executing migration scripts by @staticxterm in #1299
• Feat/custom class ID by @volfpeter in #1252
• fix: support frozen fields on save() and replace() (#863) by @roman-right in #1282
• fix: handle RootModel with custom iter in save() by @roman-right in #1284
• fix: handle BackLink types in fetch_link and fetch_all_links by @roman-right in #1286
• Fix before_event changes not persisted to DB by @roman-right in #1279
• fix: resolve Pydantic field aliases in nested expression field queries by @roman-right in #1278
• Do not ignore deprecation warnings in tests by @Viicos in #1123
• add support with_children on delete_all by @CAPITAINMARVEL in #1310
• release: 2.1.0 by @roman-right in #1305
• fix: switch publish workflows to OIDC trusted publisher by @roman-right in #1311

New Contributors

• @smahn9123 made their first contribution in #1248
• @NoahStapp made their first contribution in #1255
• @veeceey made their first contribution in #1269
• @gugu-py made their first contribution in #1241
• @vvuk made their first contribution in #1276
• @alexdlukens made their first contribution in #1207
• @volfpeter made their first contribution in #1252

Full Changelog: 2.0.1...2.1.0

Note

This release specifies and limits the last major supported version of Python to 3.13.
No version of Beanie is yet compatible with Python 3.14 and above.

What's Changed

• handle aggregation method on the whole collection by @CAPITAINMARVEL in #1203
• fix: preserve fetch_links across chained find() and find_one() by @scarlet2131 in #1184
• Fix return types of min and max methods by @kewldan in #1204
• fix: Pydantic "exclude" option is not working #756 by @CatBraaain in #1154
• bump lazy-model by @CAPITAINMARVEL in #1218
• fix: incomplete type hint for Regex pattern by @xcrong in #1209
• fix: exclude pymongo 4.15.0 due to a known issue by @staticxterm in #1225
• Fix PydanticDeprecatedSince211: Accessing the 'model_fields' attribute on the instance is deprecated by @gsakkis in #1150

New Contributors

• @kewldan made their first contribution in #1204
• @CatBraaain made their first contribution in #1154
• @xcrong made their first contribution in #1209

Full Changelog: 2.0.0...2.0.1

Breaking

This release moves away from Motor in favor of the PyMongo Async API.
As a consequence of this, some Beanie internal fields and method names have been renamed to remove references to Motor.
If you have used the Motor API in your project, please check the official Motor to PyMongo Async migration guide to see what has changed and how to update your code.
Lastly, please check the updated Beanie documentation as well.

Beanie API changes

Document

Document.get_motor_collection() → Document.get_pymongo_collection()
Document.get_settings().motor_db → Document.get_settings().pymongo_db
Document.get_settings().motor_collection → Document.get_settings().pymongo_collection

Union Document

UnionDocument.get_motor_collection() → UnionDocument.get_pymongo_collection()
UnionDocument.get_settings().motor_db → UnionDocument.get_settings().pymongo_db
UnionDocument.get_settings().motor_collection → UnionDocument.get_settings().pymongo_collection

Views

View.aggregate(...).motor_cursor → View.aggregate(...).get_cursor()
View.get_settings().motor_db → View.get_settings().pymongo_db
View.get_settings().motor_collection → View.get_settings().pymongo_collection

Queries

DocumentModel.aggregate(...).motor_cursor → DocumentModel.aggregate(...).get_cursor()
DocumentModel.find(...).aggregate(...).motor_cursor → DocumentModel.find(...).aggregate(...).get_cursor()

Fields

IndexModelField.from_motor_index_information() → IndexModelField.from_pymongo_index_information()

Initializer

multiprocessing_mode attribute was removed from the Initializer class and as a parameter to init_beanie().

What's Changed

• Fix typos in migrations docs by @Rishat-F in #1136
• Motor -> Async PyMongo by @roman-right in #1113
• Transform AsyncDocMethod[DocType, P, R] into Any to fix "Incorrect call arguments" warning in PyCharm by @hRtWzFe in #1166

New Contributors

• @Rishat-F made their first contribution in #1136
• @hRtWzFe made their first contribution in #1166

Full Changelog: 1.30.0...2.0.0

Breaking

This release drops support for Python 3.8.

What's Changed

• fix BulkWriter.__init__ bug when it has object_class param input by @hagd0520 in #1107
• fix find type hint for filter args by @CAPITAINMARVEL in #1139
• Drop py3.8 support by @roman-right in #1159
• Fix failing tests in CI by @staticxterm in #1141
• Switch to precommit ci by @07pepa in #1160
• Change schema generation for PydanticObjectId by @dantetemplar in #1099
• Docs: Update Incorrect Event-Based Actions Docs by @kaperont in #1163
• docs: update BackLink usage of original_field for Pydantic v2 by @scarlet2131 in #1183
• fix: first_or_none no longer mutates FindMany object (#1116) by @egorzh01 in #1178
• Migration finder skips modules starting with underscore by @unexceptable in #1177
• Fixed AttributeError in merge_model when updating Document by @mattewid in #1126
• Update toml dependency to use tomli instead of toml by @Taaku18 in #1144
• fix: deprecate bucket_rounding_second in favor of bucket_rounding_seconds in TimeSeriesConfig by @m00rex in #1162
• Add deduplication of entries to Changelog script by @staticxterm in #1081

New Contributors

• @hagd0520 made their first contribution in #1107
• @kaperont made their first contribution in #1163
• @scarlet2131 made their first contribution in #1183
• @egorzh01 made their first contribution in #1178
• @unexceptable made their first contribution in #1177
• @mattewid made their first contribution in #1126
• @Taaku18 made their first contribution in #1144
• @m00rex made their first contribution in #1162

Full Changelog: 1.29.0...1.30.0

Note

This release fixes a regression introduced in Version 1.28.0 that caused errors with the generated JSON Schema. Shout-out to @staticxterm for helping us resolve the issue.

What's Changed

• fix: Owner model missing in init_beanie in Inheritance documentation's Inserts example by @ksayer in #1090
• Add coverage configuration to pyproject.toml by @staticxterm in #1091
• Make diacritic_sensitive parameter optional to support $text operator on Cosmos DB by @mykolaskrynnyk in #1089
• Fix serialization of Link/BackLink and OpenAPI schema generation by @staticxterm in #1080
• Bulk Writer improving & bulk_writer method for document and possibility to bypass mongo document validation + comment parameter by @CAPITAINMARVEL in #1079
• Use strings to specify MongoDB versions in CI by @Viicos in #1094
• Add tests with case of {id} in fastapi path by @dantetemplar in #1100

New Contributors

• @ksayer made their first contribution in #1090
• @staticxterm made their first contribution in #1091
• @mykolaskrynnyk made their first contribution in #1089
• @Viicos made their first contribution in #1094
• @dantetemplar made their first contribution in #1100

Full Changelog: 1.28.0...1.29.0

Breaking

Drops support for Python 3.7

What's Changed

• Handle limit and session in .count() method by @CAPITAINMARVEL in #1040
• Add DocumentDB compatibility to fetch_links by @whitfin in #1042
• Drop support for Python 3.7 by @07pepa in #1044
• update pre-commit by @07pepa in #1046
• fix issues caused by #1044 by @07pepa in #1053
• modify tests to not raise deprecation warnings by @07pepa in #1047
• Fix kwargs/args untyped by @CAPITAINMARVEL in #1049
• Fix PydanticObjectId fields being parsed into str by @07pepa in #1060
• add python 3.13 and JIT into testing by @07pepa in #1051
• Add missing type hint to find_many_in_all method by @vasuman in #1068
• feat(skip_index): possibility added to skip index actions by @jorma16 in #942

New Contributors

• @whitfin made their first contribution in #1042
• @vasuman made their first contribution in #1068
• @jorma16 made their first contribution in #942

Full Changelog: 1.27.0...1.28.0

This is Beanie's first-ever community release! A big thanks to @roman-right and all the other contributors who made this possible!

What's Changed

Add tests on all major mongo version

• Author - 07pepa
• PR #1034

Fix return type from document update

• Author - CAPITAINMARVEL
• PR #1030

Fix expression type hint not allowing some type #1020

• Author - CAPITAINMARVEL
• PR #1023

Fix type hint using pymongo client session instead of motor client session

• Author - CAPITAINMARVEL
• PR #1022

Fix logical operator typing #1000

• Author - janas-adam
• PR #1021

Use session in document insert

• Author - andraghetti
• PR #1018

Use sequence instead of list in init_beanie

• Author - 07pepa
• PR #1015

Replace deprecated datetime.utcnow with datetime.now

• Author - adeelsohailahmed
• PR #1014

Fix uniondoc type hint missing in init_beanie and on findinterface

• Author - CAPITAINMARVEL
• PR #1007

Add test to ensure dict with enum keys are encoded properly

• Author - adeelsohailahmed
• PR #1001

Project publishing instruction + changelog generation script

• Author - roman-right
• PR #998

Revert project publishing gh action

• Author - roman-right
• PR #996

Extend motor option to beanie

• Author - Dudesons
• PR #995

Fix regex storing

• Author - 07pepa
• PR #989

Remove links to ko-fi from the project

• Author - roman-right
• PR #986

Fix typo in source code comment in inheritance.md

• Author - fnogatz
• PR #984

Fix gh action to grant permissions and use tags

• Author - roman-right
• PR #972

Fix: example of find by id and link to finding-documents

• Author - fredowashere
• PR #970

Fix incorrect type serialization when dumping to python

• Author - 07pepa
• PR #968

Use ruff format instead of black

• Author - roman-right
• PR #962

Gh action: set new version and publish on push

• Author - roman-right
• PR #961

Feature / fix: allow settings to be inherited and extended (fixes #644)

• Author - dotKokott
• PR #960

Fix: issue #951

• Author - IterableTrucks
• PR #952

Allow unordered parameter on bulkwriter

• Author - thiagosalvatore
• PR #948

Fix: set default value in findinterface._inheritance_inited to avoid …

• Author - Robert-Nogueira
• PR #935

Fix example in multi-model.md

• Author - gianpaj
• PR #932

Add missing type signature to basefindcomparisonoperator constructor

• Author - aaronted009
• PR #925

Removed calls to function causing deprecation warning where possible

• Author - 07pepa
• PR #917

Update migrations.md

• Author - marwan-alloreview
• PR #915

New Contributors

• @aaronted009 made their first contribution in #925
• @gianpaj made their first contribution in #932
• @robert-nogueira made their first contribution in #935
• @thiagosalvatore made their first contribution in #948
• @07pepa made their first contribution in #968
• @fnogatz made their first contribution in #984
• @dotKokott made their first contribution in #960
• @fredowashere made their first contribution in #970
• @marwan-alloreview made their first contribution in #915
• @CAPITAINMARVEL made their first contribution in #1007
• @janas-adam made their first contribution in #1021
• @andraghetti made their first contribution in #1018
• @Dudesons made their first contribution in #995
• @adeelsohailahmed made their first contribution in #1014

Full Changelog: 1.26.0...1.27.0

Feature: soft delete

• Author - Ali Moradi
• PR #901

Update deprecated call of general_plain_validator_function (#676)

• Author - dslemusp
• PR #897

Annotate decorators that wrap document methods (#679)

• Author - Maxim
• PR #886

Update relations docs to indicate that backlinks are virtual.

• Author - Josh Borrow
• PR #904

Docs: fix typo (#869)

• Author - Valentin Oliver Loftsson
• PR #899

Add possibility of leveraging enum in find query

• Author - Danil
• PR #868

Handle typeerror in validator of pydanticobjectid

• Author - Christian Grotheer
• PR #861

Encode Date Objects

• Author - George Sakkis
• PR #816

Fix: Findinterface Type-Hints Break On View Models

• Author - Guy Tsitsiashvili
• PR #819

Fix: Count With Text Queries And Links

• Author - Benjamin Earle
• PR #826

Update Migration Command To Enable/Disable Transactions

• Author - Mahmoud Mabrouk
• PR #828

Sync Method

• Author - Roman Right
• PR #831

Limit Nesting Level Of Linked Documents

WARNING: This is a breaking change. Please, read the docs before updating.

• Author - Roman Right
• PR #834

Exclude revision_id From The get_changes Method

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/759

Add Support For Custom Bucket Fields In Time Series

• Author - Lucas Hardt
• PR https://github.com/roman-right/beanie/pull/760

Add Bson Maxkey And Minkey

• Author - Noah Witt
• PR https://github.com/roman-right/beanie/pull/768

Update Model During Save Validation

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/776

Fix init_beanie document_models Type Hint

• Author - Capi Etheriel
• PR https://github.com/roman-right/beanie/pull/784

Fix Encoding Keys In Mapping Branch Of Encoder

• Author - Rubikoid
• PR https://github.com/roman-right/beanie/pull/785

Improve Write Performances

• Author - Thibault Djaballah
• PR https://github.com/roman-right/beanie/pull/786

Doc Update: Queue

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/794

Tests For Indexed Fields

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/795

Rework Revision

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/797

Add Missing Type Signature To Document Constructor

• Author - None
• PR https://github.com/roman-right/beanie/pull/813

Fix Multiprocessing Mode

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/782

Multiprocessing Mode For Init

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/781

Args For get_model_dump

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/780

Fix Id Notation

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/772

Fix Aggregations With Text Queries

• Author - Benjamin Earle
• PR https://github.com/roman-right/beanie/pull/752

Handle Annotated Indexes

• Author - Benjamin Earle
• PR https://github.com/roman-right/beanie/pull/762

Fix Docstring

• Author - Andrew Grinevich
• PR https://github.com/roman-right/beanie/pull/766

Build Aggregation Pipeline From Find Query Without Fetch

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/770

Fix: Issue #631

• Author - IterableTrucks
• PR https://github.com/roman-right/beanie/pull/734

Replace Custom 'Hidden=True' Field Attribute With Builtin 'Exclude=True'

• Author - George Sakkis
• PR https://github.com/roman-right/beanie/pull/741

Add Support For Indexed Custom Pydantic Fields

• Author - Adam Asay
• PR https://github.com/roman-right/beanie/pull/754

Refactor Encoder

• Author - George Sakkis
• PR https://github.com/roman-right/beanie/pull/584

Preserve Sort/Skip/Limit For Aggregations

• Author - George Sakkis
• PR https://github.com/roman-right/beanie/pull/711

Update Pre-Commit Hooks

• Author - SADIK KUZU
• PR https://github.com/roman-right/beanie/pull/712

Fixed Link Validation

• Author - Evgeniy Goncharuck
• PR https://github.com/roman-right/beanie/pull/714

Fix: pydantic_core._pydantic_core.Url object is not iterable

• Author - Tomohiro Hiratsuka
• PR https://github.com/roman-right/beanie/pull/730

Simplify And Fix DecimalAnnotation

• Author - George Sakkis

• PR https://github.com/roman-right/beanie/pull/738

• Issues:

  • [BUG] Validation Error on parsing retrieved document's BSON Decimal128 field

Simplify BsonBinary

• Author - George Sakkis
• PR https://github.com/roman-right/beanie/pull/739

Minor Fixes

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/745

Replace Encoder With get_dict In The replace_one Method

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/747

Update Precommit Hooks & CI

• Author - George Sakkis
• PR https://github.com/roman-right/beanie/pull/673

Fix: Unify Methods for Retrieving Field's Extra Parameters During Backlink Processing

• Author - Roman Right
• PR https://github.com/roman-right/beanie/pull/703
• Issues:
  • [BUG] Optional[Backlink]

Fix Numpy Array Incompatability

• Author - Alex Lau
• PR https://github.com/roman-right/beanie/pull/658

Refactor: Simplify UpdateMany And UpdateOne await Method

• Author - Muzaffer Cikay
• PR https://github.com/roman-right/beanie/pull/687

Fix get_field_type & Generalize extract_id_class

• Author - George Sakkis
• PR https://github.com/roman-right/beanie/pull/657

Fix | List_Collection_Names Requires Unnecessary Privileges

• Author - Marina
• PR https://github.com/roman-right/beanie/pull/681
• Issues:
  • [BUG] Can't use a View if the user doesn't have full read privileges to all collections

Fix | August 2023

Fixed Issues:

• [BUG] Issue with List[Link[Type]] when fetch_all_links is called
• Loosen type requirement for insert_many()?
• [BUG] Updating documents with a frozen BaseModel as field raises TypeError
• [BUG] Not operator cant be on top level
• [BUG] Text query doesn't work with fetch_links=True
• [BUG] List type fields in updated model record do not get update.
• [BUG] Undefined behavior when chaining update methods
• [BUG] Revision Id is in Responsemodel
• [BUG] Custom types like bson.Binary require __get_pydantic_core_schema__
• [BUG] validate_on_save doesn't work with Document.save()
• [BUG] Beanie persists root field
• Beanie 1.21 still triggers many deprecation warnings with Pydantic v2
• [BUG] TypeError: expected 1 argument, got 0 when beanie.Document has method wrapped in pydantic.validate_call

Pydantic bump | final

• Author - Roman Right

• PR https://github.com/roman-right/beanie/pull/636

Bump pydantic | beta 1

• Author - Roman Right

• PR https://github.com/roman-right/beanie/pull/624

Bump pydantic | beta 0

• Author - Roman Right

• PR https://github.com/roman-right/beanie/pull/620

Batteries. The first battery is the queue system. Doc: https://beanie-odm.dev/batteries/queue/

Feature: custom init classmethod

• Author - Roman Right

• PR https://github.com/roman-right/beanie/pull/590

Feature: optional batteries

• Author - Roman Right

• PR https://github.com/roman-right/beanie/pull/575

• Fix | 496 | Support aggregation chaining after find with fetch_links=True.
• Fix | 528 | Rework IndexModelField for document settings.
• Fix | 537 | Fetch lists of not only links.
• Fix | 563 | Update logical operators documentation.
• Fix | 508 | Unset unnecessary fields.
• Fix | 531 | Return self for all modifying methods.

Fix: update forward refs during nested links check Fix: session in transactions

• Back Refs
• Box operator
• Some bug fixes and general improvements

Features:

• Configure storing nulls in the database or not

Fix:

• Revision id for update operations

Prevent the models returned from find_all to be modified in the middle of modifying

• Author - Harris Tsim

• PR https://github.com/roman-right/beanie/pull/502

Allow change class_id and use name settings in uniondoc

• Author - 설원준(Wonjoon Seol)/Dispatch squad

• PR https://github.com/roman-right/beanie/pull/466

Fix: make revision_id not show in schema

• Author - Ivan GJ

• PR https://github.com/roman-right/beanie/pull/478

Fix: added re.pattern support to common encoder suite

• Author - Ilia

• PR https://github.com/roman-right/beanie/pull/511

Fix other issues

• Author - Roman Right

• PR https://github.com/roman-right/beanie/pull/518

Fix

• Don't create state on init for docs with custom id types

Implementation

• Author - Roman Right

• PR https://github.com/roman-right/beanie/pull/486

Feature

• feat: convert updates to be atomic operations

Implementation

• Author - Roman Right

• PR https://github.com/roman-right/beanie/pull/481

Feature

• Add links to views

Implementation

• Author - Sebastian Battle

• PR https://github.com/roman-right/beanie/pull/472

Fix

• Already inserted Links will throw DuplicateKeyError on insert of wrapping doc

Implementation

• Author - noaHson86

• PR https://github.com/roman-right/beanie/pull/469

Fix

• sort many args

Implementation

• PR https://github.com/roman-right/beanie/pull/468

Feature

• Previous saved state

Implementation

• Author - Paul Renvoisé

• PR https://github.com/roman-right/beanie/pull/305

Deprecation

• Raises exception if Collection inner class was used as it is not supported more

Backported to

• 1.15.5

• 1.14.1

Implementation

• PR https://github.com/roman-right/beanie/pull/460

Fix

• [BUG] Initiating self-referencing documents with nested links breaks due to uncaught request loop

• Nested lookups for direct links

Implementation

• PR https://github.com/roman-right/beanie/pull/455

Fix

• [BUG] revision_id field saved in MongoDB using save()/replace() on an existing document even if use_revision is False

Implementation

• PR https://github.com/roman-right/beanie/pull/452

Fix

• [BUG] find_one projection link

• [BUG]: Link fields interference/contamination

• [BUG]: ElemMatch on Document property of Type List[Link] fails with IndexError in relations.py convert_ids()

Implementation

• PR https://github.com/roman-right/beanie/pull/448

Feature

• Remove yarl dependency

Implementation

• PR https://github.com/roman-right/beanie/pull/448

Feature

• Support for fetching deep-nested Links

Implementation

• Author - Courtney Sanders

• PR https://github.com/roman-right/beanie/pull/419

Feature

• Lazy parsing for find many

Implementation

• PR https://github.com/roman-right/beanie/pull/436

Fix

• Wrong inheritance behavior with non-rooted documents

Implementation

• ISSUE https://github.com/roman-right/beanie/issues/422

Fix

• Deepcopy dict before encode it to save the original

Implementation

• ISSUE https://github.com/roman-right/beanie/issues/412

Fix

• Use Settings inner class in migrations internals

• Fix inheritance: mark root docs with _inheritance_inited = True

Implementation

• PR https://github.com/roman-right/beanie/pull/409

Fix

• Pass pymongo kwargs to the bulk writer

Implementation

• PR https://github.com/roman-right/beanie/pull/406

Feature

• The sync version was moved to a separate project

Breaking change

• There is no sync version here more. Please use Bunnet instead

Implementation

• PR https://github.com/roman-right/beanie/pull/395

Feature

• Multi-model behavior for inherited documents

Breaking change

• The inner class Collection is not supported more. Please, use Settings instead.

Implementation

• Author - Vitaliy Ivanov

• PR https://github.com/roman-right/beanie/pull/395