Gestisci gli indici in Cloud Firestore

Cloud Firestore garantisce le prestazioni delle query richiedendo un indice per ogni query. Gli indici richiesti per le query più semplici vengono creati automaticamente. Man mano che utilizzi e testi la tua app, Cloud Firestore genera messaggi di errore che ti aiutano a creare gli indici aggiuntivi richiesti dalla tua app. Questa pagina descrive come gestire gli indici a campo singolo, compositi e vettoriali.

Creare un indice mancante tramite un messaggio di errore

Se tenti una query composta con una clausola di intervallo che non corrisponde a un indice esistente, ricevi un errore. Il messaggio di errore include un link diretto per creare l'indice mancante nella console Firebase.

Nota :puoi gestire Cloud Firestore tramite la Console Firebase o la console Google Cloud, ma questi link si apriranno sempre nella Console Firebase.

Segui il link generato alla console Firebase, esamina le informazioni compilate automaticamente e fai clic su Crea.

Nota: per i campi non di array e non di mappa, devi selezionare l'ordinamento crescente o decrescente, anche se non ti serve il campo per l'ordinamento. La tua scelta non influisce sul comportamento delle uguaglianze nella query.

Nel caso in cui sia necessario un indice vettoriale, il messaggio di errore includerà un comando Google Cloud CLI per creare l'indice vettoriale mancante. Esegui il comando per creare l'indice mancante.

Nota: al momento gli indici vettoriali non possono essere creati nella console Firebase o nella console di Google Cloud Platform.

Ruoli e autorizzazioni

Prima di poter creare un indice in Cloud Firestore, assicurati di disporre di uno dei seguenti ruoli:

Nota :i seguenti ruoli vengono gestiti tramite Identity and Access Management (IAM). Per ulteriori informazioni sui ruoli e sulle autorizzazioni associate, consulta Ruoli predefiniti.

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

Se hai definito ruoli personalizzati, assegna tutte le seguenti autorizzazioni per creare indici:

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

Utilizzare la console Firebase

Per creare manualmente un nuovo indice dalla console Firebase:

1. Vai alla sezione Cloud Firestore della console Firebase.
2. Vai alla scheda Indici e fai clic su Aggiungi indice.
3. Inserisci il nome della raccolta e imposta i campi in base ai quali vuoi ordinare l'indice.
4. Fai clic su Crea.

I campi indice devono essere conformi ai vincoli dei percorsi dei campi.

La creazione degli indici può richiedere alcuni minuti, a seconda delle dimensioni della query. Dopo averli creati, puoi visualizzare gli indici e il loro stato nella sezione Indici compositi. Se è ancora in corso la creazione, la console Firebase include una barra di stato della creazione.

Rimuovere gli indici

Per eliminare un indice:

1. Vai alla sezione Cloud Firestore della console Firebase.
2. Fai clic sulla scheda Indici.
3. Passa il mouse sopra l'indice che vuoi eliminare e seleziona Elimina dal menu contestuale.
4. Conferma di volerlo eliminare facendo clic su Elimina nell'avviso.

Utilizza l'interfaccia a riga di comando di Firebase

Puoi anche eseguire il deployment degli indici con l'interfaccia a riga di comando di Firebase. Per iniziare, esegui firebase init firestore nella directory del progetto. Durante la configurazione, la CLI Firebase genera un file JSON con gli indici predefiniti nel formato corretto. Modifica il file per aggiungere altri indici e implementalo con il comando firebase deploy.

Per eseguire il deployment solo di indici e regole Cloud Firestore, aggiungi il flag --only firestore.

Se apporti modifiche agli indici utilizzando la console Firebase, assicurati di aggiornare anche il file degli indici locali. Fai riferimento alla documentazione di riferimento per la definizione dell'indice JSON.

Utilizza Terraform

Creazione di indici nel database

I database Cloud Firestore possono includere indici a campo singolo e composti. Puoi modificare il file di configurazione Terraform per creare un indice per il tuo database. Gli indici a campo singolo e composti utilizzano tipi di risorse Terraform distinti (google_firestore_index e google_firestore_field).

Indice a campo singolo

Il seguente file di configurazione Terraform di esempio crea un indice a campo singolo sul campo name nella raccolta 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 {}
}

• Sostituisci project-id con l'ID progetto. Gli ID progetto devono essere univoci.
• Sostituisci database-id con l'ID del tuo database.

