Gestisci gli indici in Cloud Firestore

Cloud Firestore garantisce le prestazioni delle query richiedendo un indice per ogni query. Gli indici necessari per le query più basilari vengono automaticamente creati per te. Mentre usi e testi la tua app, Cloud Firestore genera messaggi di errore che consentono di creare altri indici per il tuo richiede l'uso dell'app. In questa pagina viene descritto come gestire Indici a campo singolo e composito.

Crea un indice mancante tramite un messaggio di errore

Se tenti di eseguire una query composta da una clausola Range che non esegue la mappatura a un indice esistente. ricevi un messaggio di errore. Il messaggio di errore include un link diretto per creare 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 collegamento generato alla console Firebase, rivedi l'impostazione compilate e fai clic su Crea.

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

Ruoli e autorizzazioni

Prima di poter creare un indice in Cloud Firestore, assicurati che ti siano stati assegnati uno dei seguenti ruoli:

Nota: i ruoli seguenti sono gestiti tramite Identity and Access Management (IAM). Per saperne di più sui ruoli e sulle autorizzazioni associate, vedi 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 di 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 ordinare l'indice.
4. Fai clic su Crea.

I campi dell'indice devono essere conformi ai vincoli sui 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 nel Indici compositi. Se sono ancora in fase di compilazione, la console Firebase include una barra di stato della compilazione.

Rimuovi 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 Flag --only firestore.

Se apporti modifiche agli indici utilizzando la console Firebase, apporta aggiorna anche il file degli indici locali. Consulta Riferimento alla definizione dell'indice JSON.

Utilizza Terraform

crea gli indici nel database

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

Indice a campo singolo

Il seguente file di configurazione Terraform di esempio crea un indice a campo singolo nel 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.

Ora di creazione indice

Per creare un indice, Cloud Firestore deve configurare l'indice, quindi eseguire il backfill dell'indice con i dati esistenti. La metrica Tempo di creazione indice è la somma dei tempi di configurazione e tempo di backfill:

• La configurazione di un indice richiede alcuni minuti. La build minima per un indice è di pochi minuti, anche per un database vuoto.

• Il tempo di backfill dipende dalla quantità di dati esistenti che appartengono al nuovo indice. La più valori di campo che corrispondono alla definizione dell'indice, maggiore sarà il tempo necessario 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 a lunga esecuzione operazioni. Cloud Firestore include funzionalità per l'esecuzione e la gestione di le operazioni in esecuzione. Le operazioni a lunga esecuzione supportate includono build di indice e 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 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

Durante l'esecuzione dell'operazione, osserva il valore del campo state per conoscere lo stato generale dell'operazione.

Anche una richiesta per lo stato di un'operazione a lunga esecuzione restituisce le metriche workEstimated e workCompleted. Queste metriche vengono restituite per il numero di documenti. workEstimated mostra il numero totale stimato di documenti verrà elaborata. 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 dell'avanzamento. La stima potrebbe non essere precisa perché dipende da statistiche ritardate .

Ad esempio, ecco lo stato di avanzamento di una build 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 relativa descrizione 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 dipendono dall'esistenza del valore done per le operazioni in corso.

Errori di creazione degli indici

Potresti riscontrare errori di creazione degli indici quando gestisci indici composti esenzioni degli indici a campo singolo. Un'operazione di indicizzazione può non riuscire se Cloud Firestore riscontra un problema con i dati che sta indicizzando. Più alta di solito, questo significa che limite di indice. Per 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 i limiti dell'indice, riprova a eseguire l'operazione di indicizzazione.