[DOCS-13515] Document shell BinData type Created: 15/Mar/20  Updated: 30/Oct/23

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Improvement Priority: Minor - P4
Reporter: Oleg Pudeyev (Inactive) Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: docs-bson
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
Participants:
Days since reply: 1 year, 14 weeks, 2 days ago
Epic Link: DOCSP-1769

 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.)



 Comments   
Comment by Education Bot [ 31/Oct/22 ]

Hello! This ticket has been closed due to inactivity. If you believe this ticket is still important, please reopen it and leave a comment to explain why. Thank you!

Generated at Thu Feb 08 08:08:00 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.