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

Document shell BinData type

    XMLWordPrintableJSON

Details

    Description

      Description

      The drivers auth specification (e.g. https://github.com/mongodb/specifications/blob/master/source/auth/auth.rst#sasl-mechanisms) contains several references to BinData. For example, it shows the following use:

      new BinData(0, "dzw1U2IwSEtgaWI0IUxZMVJqc2xuQzNCcUxBc05wZjI=")
      

      I am unable to locate documentation for BinData in the manual. The relevant page appears to be https://docs.mongodb.com/manual/core/shell-types/ but it has no mention of BinData.

      At a minimum I think the following information should be included:

      • Types and description of arguments (first is BSON binary subtype, second is data)
      • That the data is passed in base64 encoding (I presume)
      • How to see the raw bytes given a BinData object in the shell, if this is possible

      Scope of changes

      Impact to Other Docs

      MVP (Work and Date)

      Resources (Scope or Design Docs, Invision, etc.)

      Attachments

        Activity

          People

            Unassigned Unassigned
            oleg.pudeyev@mongodb.com Oleg Pudeyev (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              1 year, 14 weeks, 2 days ago