Mengelola indeks di Cloud Firestore

Cloud Firestore memastikan performa kueri dengan mewajibkan indeks untuk setiap kueri. Indeks yang diperlukan untuk kueri paling dasar dibuat otomatis untuk Anda. Saat Anda menggunakan dan menguji aplikasi, Cloud Firestore akan membuat pesan error yang membantu Anda membuat indeks tambahan yang dibutuhkan aplikasi. Halaman ini menjelaskan cara mengelola indeks kolom tunggal, komposit, dan vektor.

Membuat indeks yang tidak ada melalui pesan error

Jika Anda mencoba kueri gabungan dengan klausa rentang yang tidak memetakan ke indeks yang ada, Anda akan menerima error. Pesan error menyertakan link langsung untuk membuat indeks yang tidak ada di Firebase console.

Catatan: Anda dapat mengelola Cloud Firestore melalui Firebase console atau Google Cloud Platform Console, tetapi link ini akan selalu terbuka di Firebase console.

Ikuti link yang dihasilkan untuk membuka Firebase console, tinjau info yang terisi secara otomatis, lalu klik Create.

Catatan: Untuk kolom non-array dan non-peta, Anda harus memilih urutan ascending atau descending, meskipun tidak memerlukan kolom tersebut untuk mengurutkan. Pilihan Anda tidak memengaruhi perilaku kesetaraan dalam kueri.

Jika indeks vektor diperlukan, pesan error akan menyertakan perintah Google Cloud CLI untuk membuat indeks vektor yang tidak ada. Jalankan perintah untuk membuat indeks yang tidak ada.

Catatan: Saat ini, indeks vektor tidak dapat dibuat di Firebase console atau Google Cloud Platform Console.

Peran dan izin

Sebelum dapat membuat indeks di Cloud Firestore, pastikan Anda ditunjuk untuk salah satu peran berikut:

Catatan: Peran berikut dikelola melalui Identity and Access Management (IAM). Untuk mengetahui informasi selengkapnya tentang peran dan izin terkait, lihat Peran yang telah ditetapkan.

• roles/datastore.owner
• roles/datastore.indexAdmin
• roles/editor
• roles/owner

Jika Anda telah menentukan peran khusus, tetapkan semua izin berikut untuk membuat indeks:

• datastore.indexes.create
• datastore.indexes.delete
• datastore.indexes.get
• datastore.indexes.list
• datastore.indexes.update

Menggunakan Firebase console

Untuk membuat indeks baru secara manual dari Firebase console:

1. Buka bagian Cloud Firestore di Firebase console.
2. Buka tab Indexes dan klik Add Index.
3. Masukkan nama koleksi dan tetapkan kolom yang ingin Anda urutkan indeksnya.
4. Klik Buat.

Kolom indeks harus sesuai dengan batasan pada jalur kolom.

Pembuatan indeks bisa membutuhkan waktu beberapa menit, tergantung pada ukuran kueri. Setelah membuatnya, Anda dapat melihat indeks dan statusnya di bagian Indeks Gabungan. Jika indeks masih dibuat, Firebase console akan menyertakan status bar pembuatan.

Menghapus indeks

Untuk menghapus indeks:

1. Buka bagian Cloud Firestore di Firebase console.
2. Klik tab Indexes.
3. Arahkan kursor ke indeks yang ingin Anda hapus dan pilih Hapus dari menu konteks.
4. Konfirmasi bahwa Anda ingin menghapusnya dengan mengklik Hapus dari pemberitahuan.

Menggunakan Firebase CLI

Anda juga dapat men-deploy indeks dengan Firebase CLI. Untuk memulai, jalankan firebase init firestore di direktori project Anda. Selama penyiapan, Firebase CLI menghasilkan file JSON dengan indeks default dalam format yang tepat. Edit file untuk menambahkan lebih banyak indeks dan men-deploynya dengan perintah firebase deploy.

Untuk hanya men-deploy indeks dan aturan Cloud Firestore, tambahkan flag --only firestore.

Jika mengedit indeks menggunakan Firebase console, pastikan Anda juga memperbarui file indeks lokal. Lihat referensi definisi indeks JSON.

Menggunakan Terraform

Membuat indeks dalam database

Database Cloud Firestore dapat menyertakan indeks kolom tunggal dan komposit. Anda dapat mengedit file konfigurasi Terraform agar dapat membuat indeks untuk database Anda. Indeks kolom tunggal dan komposit menggunakan jenis resource Terraform yang berbeda (google_firestore_index dan google_firestore_field).

Indeks kolom tunggal

Contoh file konfigurasi Terraform berikut membuat indeks kolom tunggal di kolom name dalam koleksi chatrooms:

firestore.tf

resource "random_id" "variable"{
  byte_length = 8
}

resource "google_firestore_field" "single-index" {
  project = "project-id"
  database = "database-id"
  collection = "chatrooms_${random_id.variable.hex}"
  field = "name"

  index_config {
    indexes {
        order = "ASCENDING"
        query_scope = "COLLECTION_GROUP"
    }
    indexes {
        array_config = "CONTAINS"
    }
  }

  ttl_config {}
}

• Ganti project-id dengan project ID Anda. Project ID harus unik.
• Ganti database-id dengan ID database Anda.

Indeks komposit

Contoh file konfigurasi Terraform berikut membuat indeks komposit untuk kombinasi kolom name dan kolom description dalam koleksi chatrooms:

firestore.tf

