DOCSP-48390 Document Data Formats: EJSON by lindseymoore · Pull Request #1069 · mongodb/docs-node

lindseymoore · 2025-04-04T03:29:41Z

Pull Request Info

PR Reviewing Guidelines

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

Staging Links

https://deploy-preview-1069--docs-node.netlify.app/data-formats/extended-json/

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?
Are the page titles greater than 20 characters long and SEO relevant?

netlify · 2025-04-04T03:30:14Z

✅ Deploy Preview for docs-node ready!

Name	Link
🔨 Latest commit	`2ba171c`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-node/deploys/67fd67b36d0b48000881655e
😎 Deploy Preview	https://deploy-preview-1069--docs-node.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.

stephmarie17

LGTM with a question!

stephmarie17 · 2025-04-04T22:45:48Z

+and meet specific use cases. The **Extended** format, also known as the
+**Canonical** format, features specific representations for every BSON type
+for bidirectional conversion without loss of information. The **Relaxed Mode**


[q] Do you know if the different format names are meant to be capitalized? I think it makes sense to do so, but I've seen a mix in different docs.

It seems to be capitalized in the Server Docs, so I tried to be consistent: https://www.mongodb.com/docs/manual/reference/mongodb-extended-json/

nbbeeken · 2025-04-07T21:23:24Z

+         {"foo": [1, 2]},
+         {"bar": {"hello": "world"}},
+         {"code": new Code("function x() { return 1; }", {})},
+         {"bin": Binary.createFromBase64("AQIDBA==", 0)}


Same mods as above.

Maybe we should replace the binary example with a Date one? we have the "$numberInt"s showing up here, but the difference between Date relaxed true/false is more significant, it demonstrates how one is readable and the other is intended more for transmission/storage.

Replaced with a Date object. Let me know what you think!

* DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review

* DOCSP-48375 ToC reorg part one (#1035) * DOCSP-48376: Get Started edits (#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (#1046) * DOCSP-48683 Refine Connection Pools page (#1067) * DOCSP-48501 add casual consistency section (#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (#1071) * DOCSP-48389 Connection Troubleshooting Revisions (#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com> Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: shuangela <angela.shu@mongodb.com>

* DOCSP-48375 ToC reorg part one (mongodb#1035) * DOCSP-48376: Get Started edits (mongodb#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (mongodb#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (mongodb#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (mongodb#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (mongodb#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (mongodb#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (mongodb#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (mongodb#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (mongodb#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (mongodb#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (mongodb#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (mongodb#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (mongodb#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (mongodb#1046) * DOCSP-48683 Refine Connection Pools page (mongodb#1067) * DOCSP-48501 add casual consistency section (mongodb#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (mongodb#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (mongodb#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (mongodb#1071) * DOCSP-48389 Connection Troubleshooting Revisions (mongodb#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (mongodb#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (mongodb#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (mongodb#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com> Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: shuangela <angela.shu@mongodb.com> (cherry picked from commit 1e62fc0)

* Node CC merge comp-cov branch (#1096) * DOCSP-48375 ToC reorg part one (#1035) * DOCSP-48376: Get Started edits (#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (#1046) * DOCSP-48683 Refine Connection Pools page (#1067) * DOCSP-48501 add casual consistency section (#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (#1071) * DOCSP-48389 Connection Troubleshooting Revisions (#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com> Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: shuangela <angela.shu@mongodb.com> (cherry picked from commit 1e62fc0) * Backport v6.16 NodeCC * fix redirect --------- Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com> Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: shuangela <angela.shu@mongodb.com>

DOCSP-48390 Document Data Formats: EJSON

691b493

lindseymoore added 8 commits April 3, 2025 23:51

add to toc and bson import note

38c0fce

edit

bd76c83

add binary type

cb976a4

edit ouputs

c126f62

remove additional info section

4b9dfa9

last small edits

9675fa9

fix link

a1666e8

edit

72f0019

stephmarie17 approved these changes Apr 4, 2025

View reviewed changes

nbbeeken requested changes Apr 7, 2025

View reviewed changes

tech review

8c4971e

lindseymoore requested a review from nbbeeken April 9, 2025 21:40

nbbeeken requested changes Apr 10, 2025

View reviewed changes

Comment thread source/data-formats/extended-json.txt Outdated

Comment thread source/data-formats/extended-json.txt Outdated

Comment thread source/data-formats/extended-json.txt

Comment thread source/data-formats/extended-json.txt

lindseymoore added 3 commits April 10, 2025 17:00

edits

86af804

tech review 2

8833125

add note about bad orange highlighting

704e27c

lindseymoore requested a review from nbbeeken April 11, 2025 20:11

nbbeeken requested changes Apr 14, 2025

View reviewed changes

tech review

da4b6f2

lindseymoore requested a review from nbbeeken April 14, 2025 19:01

nbbeeken approved these changes Apr 14, 2025

View reviewed changes

merge conflict plus uuid

2ba171c

lindseymoore force-pushed the DOCSP-48390 branch from e5e1669 to 2ba171c Compare April 14, 2025 19:53

lindseymoore merged commit a4f6790 into mongodb:comp-cov Apr 14, 2025
5 checks passed

Conversation

lindseymoore commented Apr 4, 2025 • edited 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 Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-node ready!

Uh oh!

stephmarie17 left a comment

Choose a reason for hiding this comment

Uh oh!

stephmarie17 Apr 4, 2025

Choose a reason for hiding this comment

Uh oh!

lindseymoore Apr 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nbbeeken Apr 7, 2025

Choose a reason for hiding this comment

Uh oh!

lindseymoore Apr 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lindseymoore commented Apr 4, 2025 •

edited

Loading

netlify Bot commented Apr 4, 2025 •

edited

Loading