Binary.createFromHexString()
On this page
Definition
Creates a binary object from a hexadecimal value.
Compatibility
This method is available in deployments hosted in the following environments:
MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud
MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB
Syntax
The hexadecimalString field specifies a string that contains a
hexadecimal value. For example, "64c13ab08edf48a008793cac".
Examples
The following examples show how to add a binary object to a document
using Binary.createFromHexString() and how the binary object appears
in the output when retrieved.
Create Collection Containing Document with Binary Object
The following example creates a collection named
binaryObjectsFromHexString:
db.binaryObjectsFromHexString.insertOne( { _id: 0, binaryObject: Binary.createFromHexString( "64c13ab08edf48a008793cac" ) } )
The binaryObject field contains the binary object created from the
string specified in Binary.createFromHexString().
Retrieve Document from Collection with Binary Object
The following example retrieves the document:
db.binaryObjectsFromHexString.findOne( { _id: 0 } )
Note
Starting in mongosh 2.0.0, binary values are shown as
Binary.createFromBase64( <base64String> ) values instead of
Binary( Buffer.from( <base64String> ) ) values. This only changes
the display of binary values.
Example output, which shows the number in base64:
{ _id: 0, binaryObject: Binary.createFromBase64("ZME6sI7fSKAIeTys") }