DOCSP-23996 Add enableUtf8Validation Connectionstring Option #576
Conversation
|
@sarah-olson-mongodb Could you take a look at this whenever you get a minute please? |
There was a problem hiding this comment.
Thanks @ianf-mongodb. This is a lot of questions / comments. Sorry about that. Let's for sure talk this over tomorrow!
| can disable UTF8 validation by setting the ``enableUtf8Validation`` | ||
| URI option to ``false``. |
There was a problem hiding this comment.
(question/context)
What are the ramifications of disabling UTF-8 validation. Do we "recommend" that you do this in all/some situations?
There was a problem hiding this comment.
I added a warning callout, that this should be a temporarily method.
| can disable UTF8 validation by setting the ``enableUtf8Validation`` | ||
| URI option to ``false``. |
There was a problem hiding this comment.
I added a warning callout, that this should be a temporarily method.
There was a problem hiding this comment.
Hey @ianf-mongodb, sorry about the long delay and thanks so much for these updates! Here you go! A bunch of minor stuff here and one request for further detail. Happy to chat as needed. Otherwise, let me know when it's ready for another quick look.
| Compass can have issues displaying collections if documents have | ||
| invalid UTF8 characters. | ||
|
|
||
| If you attempt to query or export this data, the following error | ||
| message displays: |
There was a problem hiding this comment.
(minimalism -- suggestion)
What if you combined the first two sentences. Something like:
"If you attempt to query or export data with invalid UTF8 characters ..."
| Invalid UTF-8 string in BSON document. | ||
|
|
||
| In order to query or export this data, you can disable | ||
| UTF8 validation by setting the ``enableUtf8Validation`` URI option to |
There was a problem hiding this comment.
(minimalism)
Nice work getting Vale integrated with the Compass repo.
Adding to the Vale suggestion, consider something like:
"To query or export this data, disable UTF8 ...
| .. warning:: | ||
|
|
||
| **Editing data** with ``enableUtf8Validation=false`` can result in | ||
| potential loss of data. This approach is a temporary workaround to |
There was a problem hiding this comment.
(suggestion)
consider "can result in data loss."
Reasoning is that "can" and "potential" are a bit redundant in this sentence.
Co-authored-by: Sarah Olson <[email protected]>
|
@sarah-olson-mongodb Ready for re-review |
|
@lerouxb This is ready for review |
|
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/compass/master/ 🪵 Logs |
DESCRIPTION
This edit adds mention to the nodejs / Compass URI option
enableUtf8Validationwhich allows Compass to show collections that contain invalid UTF8 data. This additional option needs mention on https://www.mongodb.com/docs/drivers/node/current/fundamentals/connection/connection-options/, it works as both a client parameter and a URI connection string option.Parsing logic: https://github.com/mongodb/js-bson/blob/main/src/parser/deserializer.ts#L678.
STAGING
https://preview-mongodbianfmongodb.gatsbyjs.io/compass/DOCSP-23996/query/filter/#query-collections-with-invalid-utf8-data
JIRA
https://jira.mongodb.org/browse/DOCSP-23996
BUILD LOG
https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=654bfb1f5b686d6bd982a45d
Self-Review Checklist
External Review Requirements
What's expected of an external reviewer?