Usar metadatos de archivos con Cloud Storage en la Web

Después de cargar un archivo en la referencia de Cloud Storage, también puede obtener o actualizar los metadatos del archivo, por ejemplo, para actualizar el tipo de contenido. Los archivos también pueden almacenar pares clave/valor personalizados con metadatos de archivo adicionales.

Obtener metadatos de archivos

Los metadatos de archivos contienen propiedades comunes como name , size y contentType (a menudo denominado tipo MIME), además de algunas menos comunes como contentDisposition y timeCreated . Estos metadatos se pueden recuperar de una referencia de Cloud Storage mediante el método getMetadata() . getMetadata() devuelve una Promise que contiene los metadatos completos, o un error si la Promise se rechaza.

Web modular API

import { getStorage, ref, getMetadata } from "firebase/storage";

// Create a reference to the file whose metadata we want to retrieve
const storage = getStorage();
const forestRef = ref(storage, 'images/forest.jpg');

// Get metadata properties
getMetadata(forestRef)
  .then((metadata) => {
    // Metadata now contains the metadata for 'images/forest.jpg'
  })
  .catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_get_metadata.js

Web namespaced API

// Create a reference to the file whose metadata we want to retrieve
var forestRef = storageRef.child('images/forest.jpg');

// Get metadata properties
forestRef.getMetadata()
  .then((metadata) => {
    // Metadata now contains the metadata for 'images/forest.jpg'
  })
  .catch((error) => {
    // Uh-oh, an error occurred!
  });
file-metadata.js

Actualizar metadatos del archivo

Puede actualizar los metadatos del archivo en cualquier momento después de que se complete la carga del archivo utilizando el método updateMetadata() . Consulte la lista completa para obtener más información sobre qué propiedades se pueden actualizar. Sólo se actualizan las propiedades especificadas en los metadatos, todas las demás no se modifican. updateMetadata() devuelve una Promise que contiene los metadatos completos, o un error si la Promise se rechaza.

Web modular API

import { getStorage, ref, updateMetadata } from "firebase/storage";

// Create a reference to the file whose metadata we want to change
const storage = getStorage();
const forestRef = ref(storage, 'images/forest.jpg');

// Create file metadata to update
const newMetadata = {
  cacheControl: 'public,max-age=300',
  contentType: 'image/jpeg'
};

// Update metadata properties
updateMetadata(forestRef, newMetadata)
  .then((metadata) => {
    // Updated metadata for 'images/forest.jpg' is returned in the Promise
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_update_metadata.js

Web namespaced API

// Create a reference to the file whose metadata we want to change
var forestRef = storageRef.child('images/forest.jpg');

// Create file metadata to update
var newMetadata = {
  cacheControl: 'public,max-age=300',
  contentType: 'image/jpeg'
};

// Update metadata properties
forestRef.updateMetadata(newMetadata)
  .then((metadata) => {
    // Updated metadata for 'images/forest.jpg' is returned in the Promise
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
file-metadata.js

Puede eliminar una propiedad de metadatos configurándola en null :

Web modular API

import { getStorage, ref, updateMetadata } from "firebase/storage";

const storage = getStorage();
const forestRef = ref(storage, 'images/forest.jpg');

// Create file metadata with property to delete
const deleteMetadata = {
  contentType: null
};

// Delete the metadata property
updateMetadata(forestRef, deleteMetadata)
  .then((metadata) => {
    // metadata.contentType should be null
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_delete_metadata.js

Web namespaced API

// Create file metadata with property to delete
var deleteMetadata = {
  contentType: null
};

// Delete the metadata property
forestRef.updateMetadata(deleteMetadata)
  .then((metadata) => {
    // metadata.contentType should be null
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
file-metadata.js

Manejar errores

Hay varias razones por las que pueden ocurrir errores al obtener o actualizar metadatos, incluido el archivo que no existe o que el usuario no tiene permiso para acceder al archivo deseado. Puede encontrar más información sobre errores en la sección Manejar errores de los documentos.

Metadatos personalizados

Puede especificar metadatos personalizados como un objeto que contiene propiedades String .

Web modular API

const metadata = {
  customMetadata: {
    'location': 'Yosemite, CA, USA',
    'activity': 'Hiking'
  }
};
storage_custom_metadata.js

Web namespaced API

var metadata = {
  customMetadata: {
    'location': 'Yosemite, CA, USA',
    'activity': 'Hiking'
  }
};
file-metadata.js

Puedes usar metadatos personalizados para almacenar datos adicionales específicos de la aplicación para cada archivo, pero recomendamos encarecidamente usar una base de datos (como Firebase Realtime Database ) para almacenar y sincronizar este tipo de datos.

Propiedades de metadatos de archivo

A continuación se encuentra disponible una lista completa de las propiedades de metadatos de un archivo:

Propiedad Tipo grabable
bucket cadena NO
generation cadena NO
metageneration cadena NO
fullPath cadena NO
name cadena NO
size número NO
timeCreated cadena NO
updated cadena NO
md5Hash cadena SÍ al cargar, NO al actualizarMetadatos
cacheControl cadena SÍ
contentDisposition cadena SÍ
contentEncoding cadena SÍ
contentLanguage cadena SÍ
contentType cadena SÍ
customMetadata Objeto que contiene cadena->asignaciones de cadenas SÍ

Cargar, descargar y actualizar archivos es importante, pero también lo es poder eliminarlos. Aprendamos cómo eliminar archivos de Cloud Storage.