Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-11478

Updated Extended JSON docs to address v2

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: manual, Server

      Description

      Scope

      The manual page on Extended JSON needs to be updated to explain the difference between "v1" and "v2" Extended JSON.

      Some drivers already use v2 and tools will be updated to do so when they are converted to the new in-house Go driver. We need to find a way to let users know about the different forms they might be seeing and about the transition.

      I'm open to suggestions for the right way to do that.

      Thanks!

      drivers that use v2

      • C
      • C++
      • Go
      • Java
      • Node
      • Perl
      • PHPC
      • Python
      • Scala

      From DOCSP-5366:

      • mongodump produces collection metadata in canonical extended JSON; mongorestore expects collection metadata in v2 extended JSON, not legacy (we only support restoring from the same version of the tools that were used to dump with, but someone who tries to restore old data may still be surprised)
      • Extended JSON v2 is used instead of the legacy format:
        • bsondump outputs canonical extended JSON
        • mongoexport outputs relaxed extended JSON by default or canonical by request using a new flag, --jsonFormat
        • mongoimport consumes relaxed/canonical unless the new --legacy flag is used
        • The extended JSON docs should also be updated to reflect v2 and not the legacy format

      From DOCS-12939:

      • dump/export/files query should use extJSON v2 and ordered BSON

      Out of Scope

      • the v1 extended json docs probably needs update both in content and presentation, but will not be tackled in this ticket
      • the use of bsontype label on these pages + bson type page + mention of mongo shell helpers – also needs overhaul, but not for this ticket.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              kay.kim Kay Kim (Inactive)
              Reporter:
              david.golden David Golden
              Participants:
              Last commenter:
              Kay Kim Kay Kim (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Days since reply:
                2 years, 11 weeks ago
                Date of 1st Reply: