DOCSP-41865: datetime serializers #173
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-kotlin ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mongoKart
requested changes
Sep 23, 2024
Comment on lines
316
to
319
| ``kotlinx-datetime`` is a {+language+} library that allows | ||
| you to work with dates and times. If you want a high level of control | ||
| over how your date and time values are serialized, you can add the | ||
| dependency to your project's dependency list. |
There was a problem hiding this comment.
S: maybe a little more straightforward
Suggested change
| ``kotlinx-datetime`` is a {+language+} library that allows | |
| you to work with dates and times. If you want a high level of control | |
| over how your date and time values are serialized, you can add the | |
| dependency to your project's dependency list. | |
| ``kotlinx-datetime`` is a {+language+} library that offers | |
| a high level of control over how your date and time values | |
| are serialized. To use the library, add the ``kotlinx-datetime`` | |
| dependency to your project's dependency list. |
source/whats-new.txt
Outdated
|
|
||
| .. sharedinclude:: dbx/jvm/v5.2-wn-items.rst | ||
|
|
||
| .. replacement:: avs-index-link | ||
|
|
||
| :ref:`kotlin-search-indexes` in the Indexes guide | ||
|
|
||
| - Adds support for serializers from the ``kotlinx-datetime`` library | ||
| that let you map to BSON as the expected types instead of as strings. |
There was a problem hiding this comment.
S: specify type(s)
Suggested change
| that let you map to BSON as the expected types instead of as strings. | |
| that let you map ``LocalDate``[?] values to BSON as the expected types instead of as strings. |
source/whats-new.txt
Outdated
| - Adds support for serializers from the ``kotlinx-datetime`` library | ||
| that let you map to BSON as the expected types instead of as strings. | ||
| To learn more, see the :ref:`kotlin-datetime-serialization` section of | ||
| the Kotlin Serialization guide. |
There was a problem hiding this comment.
Could use source constant here
Suggested change
| the Kotlin Serialization guide. | |
| the {+language+} Serialization guide. |
Comment on lines
357
to
359
| The following ``Appointment`` data class has the ``@Serializable`` | ||
| annotation and the ``@Contextual`` annotation on the ``date`` field | ||
| to use the ``kotlinx-datetime`` serializer for ``LocalDate`` values. |
There was a problem hiding this comment.
S: i had a little trouble parsing this all at first. i tried a few versions and ended up with a list, but feel free to use/discard parts as you see fit. it also sort of bleeds into the following example about the time being stored as a string.
Suggested change
| The following ``Appointment`` data class has the ``@Serializable`` | |
| annotation and the ``@Contextual`` annotation on the ``date`` field | |
| to use the ``kotlinx-datetime`` serializer for ``LocalDate`` values. | |
| In the following code example, the driver serializes all fields in | |
| the ``Appointment`` data class in the following ways: | |
| - ``name``: The driver serializes the value as a string. | |
| - ``date``: The driver uses the ``kotlinx-datetime`` serializer because | |
| the field includes the ``@Contextual`` annotation. The value is serialized | |
| as a BSON date. | |
| - ``time``: The driver serializes the value as a string. |
| The following ``Appointment`` data class has the ``@Serializable`` | ||
| annotation and the ``@Contextual`` annotation on the ``date`` field | ||
| to use the ``kotlinx-datetime`` serializer for ``LocalDate`` values. | ||
| Values of the ``time`` field are stored as strings, because the driver |
There was a problem hiding this comment.
Q: Does this code example show that the time field is stored as a string?
There was a problem hiding this comment.
yes, this is the default behavior of the driver. The result is shown later in the section
mongoKart
approved these changes
Sep 23, 2024
Comment on lines
363
to
364
| because the field has the ``@Contextual`` annotation. So, | ||
| ``LocalDate`` values are serialized as BSON dates. |
There was a problem hiding this comment.
S:
Suggested change
| because the field has the ``@Contextual`` annotation. So, | |
| ``LocalDate`` values are serialized as BSON dates. | |
| because the field has the ``@Contextual`` annotation. | |
| ``LocalDate`` values are serialized as BSON dates. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-41865
Staging:
note that the test is failing because of #170
Self-Review Checklist