Indice composto

Il seguente file di configurazione Terraform di esempio crea un indice composto per una combinazione del campo name e del campo description nella raccolta 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"
  }

}

• Sostituisci project-id con l'ID progetto. Gli ID progetto devono essere univoci.
• Sostituisci database-id con l'ID del tuo database.

Indice vettoriale

Il seguente file di configurazione Terraform di esempio crea un indice vettoriale sul campo embedding nella raccolta 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 {}
    }
  }
}

• Sostituisci project-id con l'ID progetto. Gli ID progetto devono essere univoci.
• Sostituisci database-id con l'ID del tuo database.

Tempo di creazione dell'indice

Per creare un indice, Cloud Firestore deve configurarlo e poi riempirlo con i dati esistenti. Il tempo di creazione dell'indice è la somma del tempo di configurazione e del tempo di backfill:

• La configurazione di un indice richiede alcuni minuti. Il tempo minimo di creazione di un indice è di alcuni minuti, anche per un database vuoto.

• Il tempo necessario per il backfill dipende dalla quantità di dati esistenti da inserire nel nuovo indice. Più valori di campo corrispondono alla definizione dell'indice, più tempo ci vuole per eseguire il backfill dell'indice.

Le build degli indici sono operazioni a lunga esecuzione.

Termine chiave: Cloud Firestore supporta diverse operazioni amministrative che possono richiedere molto tempo per essere completate. Queste operazioni sono chiamate operazioni a lunga esecuzione. Cloud Firestore include funzionalità per eseguire e gestire operazioni a lunga esecuzione. Le operazioni a lunga esecuzione supportate includono la creazione di indici e le operazioni di esportazione.

Dopo aver avviato la creazione di un indice, Cloud Firestore assegna all'operazione un nome univoco. I nomi delle operazioni hanno il prefisso projects/[PROJECT_ID]/databases/(default)/operations/, ad esempio:

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

Tuttavia, puoi omettere il prefisso quando specifichi un nome di operazione per il comando describe.

Elenco di tutte le operazioni a lunga esecuzione

Per elencare le operazioni a lunga esecuzione, utilizza il comando gcloud firestore operations list. Questo comando elenca le operazioni in corso e quelle completate di recente. Le operazioni vengono elencate per alcuni giorni dopo il completamento:

gcloud firestore operations list

Controlla lo stato dell'operazione

Anziché elencare tutte le operazioni a lunga esecuzione, puoi elencare i dettagli di una singola operazione:

gcloud firestore operations describe operation-name

Stima del tempo di completamento

Mentre l'operazione è in esecuzione, visualizza il valore del campo state per lo stato complessivo dell'operazione.

Una richiesta dello stato di un'operazione a lunga esecuzione restituisce anche le metriche workEstimated e workCompleted. Queste metriche vengono restituite per il numero di documenti. workEstimated mostra il numero totale stimato di documenti che un'operazione elaborerà. workCompleted mostra il numero di documenti elaborati finora. Al termine dell'operazione, workCompleted riflette il numero totale di documenti che sono stati effettivamente elaborati, che potrebbe essere diverso dal valore di workEstimated.

Dividi workCompleted per workEstimated per una stima approssimativa dei progressi. La stima potrebbe essere imprecisa perché dipende dalla raccolta ritardata delle statistiche.

Ad esempio, ecco lo stato di avanzamento della creazione di un indice:

{
  "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"
        }
       },
    },
    ...

Al termine di un'operazione, la descrizione dell'operazione conterrà "done": true. Visualizza il valore del campo state per il risultato dell'operazione. Se il campo done non è impostato nella risposta, il suo valore è false. Non fare affidamento sull'esistenza del valore done per le operazioni in corso.

Errori di creazione dell'indice

Potresti riscontrare errori di creazione dell'indice durante la gestione degli indici compositi e delle esenzioni degli indici a un solo campo. Un'operazione di indicizzazione può non riuscire se Cloud Firestore rileva un problema con i dati che sta indicizzando. Nella maggior parte dei casi, questo significa che hai raggiunto un limite di indice. Ad esempio, l'operazione potrebbe aver raggiunto il numero massimo di voci di indice per documento.

Se la creazione dell'indice non riesce, viene visualizzato il messaggio di errore nella console. Dopo aver verificato di non aver raggiunto alcun limite di indice, riprova l'operazione di indicizzazione.