GridFS

GridFS バケットの作成

GridFS からファイルを保存または検索するには、バケットを作成するか、MongoDB database 上の既存のバケットへの参照を取得します。 GridFSBucketインスタンスを作成するには、次のコードに示すように、 DatabaseインスタンスでGridFSBucket()メソッドを呼び出します。

db := client.Database("myDB")
bucket := db.GridFSBucket()

デフォルトでは、ドライバーはバケットの名前をfsに設定します。 カスタム名のバケットを作成するには、次のコードに示すように、 BucketOptionsインスタンスでSetName()メソッドを呼び出します。

db := client.Database("myDB")
bucketOpts := options.GridFSBucket().SetName("myCustomBucket")
bucket := db.GridFSBucket(bucketOpts)

ファイルのアップロード

次のいずれかの方法を使用して、ファイルを GridFS バケットにアップロードできます。

• UploadFromStream()は、入力ストリームから読み取ります

• OpenUploadStream()は、出力ストリームに書込みます

どちらのアップロード プロセスでも、UploadOptionsインスタンスを作成することで構成情報を指定できます。オプションの完全なリストを表示するには、loadOptions APIドキュメント を参照してください。

file, err := os.Open("home/documents/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)

New file uploaded with ID ...

file, err := os.Open("home/documents/file.txt")
if err != nil {
	panic(err)
}
// Defines options that specify configuration information for files
// uploaded to the bucket
uploadOpts := options.GridFSUpload().SetChunkSizeBytes(200000)
// Writes a file to an output stream
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)
//  Calls the Close() method to write file metadata
if err := uploadStream.Close(); err != nil {
	panic(err)
}

ファイル情報の検索

GridFS バケットのfilesコレクションに保存されているファイル メタデータを検索できます。 filesコレクション内の各ドキュメントには、次の情報が含まれています。

• ファイル ID

• ファイルの長さ

• 最大チャンク サイズ

• アップロード日時

• ファイル名

• metadata その他の情報を保存するドキュメント

ファイルデータを検索するには、 GridFSBucketインスタンスでFind()メソッドを呼び出します。 特定のファイル ドキュメントのみを一致させるには、クエリフィルターを引数としてFind()に渡すことができます。

次の例では、 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 := bson.ObjectIDFromHex("62f7bd54a6e4452da13b3e88")
fileBuffer := bytes.NewBuffer(nil)
if _, err := bucket.DownloadToStream(id, fileBuffer); err != nil {
   panic(err)
}

id, err := bson.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)
}

ファイル名の変更

バケット内の GridFS ファイルの名前を更新するには、 Rename()メソッドを使用します。 ファイル ID 値と新しいfilename値を引数としてRename()に渡します。

次の例では、ファイルの名前を"mongodbTutorial.zip"に変更します。

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

ファイルの削除

GridFS バケットからファイルを削除するには、 Delete()メソッドを使用します。 ファイル ID の値を引数としてDelete()に渡します。

次の例では、 ファイルを削除しています。

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

GridFS バケットの削除

GridFS バケットは、 Drop()メソッドを使用して削除できます。

次のコード例では、GridFS バケットを削除します。

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

API ドキュメント

このガイドで言及されているメソッドとタイプの詳細については、次のAPIドキュメントを参照してください。

• GridFSbucket()

• OpenUploadStream()

• AppUploadFromStream()

• Find()

• OpenDownloadStream()

• ダウンロードToStream()

• Rename()

• Delete()

• Drop()