Skip to content

DOCSP-46065: GUID serialization breaking change note #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 27, 2025
Merged

DOCSP-46065: GUID serialization breaking change note #439

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4081f8e
DOCSP-46065: GUID serialization breaking change note
mcmorisi Jan 24, 2025
94ba8f4
RR feedback
mcmorisi Jan 24, 2025
ffd3c3f
Technical feedback
mcmorisi Jan 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions source/upgrade/v3.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,3 +248,7 @@ Version 3.0 Breaking Changes
- The driver seals the ``MongoClient``, ``MongoDatabase``, and ``MongoCollection`` classes.
We recommend using the ``IMongoClient``, ``IMongoDatabase``, and ``IMongoCollection``
interfaces directly.

- The driver requires applications to explicitly configure how to serialize GUIDs
by using the ``GuidSerializationProvider`` and ``ObjectSerializer`` classes. To learn
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think GuidSerializationProvider is a typo, there is no such class.

You probably meant GuidSerializer.

It might also be worth mentioning that you need to "register" your configured GuidSerializer if you want it to apply globally everywhere in your application. Guid serialization can also be configured on a case by case basis without registering a GuidSerializer.

Registering a global GuidSerializer is only safe for NEW applications. For old applications it might be safe but the application writer is then responsible for verifying that all Guids in their application have in fact been serialized the same way in the past.

more about GUID serialization, see the :ref:`csharp-guids` guide.
Loading