Database Manual / Reference / mongosh Methods / Object Constructors

Binary.createFromBase64() (mongosh method方法)

Definition定义

Creates a binary object from a base64 value.从base64值创建二进制对象。

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部署的完全托管服务
  • MongoDB Enterprise: The subscription-based, self-managed version of MongoDB:MongoDB的基于订阅的自我管理版本
  • MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB:MongoDB的源代码可用、免费使用和自我管理版本

Syntax语法

Binary.createFromBase64( <base64String> [ , <subType> ] )

Method Fields方法字段

The method accepts the following fields:该方法接受以下字段:

Field字段Type类型Description描述
base64StringString字符串Specifies a string that contains a base64 value. For example, "SGVsbG8gV29ybGQhCg==".指定一个包含base64值的字符串。例如,"SGVsbG8gV29ybGQhCg=="
subTypeInteger整数

Optional. 可选。Specifies a binary subtype.指定二进制子类型。

ValueDescription描述
0Generic binary subtype通用二进制子类型
1Function函数
2Byte array (deprecated)字节数组(已弃用)
3Old UUID (deprecated)旧UUID(已弃用)
4UUID
5MD5
128 through 255User defined

Examples示例

The following examples show how to add a binary object to a document using Binary.createFromBase64() and how the binary object appears in the output when retrieved.以下示例显示了如何使用Binary.createFromBase64()将二进制对象添加到文档中,以及检索时二进制对象如何显示在输出中。

Create Collection Containing Document with Binary Object使用二进制对象创建包含文档的集合

The following example creates a collection named binaryObjectsFromBase64:以下示例创建了一个名为binaryObjectsFromBase64的集合:

db.binaryObjectsFromBase64.insertOne( {
_id: 0,
binaryObject: Binary.createFromBase64( "SGVsbG8gV29ybGQhCg==" )
} )

The binaryObject field contains the binary object created from the string specified in Binary.createFromBase64().binaryObject字段包含根据Binary.createFromBase64()中指定的字符串创建的二进制对象。

Retrieve Document from Collection with Binary Object使用二进制对象从集合中检索文档

The following example retrieves the document:以下示例检索文档:

db.binaryObjectsFromBase64.findOne( { _id: 0 } )

Note

Starting in mongosh 2.0.0, binary objects are shown as Binary.createFromBase64( <base64String> ) values instead of Binary( Buffer.from( <base64String> ) ) values. mongosh 2.0.0开始,二进制对象显示为Binary.createFromBase64( <base64String> )值,而不是Binary( Buffer.from( <base64String> ) )值。This only changes the display of binary values.这只会更改二进制值的显示。

Example output, starting in mongosh 2.0.0:示例输出,从mongosh 2.0.0开始:

{
_id: 0,
binaryObject: Binary.createFromBase64("SGVsbG8gV29ybGQhCg==")
}