Skip to content

Commit 0d9d3b0

Browse files
rustagirnorareidyChris Chosarahemlin
authored
DOCSP-32078: data class note (#132)
* add vale action * DOCSP-31827: Update page titles (#123) # Pull Request Info [PR Reviewing Guidelines](https://github.com/mongodb/docs-java/blob/master/REVIEWING.md) JIRA - https://jira.mongodb.org/browse/DOCSP-31827 Staging - https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/DOCSP-31827-update-titles/fundamentals/crud/write-operations/modify/ https://docs-mongodbcom-staging.corp.mongodb.com/kotlin/docsworker-xlarge/DOCSP-31827-update-titles/fundamentals/crud/write-operations/delete/ Redirects - Redirect 301 /docs/drivers/kotlin/coroutine/v4.10/fundamentals/crud/write-operations/change-a-document/ https://www.mongodb.com/docs/drivers/kotlin/coroutine/v4.10/fundamentals/crud/write-operations/modify/ Redirect 301 /docs/drivers/kotlin/coroutine/master/fundamentals/crud/write-operations/change-a-document/ https://www.mongodb.com/docs/drivers/kotlin/coroutine/master/fundamentals/crud/write-operations/modify/ ## Self-Review Checklist - [x] Is this free of any warnings or errors in the RST? - [ ] Did you run a spell-check? - [ ] Did you run a grammar-check? - [x] Are all the links working? * Fix Vale GH action (#125) * DOCSP-32483 programmatic tagging script for the kotlin driver repo (#126) * DOCSP-30911: Add server lifecycle support callout (#127) * DOCSP-30911: Add server lifecycle support callout * 092123 trivial change to test GH action that copies compat tables (#128) * 092123: Fix copy-compat-to-docs-shared action (#129) * 092223 compatibility copy (#130) * 092223: Remove rapid release version from compat table * DOCSP-32078: bsonrepresentation note * column width adjustment * vale fix --------- Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Chris Cho <chris.cho@mongodb.com> Co-authored-by: Sarah Lin <55722001+sarahemlin@users.noreply.github.com>
1 parent bba61f6 commit 0d9d3b0

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

source/fundamentals/data-formats/document-data-format-data-class.txt

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ You can use the following annotations on data classes:
9999
.. list-table::
100100
:header-rows: 1
101101
:stub-columns: 1
102-
:widths: 10 10
102+
:widths: 30 70
103103

104104
* - Annotation Name
105105
- Description
@@ -112,8 +112,15 @@ You can use the following annotations on data classes:
112112
field to BSON.
113113

114114
* - ``BsonRepresentation``
115-
- Specifies the BSON type used to store the value when different from the
116-
data class property.
115+
- Specifies the BSON type MongoDB uses to store the value. Use this
116+
annotation only when you need to store a value as a different
117+
BSON type than the data class property.
118+
119+
.. warning::
120+
121+
Your code might throw an exception if you include the
122+
``BsonRepresentation`` annotation on a property that you store
123+
as the same type as the data class property.
117124

118125
For reference information on these property annotations,
119126
refer to the `org.bson.codecs.pojo.annotations <{+api+}/apidocs/bson/org/bson/codecs/pojo/annotations/package-summary.html>`__

0 commit comments

Comments
 (0)