Gestisci gli indici in Cloud Firestore

Cloud Firestore garantisce il rendimento delle query richiedendo un indice per ogni query. Gli indici richiesti per le query più semplici vengono creati automaticamente per te. Mentre utilizzi e testi l'app, Cloud Firestore genera messaggi di errore che ti aiutano a creare gli indici aggiuntivi necessari per l'app. Questa pagina descrive come gestire gli indici a campo singolo, composti e vettoriali.

Creare un indice mancante tramite un messaggio di errore

Se provi a eseguire una query composta con una clausola di intervallo che non è mappata a un indice esistente, viene visualizzato 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 della piattaforma Google Cloud, ma questi link si apriranno sempre nella Console Firebase.

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

Nota: per i campi non array e non mappa, devi selezionare l'ordinamento crescente o decrescente, anche se non hai bisogno del campo per l'ordinamento. La tua scelta non influisce sul comportamento delle equazioni nella query.

Se è richiesto un indice di vettore, il messaggio di errore includerà un comando Google Cloud CLI per creare l'indice di vettore mancante. Esegui il comando per creare l'indice mancante.

Nota: al momento non è possibile creare indici di vettori nella Console Firebase o nella console della piattaforma Google Cloud.

Ruoli e autorizzazioni

Prima di poter creare un indice in Cloud Firestore, assicurati di avere 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 la sezione Ruoli predefiniti.

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

Se hai definito ruoli personalizzati, assegna tutte le seguenti autorizzazioni per creare gli 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 dell'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 relativo stato nella sezione Indice composito. Se sono ancora in fase di compilazione, la console Firebase include una barra di stato della compilazione.

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, Firebase CLI genera un file JSON con gli indici predefiniti nel formato corretto. Modifica il file per aggiungere altri indici e esegui il deployment con il comando firebase deploy.

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

Se apporti modifiche agli indici utilizzando la console Firebase, assicurati di aggiornare anche il file degli indici locali. Fai riferimento al riferimento alla 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 esempio di file di configurazione Terraform 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 esempio di file di configurazione Terraform 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 esempio di file di configurazione Terraform crea un indice di vettore 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 compilazione dell'indice

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

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

• Il tempo necessario per il backfill dipende dalla quantità di dati esistenti appartenenti al nuovo indice. Maggiore è il numero di valori di campo che corrispondono alla definizione dell'indice, maggiore è il tempo necessario 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 di lunga durata. Cloud Firestore include funzionalità per eseguire e gestire operazioni a lunga esecuzione. Le operazioni a lunga esecuzione supportate includono le compilazioni degli indici e le operazioni di esportazione.

Dopo aver avviato una compilazione dell'indice, Cloud Firestore assegna all'operazione un nome univoco. I nomi delle operazioni sono preceduti da projects/[PROJECT_ID]/databases/(default)/operations/, ad esempio:

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

Tuttavia, puoi omettere il prefisso quando specifichi un nome dell'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 completate di recente. Le operazioni vengono elencate per alcuni giorni dopo il completamento:

gcloud firestore operations list

Controllare 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

Durante l'esecuzione dell'operazione, controlla il valore del campo state per lo stato complessivo dell'operazione.

Una richiesta relativa allo 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 verrà elaborato da un'operazione. workCompleted mostra il numero di documenti elaborati finora. Al termine dell'operazione,workCompleted riflette il numero totale di documenti effettivamente elaborati, che potrebbe essere diverso dal valore di workEstimated.

Dividi workCompleted per workEstimated per una stima approssimativa dei progressi. L' stima potrebbe non essere precisa perché dipende dalla raccolta delle statistiche con ritardo.

Ad esempio, di seguito è riportato lo stato di avanzamento di una compilazione dell'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. Consulta 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 per gli indici a un campo. Un'operazione di indicizzazione può non riuscire se Cloud Firestore riscontra un problema con i dati che sta indicizzando. In genere, significa che hai raggiunto un limite di indicizzazione. Ad esempio, l'operazione potrebbe aver raggiunto il numero massimo di voci dell'indice per documento.

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