resource "google_firestore_index" "composite-index" {
  project = "project-id"
  database = "database-id"

  collection = "chatrooms"

  fields {
    field_path = "name"
    order      = "ASCENDING"
  }

  fields {
    field_path = "description"
    order      = "DESCENDING"
  }

}

• Ganti project-id dengan project ID Anda. Project ID harus unik.
• Ganti database-id dengan ID database Anda.

Indeks vektor

Contoh file konfigurasi Terraform berikut membuat indeks vektor di kolom embedding dalam koleksi chatrooms:

firestore.tf

resource "google_firestore_index" "vector-index" {
  project = "project-id"
  database = "database-id"
  collection = "chatrooms"

  fields {
    field_path = "__name__"
    order = "ASCENDING"
  }

  fields {
    field_path = "embedding"
    vector_config {
      dimension = 128
      flat {}
    }
  }
}

• Ganti project-id dengan project ID Anda. Project ID harus unik.
• Ganti database-id dengan ID database Anda.

Waktu build indeks

Untuk membuat indeks, Cloud Firestore harus menyiapkan indeks, lalu mengisi ulang indeks dengan data yang ada. Waktu build indeks adalah jumlah waktu penyiapan dan waktu pengisian ulang:

• Menyiapkan indeks memerlukan waktu beberapa menit. Waktu build minimum untuk indeks adalah beberapa menit, meskipun untuk database yang kosong.

• Waktu pengisian ulang bergantung pada jumlah data yang ada dalam indeks baru. Semakin banyak nilai kolom yang cocok dengan definisi indeks, semakin lama waktu yang diperlukan untuk mengisi ulang indeks.

Build indeks merupakan operasi yang berjalan lama.

Istilah Penting: Cloud Firestore mendukung beberapa operasi administratif yang memerlukan waktu yang lama untuk diselesaikan. Operasi ini disebut operasi yang berjalan lama. Cloud Firestore menyertakan fitur untuk menjalankan dan mengelola operasi yang berjalan lama. Operasi yang berjalan lama yang didukung mencakup operasi ekspor dan build indeks.

Setelah Anda memulai build indeks, Cloud Firestore akan menetapkan nama unik untuk operasi tersebut. Nama operasi diawali dengan projects/[PROJECT_ID]/databases/(default)/operations/, misalnya:

projects/project-id/databases/(default)/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg

Namun, Anda dapat tidak menyertakan awalan saat menentukan nama operasi untuk perintah describe.

Mencantumkan semua operasi yang berjalan lama

Untuk mencantumkan operasi yang berjalan lama, gunakan perintah gcloud firestore operations list. Perintah ini mencantumkan operasi yang sedang berlangsung dan yang baru saja selesai. Operasi tercantum selama beberapa hari setelah selesai:

gcloud firestore operations list

Memeriksa status operasi

Alih-alih mencantumkan semua operasi yang berjalan lama, Anda dapat mencantumkan detail satu operasi:

gcloud firestore operations describe operation-name

Memperkirakan waktu penyelesaian

Saat operasi berjalan, lihat nilai kolom state untuk mengetahui status operasi secara keseluruhan.

Permintaan untuk status operasi yang berjalan lama juga menampilkan metrik workEstimated dan workCompleted. Metrik ini ditampilkan untuk sejumlah dokumen. workEstimated menunjukkan perkiraan jumlah total dokumen yang akan diproses dalam operasi. workCompleted menunjukkan jumlah dokumen yang diproses sejauh ini. Setelah operasi selesai, workCompleted mencerminkan jumlah total dokumen yang sebenarnya diproses yang mungkin berbeda dari nilai workEstimated.

Bagilah workCompleted dengan workEstimated untuk mengetahui perkiraan kasar dari progresnya. Perkiraan ini mungkin tidak akurat karena tergantung pada pengumpulan statistik yang tertunda.

Misalnya, berikut adalah status progres dari suatu build indeks:

{
  "operations": [
    {
      "name": "projects/project-id/operations/AyAyMDBiM2U5NTgwZDAtZGIyYi0zYjc0LTIzYWEtZjg1ZGdWFmZWQHEjF0c2Flc3UtcmV4ZWRuaS1uaW1kYRUKSBI",
      "metadata": {
        "@type": "type.googleapis.com/google.firestore.admin.v1.IndexOperationMetadata",
        "common": {
          "operationType": "CREATE_INDEX",
          "startTime": "2020-06-23T16:52:25.697539Z",
          "state": "PROCESSING"
        },
        "progressDocuments": {
          "workCompleted": "219327",
          "workEstimated": "2198182"
        }
       },
    },
    ...

Saat operasi selesai, deskripsi operasi akan berisi "done": true. Lihat nilai kolom state untuk menemukan hasil operasi. Jika kolom done tidak ditetapkan dalam respons, maka nilainya adalah false. Jangan bergantung pada keberadaan nilai done untuk operasi yang sedang berlangsung.

Error dalam mem-build indeks

Anda mungkin mengalami error dalam membuat indeks saat mengelola indeks gabungan dan pengecualian indeks satu kolom. Operasi pengindeksan dapat gagal jika Cloud Firestore menemukan masalah dengan data yang diindeks. Biasanya, ini berarti Anda mencapai batas indeks. Misalnya, operasi mungkin telah mencapai jumlah entri indeks maksimum per dokumen.

Jika pembuatan indeks gagal, Anda melihat pesan error di konsol. Setelah memverifikasi bahwa Anda tidak mencapai batas indeks, coba lagi operasi indeks.