DOCSP-41170 - Clarify string ID generation #365

mongoKart · 2024-12-09T17:11:35Z

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-41170

Staging Links

fundamentals/serialization/poco

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?

netlify · 2024-12-09T17:11:51Z

✅ Deploy Preview for mongodb-docs-csharp ready!

Name	Link
🔨 Latest commit	`f78e6df`
🔍 Latest deploy log	https://app.netlify.com/sites/mongodb-docs-csharp/deploys/67645b17ab12e20008748996
😎 Deploy Preview	https://deploy-preview-365--mongodb-docs-csharp.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

jordan-smith721

LGTM w/ two small things

jordan-smith721 · 2024-12-10T18:09:22Z

source/fundamentals/serialization/poco.txt


 .. list-table::
   :header-rows: 1
-   :widths: 10 10
+   :widths: 25 75

   * - ``Id`` Field Data Type


I can't immediately see why, but this is rendering without a space after "Id". Maybe because of the monospace?

i couldn't get this to look right so i just removed the monospace. seems like that actually matches the style guide too

jordan-smith721 · 2024-12-10T18:19:54Z

source/fundamentals/serialization/poco.txt

+
+   * - ``ObjectId``
+     - The driver automatically uses the ``ObjectIdGenerator`` type for ``Id`` fields with
+       the ``ObjectId`` data type, like the one in the following code example:


https://www.mongodb.com/docs/meta/style-guide/terminology/alphabetical-terms/#std-term-like

Suggested change

the ``ObjectId`` data type, like the one in the following code example:

the ``ObjectId`` data type, such as the one in the following code example:

boo this busted rule

rishitb-mongodb · 2024-12-10T21:52:34Z

Could/Should we mention the example mentioned in the ticket as well that would allow users to define the generator in the attribute itself [BsonId(IdGenerator = typeof(StringObjectIdGenerator))]

mongoKart · 2024-12-11T14:33:05Z

Could/Should we mention the example mentioned in the ticket as well that would allow users to define the generator in the attribute itself [BsonId(IdGenerator = typeof(StringObjectIdGenerator))]

For my understanding: What is the use case for this attribute? Do you need to do this in addition to the [BsonRepresentation] attribute in order to serialize to a string? Or can you use this attribute instead of the other one?

rishitb-mongodb · 2024-12-11T14:40:51Z

I'm actually not sure. Maybe @rstam can help. What's the difference between using [BsonRepresentation(BsonType.ObjectId)] on a string ID field as opposed to the attribute [BsonId(IdGenerator = typeof(StringObjectIdGenerator))]? If they are the same then we can ignore adding the alternative way, if they are different then its worth mentioning both and the difference between them.

rstam

LGTM

rstam · 2024-12-11T18:55:46Z

What's the difference between using [BsonRepresentation(BsonType.ObjectId)] on a string ID field as opposed to the attribute [BsonId(IdGenerator = typeof(StringObjectIdGenerator))]?

They are not the same. Using BsonId with StringObjectIdGenerator without configuring the representation would store the ObjectIds in the database as strings.

BsonRepresentation(BsonType.ObjectId) stores the strings as ObjectIds in the database.

They are used together. Though unless you have changed the default conventions there is a convention that automatically sets the id generator for a string stored as an ObjectId to the StringObjectIdGenerator .

rishitb-mongodb · 2024-12-11T19:00:52Z

Thanks Robert. @mongoKart I think its worth adding in a callout then in case a user wants to store the ID as a string along with representing it as a string in their POCO.

source/fundamentals/serialization/poco.txt

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com>

mongoKart · 2024-12-12T17:41:39Z

@rishitb-mongodb @rstam Could you take another look?

rstam · 2024-12-13T19:27:35Z

source/fundamentals/serialization/poco.txt

+default value. Instead, the driver generates a unique ID value for the property.
+
+When you apply the ``[BsonId]`` attribute to a property, you can pass the ``IdGenerator``
+argument to specify the type of ID value the driver generates for the corresponding


Not "the type of ID value"

The type is already determined by the type of the property.

What are you specifying is which generator to use to generate an Id value when needed.

rstam · 2024-12-13T19:45:03Z

source/fundamentals/serialization/poco.txt

