GridFS

创建 GridFS 存储桶

若要从 GridFS 存储或检索文件，请创建存储桶或获取对 MongoDB 数据库上现有存储桶的引用。要创建 GridFSBucket 实例，请使用数据库参数调用 NewBucket() 方法：

db := client.Database("db")
bucket, err := gridfs.NewBucket(db)
if err != nil {
   panic(err)
}

默认情况下，新存储桶名为 fs。要使用自定义名称实例化存储桶，请在 BucketOptions 实例上调用 SetName() 方法，如下所示：

db := client.Database("db")
opts := options.GridFSBucket().SetName("custom name")
bucket, err := gridfs.NewBucket(db, opts)
if err != nil {
   panic(err)
}

上传文件

您可以通过以下方式之一将文件上传到 GridFS 存储桶：

• 使用 UploadFromStream() 方法，从输入流中读取数据。

• 使用 OpenUploadStream() 方法，该方法可以写入到输出流。

对于任一上传进程，您都可以在UploadOptions的实例上指定配置信息。 有关UploadOptions 字段的完整列表，请访问 API 文档。

file, err := os.Open("path/to/file.txt")
uploadOpts := options.GridFSUpload().SetMetadata(bson.D{{"metadata tag", "first"}})
objectID, err := bucket.UploadFromStream("file.txt", io.Reader(file),
   uploadOpts)
if err != nil {
   panic(err)
}
fmt.Printf("New file uploaded with ID %s", objectID)

file, err := os.Open("path/to/file.txt")
if err != nil {
	panic(err)
}
uploadOpts := options.GridFSUpload().SetChunkSizeBytes(200000)
uploadStream, err := bucket.OpenUploadStream("file.txt", uploadOpts)
if err != nil {
	panic(err)
}
fileContent, err := io.ReadAll(file)
if err != nil {
	panic(err)
}
var bytes int
if bytes, err = uploadStream.Write(fileContent); err != nil {
	panic(err)
}
fmt.Printf("New file uploaded with %d bytes written", bytes)

检索文件信息

您可以检索 GridFS 存储桶的 files（文件）集合中存储的文件元数据。files（文件）集合中的每个文档都包含以下信息：

• 文件 ID

• 文件长度

• 最大数据库大小

• 上传日期和时间

• 文件名

• 您可以在其中存储任何其他信息的 metadata 文档

要检索文件数据，请在 GridFSBucket 实例上调用 Find() 方法。您可以将查询过滤器作为参数传递给 Find()，以仅匹配某些文件文档。

以下示例会检索 files 集合中 length值大于 1500 的文档的文件名和长度：

filter := bson.D{{"length", bson.D{{"$gt", 1500}}}}
cursor, err := bucket.Find(filter)
if err != nil {
   panic(err)
}
type gridfsFile struct {
   Name   string `bson:"filename"`
   Length int64  `bson:"length"`
}
var foundFiles []gridfsFile
if err = cursor.All(context.TODO(), &foundFiles); err != nil {
   panic(err)
}
for _, file := range foundFiles {
   fmt.Printf("filename: %s, length: %d\n", file.Name, file.Length)
}

下载文件

您可以通过以下方式之一下载 GridFS 文件：

• 使用 DownloadToStream() 方法将一个文件下载到一个输出流。

• 使用 OpenDownloadStream() 方法打开一个输入流。

id, err := primitive.ObjectIDFromHex("62f7bd54a6e4452da13b3e88")
fileBuffer := bytes.NewBuffer(nil)
if _, err := bucket.DownloadToStream(id, fileBuffer); err != nil {
   panic(err)
}

id, err := primitive.ObjectIDFromHex("62f7bd54a6e4452da13b3e88")
downloadStream, err := bucket.OpenDownloadStream(id)
if err != nil {
   panic(err)
}
fileBytes := make([]byte, 1024)
if _, err := downloadStream.Read(fileBytes); err != nil {
   panic(err)
}

重命名文件

可以使用 Rename() 方法更新存储桶中 GridFS 文件的名称。将文件 ID 值和新的 filename 值作为参数传递给 Rename()。

如下示例将一个文件重命名为 "mongodbTutorial.zip"：

id, err := primitive.ObjectIDFromHex("62f7bd54a6e4452da13b3e88")
if err := bucket.Rename(id, "mongodbTutorial.zip"); err != nil {
    panic(err)
}

删除文件

您可以使用 Delete() 方法从 GridFS 存储桶中删除文件。将文件 ID 值作为参数传入 Delete()。

以下示例删除文件：

id, err := primitive.ObjectIDFromHex("62f7bd54a6e4452da13b3e88")
if err := bucket.Delete(id); err != nil {
   panic(err)
}

删除 GridFS 存储桶

您可以使用 Drop() 方法删除一个 GridFS 存储桶。

以下代码示例会删除 GridFS 存储桶：

if err := bucket.Drop(); err != nil {
   panic(err)
}

API 文档

要进一步了解本指南所讨论的方法或类型，请参阅以下 API 文档：

• NewBucket()

• OpenUploadStream()

• UploadFromStream()

• find()

• OpenDownloadStream()

• DownloadToStream()

• Rename()

• Delete()

• Drop()