Almacena archivos grandes mediante GridFS

Overview

En esta guía, puedes aprender cómo almacenar y recuperar archivos grandes en MongoDB utilizando GridFS. GridFS es una especificación que describe cómo dividir archivos en fragmentos al almacenarlos y cómo reconstruir esos archivos al recuperarlos. La implementación de GridFS del driver Ruby es una abstracción que gestiona las operaciones y la organización del almacenamiento de archivos.

Utilice GridFS si el tamaño de sus archivos supera el límite de tamaño de documento BSON de 16MB. Para obtener información más detallada sobre si GridFS es adecuado para su caso de uso, consulte GridFS en el manual del servidor MongoDB.

Las siguientes secciones describen las operaciones de GridFS y cómo realizarlas.

Cómo funciona GridFS

GridFS organiza los archivos en un bucket, un grupo de colecciones de MongoDB que contiene los fragmentos de archivos y la información que los describe. El bucket contiene las siguientes colecciones, nombradas según la convención definida en la especificación de GridFS:

• El chunks La colección almacena los fragmentos de archivos binarios.

• La colección files almacena los metadatos del archivo.

Al crear un nuevo bucket de GridFS, el controlador crea las fs.chunks fs.files colecciones y, a menos que especifique un nombre diferente en las Mongo::Database#fs opciones del método. El controlador también crea un índice en cada colección para garantizar la recuperación eficiente de los archivos y los metadatos relacionados. El controlador crea el bucket de GridFS, si no existe, solo cuando se realiza la primera operación de escritura. El controlador crea índices solo si no existen y cuando el bucket está vacío. Para obtener más información sobre los índices de GridFS, consulte Índices de GridFS en el manual de MongoDB Server.

Al almacenar archivos con GridFS, el controlador divide los archivos en fragmentos más pequeños, cada uno representado por un documento independiente en la colección chunks. También crea un documento en la colección files que contiene el ID, el nombre y otros metadatos del archivo. Puede cargar el archivo desde la memoria o desde un flujo de datos. El siguiente diagrama muestra cómo GridFS divide los archivos al cargarlos en un bucket.

Al recuperar archivos, GridFS obtiene los metadatos de la colección files en el depósito especificado y utiliza la información para reconstruir el archivo a partir de los documentos de la colección chunks. Puede leer el archivo en memoria o exportarlo a una secuencia.

Crear un bucket de GridFS

Para almacenar o recuperar archivos de GridFS, cree un bucket de GridFS llamando al método fs en una instancia Mongo::Database. Puede usar la instancia FSBucket para realizar operaciones de lectura y escritura en los archivos de su bucket.

bucket = database.fs

Para crear o hacer referencia a un depósito con un nombre distinto del nombre predeterminado fs, pase el nombre del depósito como un parámetro opcional al método fs, como se muestra en el siguiente ejemplo:

custom_bucket = database.fs(database, bucket_name: 'files')

Cargar archivos

El método upload_from_stream lee el contenido de un flujo de carga y lo guarda en la instancia GridFSBucket.

Puede pasar un Hash como parámetro opcional para configurar el tamaño del fragmento o incluir metadatos adicionales.

El siguiente ejemplo carga un archivo en FSBucket y especifica metadatos para el archivo cargado:

metadata = { uploaded_by: 'username' }
File.open('/path/to/file', 'rb') do |file|
  file_id = bucket.upload_from_stream('test.txt', file, metadata: metadata)
  puts "Uploaded file with ID: #{file_id}"
end

Recuperar información del archivo

En esta sección, puedes aprender a recuperar metadatos de archivos almacenados en la colección files del depósito de GridFS. Los metadatos contienen información sobre el archivo al que se refieren, incluyendo:

• El _id del archivo

• El nombre del archivo

• El tamaño del archivo

• La fecha y hora de carga

• Un documento metadata en el que puedes almacenar cualquier otra información

Para obtener más información sobre los campos que puede recuperar de la files colección, consulte la documentación de la colección de archivos GridFS en el manual del servidor MongoDB.

Para recuperar archivos de un bucket de GridFS, llame al método find en la instancia FSBucket. El siguiente ejemplo de código recupera e imprime los metadatos de todos los archivos de un bucket de GridFS:

bucket.find.each do |file|
  puts "Filename: #{file.filename}"
end

Para obtener más información sobre cómo realizar consultas en MongoDB, consulte Buscar documentos.

Descarga de archivos

El método download_to_stream descarga el contenido de un archivo.

Para descargar un archivo por su archivo _id, pase el _id al método. El método download_to_stream escribe el contenido del archivo en el objeto proporcionado. El siguiente ejemplo descarga un archivo por su archivo _id:

file_id = BSON::ObjectId('your_file_id')
File.open('/path/to/downloaded_file', 'wb') do |file|
  bucket.download_to_stream(file_id, file)
end

Si conoce el nombre de un archivo, pero no su _id, puede usar el método download_to_stream_by_name. El siguiente ejemplo descarga un archivo llamado mongodb-tutorial:

File.open('/path/to/downloaded_file', 'wb') do |file|
  bucket.download_to_stream_by_name('mongodb-tutorial', file)
end

Eliminar archivos

Utilice el método delete para eliminar el documento de colección de un archivo y los fragmentos asociados de su bucket. Debe especificar el archivo por su campo _id en lugar de por su nombre.

El siguiente ejemplo elimina un archivo por su _id:

file_id = BSON::ObjectId('your_file_id')
bucket.delete(file_id)

Documentación de la API

Para obtener más información sobre el uso de GridFS para almacenar y recuperar archivos grandes, consulte la siguiente documentación de API:

• Mongo::Grid::FSBucket