+          } 
+
+   * - ``string``
+     - To serialize the ``Id`` property as a ``string``, apply the


Applying the [BsonId] attribute is NOT what causes this property to be serialized as a string.

All strings are serialized as strings UNLESS the [BsonElement] attribute specifies a different representation.

The ONLY thing this [BsonId] attribute is specifying is which id generator to use (beside identifying this as the ID field of course).

After looking at the code for the Generator classes, I see that I've been conflating the ID generation and serialization steps.

rstam · 2024-12-13T19:49:17Z

source/fundamentals/serialization/poco.txt

+       To serialize the ``Id`` property as an ``ObjectId``, apply the
+       ``[BsonRepresentation(BsonType.ObjectId)]`` attribute to the property, as shown
+         in the following code example. In this case, if the property contains the value
+         ``null``, the driver uses the ``ObjectIdGenerator`` type to generate a unique


Actually it uses the StringObjecIdGenerator.

The ObjectIdGenerator can only be used with properties of type ObjectId.

rstam · 2024-12-13T19:50:52Z

source/fundamentals/serialization/poco.txt

+
+       If you apply both the ``[BsonId(IdGenerator = typeof(StringObjectIdGenerator))]``
+       and ``[BsonRepresentation(BsonType.ObjectId)]`` attributes to the ``Id`` property,
+       the driver generates an ``ObjectId`` value for the field.


Not sure this is worded the best way.

If you apply both you have simply done TWO different things:

Configured the representation of the ID in the database

Configured the id generator to use for missing ID values

mongoKart · 2024-12-17T19:20:23Z

source/fundamentals/serialization/poco.txt

@@ -247,7 +248,7 @@ The following code sample maps the ``Identifier`` property to the
       public string Identifier { get; set; }
   }

-.. warning:: Multiple Id Fields
+.. warning:: Multiple ID Fields


Changed most occurrences of 'Id' to 'ID' since you can use any name for an ID property

But... the C#/.Net naming convention is to use Id.

After talking to @jordan-smith721, keeping as 'ID' to comply with our Style Guide

rstam

I have two minor comments but if you want to push as is LGTM.

rstam · 2024-12-19T16:07:19Z

source/fundamentals/serialization/poco.txt

@@ -247,7 +248,7 @@ The following code sample maps the ``Identifier`` property to the
       public string Identifier { get; set; }
   }

-.. warning:: Multiple Id Fields
+.. warning:: Multiple ID Fields


But... the C#/.Net naming convention is to use Id.

rstam · 2024-12-19T16:11:00Z

source/fundamentals/serialization/poco.txt

+Every document in a MongoDB collection must have a unique ID. When you serialize an object
+to a collection, if its ID property contains the default
+value for its data type (usually ``null``), the {+driver-short+} doesn't serialize the
+default value. Instead, the driver generates a unique ID value and assigns it to the


The C# driver TRIES to generate a unique Id value but can onlly do so in cases where it knows what Id generator to use.

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> (cherry picked from commit 30ff13b)

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> (cherry picked from commit 30ff13b) Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com>

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com>

first dra

8d83799

jordan-smith721 approved these changes Dec 10, 2024

View reviewed changes

mongoKart added 2 commits December 10, 2024 14:00

feedback

d6c1b70

heading fix

26a0a9e

mongoKart requested review from rishitb-mongodb and rstam December 10, 2024 20:06

rstam approved these changes Dec 11, 2024

View reviewed changes

feedback

a3cf509

mongoKart requested a review from jordan-smith721 December 12, 2024 16:50

wording

a012288

jordan-smith721 approved these changes Dec 12, 2024

View reviewed changes

source/fundamentals/serialization/poco.txt Outdated Show resolved Hide resolved

Update source/fundamentals/serialization/poco.txt

d70f20d

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com>

rishitb-mongodb approved these changes Dec 12, 2024

View reviewed changes

mongoKart requested a review from rstam December 13, 2024 17:48

rstam suggested changes Dec 13, 2024

View reviewed changes

mongoKart added 2 commits December 17, 2024 13:18

feedback

3c67736

feedback

e3f2e83

mongoKart commented Dec 17, 2024

View reviewed changes

