Cloud Firestore, her sorgu için bir dizin gerektirerek sorgu performansını sağlar. En temel sorgular için gereken dizinler otomatik olarak oluşturulur. Uygulamanızı kullanıp test ederken Cloud Firestore, uygulamanızın ihtiyaç duyduğu ek dizinleri oluşturmanıza yardımcı olan hata mesajları üretir. Bu sayfada, otomatik, manuel ve vektör dizinlerinizi nasıl yöneteceğiniz açıklanmaktadır.
Hata mesajı aracılığıyla eksik dizin oluşturma
Mevcut bir dizinle eşlenmeyen bir aralık ifadesi içeren bileşik sorgu denerseniz hata alırsınız. Hata mesajında, Firebase konsolunda eksik dizini oluşturmak için doğrudan bir bağlantı bulunur.
Oluşturulan bağlantıyı kullanarak Firebase konsoluna gidin, otomatik olarak doldurulan bilgileri inceleyin ve Oluştur'u tıklayın.
Vektör dizini gerektiğinde hata mesajında, eksik vektör dizinini oluşturmak için Google Cloud CLI komutu yer alır. Eksik dizini oluşturmak için komutu çalıştırın.
Roller ve izinler
Cloud Firestore içinde dizin oluşturabilmek için aşağıdaki rollerden birinin size atanmış olması gerekir:
roles/datastore.ownerroles/datastore.indexAdminroles/editorroles/owner
Özel roller tanımladıysanız dizin oluşturmak için aşağıdaki izinlerin tümünü atayın:
datastore.indexes.createdatastore.indexes.deletedatastore.indexes.getdatastore.indexes.listdatastore.indexes.update
Firebase konsolunu kullanma
Firebase konsolundan manuel olarak yeni bir dizin oluşturmak için:
- Firebase konsolunda Veritabanları ve Depolama > Firestore'a gidin.
- Dizinler sekmesinde Dizin Ekle'yi tıklayın.
- Koleksiyon adını girin ve dizini sıralamak istediğiniz alanları ayarlayın.
- Oluştur'u tıklayın.
Dizin alanları, alan yollarıyla ilgili kısıtlamalara uymalıdır.
Sorgunun boyutuna bağlı olarak, dizinlerin oluşturulması birkaç dakika sürebilir. Oluşturduktan sonra dizinlerinizi ve durumlarını Bileşik Dizinler bölümünde görebilirsiniz. Hâlâ oluşturma aşamasındaysa Firebase konsolunda bir oluşturma durumu çubuğu gösterilir.
Dizinleri kaldırma
Bir dizini silmek için:
- Firebase konsolunda Veritabanları ve Depolama > Firestore'a gidin.
- Dizinler sekmesinde, silmek istediğiniz dizinin üzerine gelin ve bağlam menüsünden Sil'i seçin.
- Uyarıda Sil'i tıklayarak silmek istediğinizi onaylayın.
Firebase CLI'yı kullanma
Dizinleri Firebase CLI ile de dağıtabilirsiniz.
Başlamak için proje dizininizde firebase init firestore komutunu çalıştırın.
Kurulum sırasında Firebase CLI, doğru biçimde varsayılan dizinleri içeren bir JSON dosyası oluşturur. Daha fazla dizin eklemek için dosyayı düzenleyin ve firebase deploy komutuyla dağıtın.
Yalnızca Cloud Firestore dizinlerini ve kurallarını dağıtmak için --only firestore işaretini ekleyin.
Firebase konsolunu kullanarak dizinlerde düzenlemeler yaparsanız yerel dizinler dosyanızı da güncellediğinizden emin olun. JSON dizin tanımı referansına bakın.
Terraform'u kullanma
Veritabanında dizin oluşturma
Cloud Firestore veritabanları hem tek alanlı (otomatik) hem de birleşik (manuel) dizinler içerebilir. Veritabanınız için bir dizin oluşturmak üzere Terraform yapılandırma dosyasını düzenleyebilirsiniz. Otomatik ve manuel dizinler farklı Terraform kaynak türleri kullanır
(google_firestore_index
ve google_firestore_field).
Tek alanlı (otomatik) dizin
Aşağıdaki örnek Terraform yapılandırma dosyası, chatrooms koleksiyonundaki name alanında tek alanlı bir dizin oluşturur:
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 {}
}
- project-id yerine proje kimliğinizi yazın. Proje kimlikleri benzersiz olmalıdır.
- database-id yerine veritabanı kimliğinizi yazın.
Bileşik (manuel) dizin
Aşağıdaki örnek Terraform yapılandırma dosyası, chatrooms koleksiyonundaki name alanı ve description alanının kombinasyonu için bileşik bir dizin oluşturur:
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"
}
}
- project-id yerine proje kimliğinizi yazın. Proje kimlikleri benzersiz olmalıdır.
- database-id yerine veritabanı kimliğinizi yazın.
Vektör dizini
Aşağıdaki örnek Terraform yapılandırma dosyası, chatrooms koleksiyonundaki embedding alanında bir vektör dizini oluşturur:
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 {}
}
}
}
- project-id yerine proje kimliğinizi yazın. Proje kimlikleri benzersiz olmalıdır.
- database-id yerine veritabanı kimliğinizi yazın.
Dizin derleme süresi
Dizin oluşturmak için Cloud Firestore dizini oluşturmalı ve ardından dizini mevcut verilerle doldurmalıdır. Dizin derleme süresi, kurulum süresi ve doldurma süresinin toplamıdır:
Dizin oluşturma işlemi birkaç dakika sürer. Boş bir veritabanı için bile bir dizinin minimum oluşturma süresi birkaç dakikadır.
Doldurma süresi, yeni dizinde ne kadar mevcut veri olduğuna bağlıdır. Dizin tanımıyla eşleşen alan değerleri ne kadar fazlaysa dizinin doldurulması o kadar uzun sürer.
Dizin oluşturma işlemleri uzun süreli işlemlerdir.
Dizin oluşturma işlemini başlattıktan sonra Cloud Firestore, işleme benzersiz bir ad atar. İşlem adlarının önüne projects/[PROJECT_ID]/databases/(default)/operations/ eklenir. Örneğin:
projects/project-id/databases/(default)/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg
Ancak describe komutu için işlem adı belirtirken öneki atlayabilirsiniz.
Tüm uzun süreli işlemleri listeleme
Uzun süren işlemleri listelemek için gcloud firestore operations list komutunu kullanın. Bu komut, devam eden ve yakın zamanda tamamlanan işlemleri listeler. İşlemler, tamamlandıktan sonra birkaç gün boyunca listelenir:
gcloud firestore operations list
İşlem durumunu kontrol etme
Tüm uzun süreli işlemleri listelemek yerine tek bir işlemin ayrıntılarını listeleyebilirsiniz:
gcloud firestore operations describe operation-name
Tamamlanma süresini tahmin etme
İşleminiz çalışırken işlemin genel durumu için state alanının değerini görün.
Uzun süreli bir işlemin durumuyla ilgili istekler de workEstimated ve workCompleted metriklerini döndürür. Bu metrikler, doküman sayısı için döndürülür. workEstimated, bir işlemin işleyeceği tahmini toplam belge sayısını gösterir. workCompleted
Şu ana kadar işlenen doküman sayısını gösterir. İşlem tamamlandıktan sonra,
workCompleted, gerçekten işlenen toplam belge sayısını yansıtır. Bu sayı, workEstimated değerinden farklı olabilir.
Kabaca bir ilerleme tahmini için workCompleted değerini workEstimated değerine bölün. Tahmin, istatistiklerin toplanması geciktiğinden yanlış olabilir.
Örneğin, dizin oluşturma işleminin ilerleme durumu aşağıda verilmiştir:
{
"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"
}
},
},
...
Bir işlem tamamlandığında işlem açıklamasında "done":
true yer alır. İşlemin sonucu için state alanının değerini görün. Yanıtın done alanı ayarlanmamışsa değeri false olur. Devam eden işlemler için done değerinin varlığına güvenmeyin.
Dizin oluşturma hataları
Manuel dizinleri ve otomatik dizin muafiyetlerini yönetirken dizin oluşturma hatalarıyla karşılaşabilirsiniz. Bir dizine ekleme işlemi, Cloud Firestore dizine eklediği verilerle ilgili bir sorunla karşılaşırsa başarısız olabilir. Bu durum en sık olarak bir dizin sınırına ulaştığınız anlamına gelir. Örneğin, işlem, belge başına maksimum dizin girişi sayısına ulaşmış olabilir.
Dizin oluşturma işlemi başarısız olursa konsolda hata mesajını görürsünüz. Herhangi bir dizin sınırına ulaşmadığınızı doğruladıktan sonra dizin oluşturma işleminizi yeniden deneyin.