简单封装了 MongoDB GirdFSBucket 的 API。如果你需要搭配 mongoose 使用，请查看这个仓库 mongoose-gridfs-extra。
本项目是为了避免在原生 API 提供的流对象上执行繁琐且反复的读写操作，节省时间
安装 npm 包
npm install gridfs-extra或者 克隆 Github 仓库
# ssh
git clone [email protected]:peachest/gridfs-extra.git
# http
git clone https://github.com/peachest/gridfs-extra.git本项目提供了完整的可运行的范例代码。请查看 example/example.{cjs,mjs}.
克隆仓库到本地后，请运行：
cd gridfs-extra
node example/example.cjs
node example/example.mjs在项目中导入
// ESModule
import * as gridfs from "gridfs-extra"
import mongodb from "mongodb"
// or CommandJS
const mongodb = require('mongodb')
const gridfs = require("gridfs-extra")连接到本地 Mongodb 服务器
const client = new mongodb.MongoClient("mongodb://localhost:27017");
await client.connect()
// or top-level await is not allowed
client.connect().then(async () => {
// put the following code here
})创建 GridFS bucket
const db = client.db('test')
const bucketName = "testBucket";
const options = {
bucketName
}
// gridfs-extra
const bucket = gridfs.createGridFSBucket(db, options)
// or mongodb native API
const bucket = new mongodb.GridFSBucket(db, options) ;写入文件到 bucket 中
// Read Buffer type file content
const fileName = ""
let file = await fs.readFile("")
// Write file into bucket
const gridFSFile = await gridfs.writeFileByName(bucket, file, fileName)
const id = gridFSFile._id从 bucket 中读取文件
// Read file from bucket
file = await gridfs.readFileById(bucket, id)
// or use fileName
file = await gridfs.readFileByName(bucket, fileName, {
revision: -1 // default value
})If there are multiple files with the same name, this will stream the most recent file with the given name (as determined by the uploadDate field). You can set the revision option to change this behavior.
对于 revision 选项:
The revision number relative to the oldest file with the given filename.
- 0 gets you the oldest file,
- 1 gets you the 2nd oldest,
- -1 gets you the newest.
Apache 2.0