mongoKart requested review from jordan-smith721 and rstam December 17, 2024 19:20

rstam approved these changes Dec 19, 2024

View reviewed changes

feedback

f78e6df

jordan-smith721 approved these changes Dec 19, 2024

View reviewed changes

github-actions bot pushed a commit that referenced this pull request Dec 19, 2024

DOCSP-41170 - Clarify string ID generation (#365)

c89fd10

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> (cherry picked from commit 30ff13b)

This was referenced Dec 19, 2024

[Backport v2.29] DOCSP-41170 - Clarify string ID generation #385

Merged

[Backport v2.28] DOCSP-41170 - Clarify string ID generation #386

Merged

github-actions bot pushed a commit that referenced this pull request Dec 19, 2024

DOCSP-41170 - Clarify string ID generation (#365)

15306ce

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> (cherry picked from commit 30ff13b)

github-actions bot pushed a commit that referenced this pull request Dec 19, 2024

DOCSP-41170 - Clarify string ID generation (#365)

7e102cd

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> (cherry picked from commit 30ff13b)

This was referenced Dec 19, 2024

[Backport v2.27] DOCSP-41170 - Clarify string ID generation #387

Merged

[Backport v2.26] DOCSP-41170 - Clarify string ID generation #388

Merged

github-actions bot pushed a commit that referenced this pull request Dec 19, 2024

DOCSP-41170 - Clarify string ID generation (#365)

5f80ab0

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> (cherry picked from commit 30ff13b)

github-actions bot pushed a commit that referenced this pull request Dec 19, 2024

DOCSP-41170 - Clarify string ID generation (#365)

cd4ec58

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> (cherry picked from commit 30ff13b)

This was referenced Dec 19, 2024

[Backport v2.25] DOCSP-41170 - Clarify string ID generation #389

Merged

[Backport v2.24] DOCSP-41170 - Clarify string ID generation #390

Merged

github-actions bot pushed a commit that referenced this pull request Dec 19, 2024

DOCSP-41170 - Clarify string ID generation (#365)

cdb27e9

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> (cherry picked from commit 30ff13b)

github-actions bot mentioned this pull request Dec 19, 2024

[Backport v2.23] DOCSP-41170 - Clarify string ID generation #391

Merged

github-actions bot pushed a commit that referenced this pull request Dec 19, 2024

DOCSP-41170 - Clarify string ID generation (#365)

942df4a

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> (cherry picked from commit 30ff13b)

github-actions bot mentioned this pull request Dec 19, 2024

[Backport v2.22] DOCSP-41170 - Clarify string ID generation #392

Merged

github-actions bot pushed a commit that referenced this pull request Dec 19, 2024

DOCSP-41170 - Clarify string ID generation (#365)

c7dcf64

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> (cherry picked from commit 30ff13b)

github-actions bot mentioned this pull request Dec 19, 2024

[Backport v3.1] DOCSP-41170 - Clarify string ID generation #393

Merged

mongoKart added a commit to mongoKart/docs-csharp that referenced this pull request May 16, 2025

DOCSP-41170 - Clarify string ID generation (mongodb#365)

179f8da

Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com>

	the ``ObjectId`` data type, like the one in the following code example:
	the ``ObjectId`` data type, such as the one in the following code example:

DOCSP-41170 - Clarify string ID generation #365

DOCSP-41170 - Clarify string ID generation #365

Uh oh!

Conversation

mongoKart commented Dec 9, 2024 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Staging Links

Self-Review Checklist

Uh oh!

netlify bot commented Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for mongodb-docs-csharp ready!

Uh oh!

jordan-smith721 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rishitb-mongodb commented Dec 10, 2024

Uh oh!

mongoKart commented Dec 11, 2024

Uh oh!

rishitb-mongodb commented Dec 11, 2024

Uh oh!

rstam left a comment

Choose a reason for hiding this comment

Uh oh!

rstam commented Dec 11, 2024

Uh oh!

rishitb-mongodb commented Dec 11, 2024

Uh oh!

Uh oh!

mongoKart commented Dec 12, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rstam left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mongoKart commented Dec 9, 2024 •

edited by github-actions bot

Loading

netlify bot commented Dec 9, 2024 •

edited

Loading