Setelah mengupload file ke referensi Cloud Storage, Anda juga dapat memperoleh dan mengupdate metadata file, misalnya untuk mengupdate jenis konten. File juga dapat menyimpan key-value pair kustom dengan metadata file tambahan.
Mengambil Metadata File
Metadata file berisi properti umum, seperti name
, size
, dan contentType
(sering disebut jenis MIME), serta beberapa properti yang jarang digunakan, seperti contentDisposition
dan timeCreated
. Metadata ini dapat diambil dari
referensi Cloud Storage menggunakan
metode getMetadata()
. getMetadata()
menampilkan Promise
yang berisi
metadata lengkap, atau error jika Promise
menolak.
Web
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! });
Web
// 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! });
Memperbarui Metadata File
Anda dapat memperbarui metadata file kapan saja setelah file selesai diupload menggunakan metode updateMetadata()
. Lihat daftar lengkap untuk mengetahui informasi lebih lanjut mengenai properti yang dapat diperbarui. Hanya properti yang ditetapkan dalam metadata yang akan diperbarui,
sedangkan yang lainnya tidak berubah. updateMetadata()
menampilkan Promise
yang berisi metadata lengkap, atau error jika Promise
menolak.
Web
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! });
Web
// 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! });
Anda dapat menghapus properti metadata dengan menyetelnya ke null
:
Web
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! });
Web
// 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! });
Menangani Error
Ada sejumlah alasan terjadinya error saat mengambil atau memperbarui metadata, termasuk tidak adanya file atau pengguna tidak memiliki izin untuk mengakses file yang diinginkan. Informasi lebih lanjut mengenai error bisa dilihat di bagian Menangani Error pada dokumentasi.
Metadata Kustom
Anda dapat menentukan metadata kustom sebagai objek yang berisi properti String
.
Web
const metadata = { customMetadata: { 'location': 'Yosemite, CA, USA', 'activity': 'Hiking' } };
Web
var metadata = { customMetadata: { 'location': 'Yosemite, CA, USA', 'activity': 'Hiking' } };
Anda dapat menggunakan metadata kustom untuk menyimpan data khusus aplikasi tambahan untuk setiap file, tetapi kami sangat menyarankan untuk menggunakan database (seperti Firebase Realtime Database) untuk menyimpan dan menyinkronkan jenis data ini.
Properti Metadata File
Daftar lengkap properti metadata pada file tercantum di bawah ini:
Properti | Jenis | Dapat Ditulis |
---|---|---|
bucket |
string | TIDAK |
generation |
string | TIDAK |
metageneration |
string | TIDAK |
fullPath |
string | TIDAK |
name |
string | TIDAK |
size |
angka | TIDAK |
timeCreated |
string | TIDAK |
updated |
string | TIDAK |
md5Hash |
string | YA untuk upload, TIDAK untuk updateMetadata |
cacheControl |
string | YA |
contentDisposition |
string | YA |
contentEncoding |
string | YA |
contentLanguage |
string | YA |
contentType |
string | YA |
customMetadata |
Objek yang berisi string->pemetaan string | YA |
Mengupload, mendownload, dan memperbarui file itu penting, tetapi kita juga harus bisa menghapusnya. Mari pelajari cara menghapus file dari Cloud Storage.