Gestisci indici

Questa pagina descrive come gestire gli indici. Per scoprire di più sugli indici, consulta la panoramica degli indici.

Prima di iniziare

Prima di poter creare un indice in Firestore con compatibilità MongoDB, assicurati di avere uno dei seguenti ruoli:

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

Per concedere un ruolo, consulta Concedere un singolo ruolo. Per ulteriori informazioni sui ruoli di Firestore e sulle autorizzazioni associate, consulta la sezione Ruoli predefiniti.

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

Crea un indice

Per creare un indice:

gcloud firestore indexes composite create \
--database='DATABASE_ID' \
--collection-group=COLLECTION \
--field-config=FIELD_CONFIGURATION \
--query-scope=collection-group \
--density=dense \
--api-scope=mongodb-compatible-api

resource "google_firestore_index" "index" {
  database    = "DATABASE_ID"
  collection  = "COLLECTION"
  api_scope   = "MONGODB_COMPATIBLE_API"
  query_scope = "COLLECTION_GROUP"

  // You can include multiple field blocks
  fields {
    field_path = "FIELD_PATH"
    order      = "ORDER"
  }

  // Optional
  multikey = true
  density  = "DENSITY"
}

Eliminare un indice

Per eliminare un indice:

Tempo di compilazione dell'indice

Per creare un indice, Firestore con compatibilità MongoDB deve creare l'indice e poi eseguire il backfill delle voci dell'indice con i dati esistenti. Il tempo necessario per creare un indice è determinato da quanto segue:

• Il tempo di compilazione minimo per un indice è di pochi minuti, anche per un database vuoto.

• Il tempo necessario per eseguire il backfill delle voci dell'indice dipende dalla quantità di dati esistenti che appartengono al nuovo indice. Più sono i valori di campo che corrispondono alla definizione dell'indice, più tempo occorre per eseguire il backfill delle voci dell'indice.

Gestione delle operazioni a lunga esecuzione

Le build degli indici sono operazioni a lunga esecuzione. Le sezioni seguenti descrivono come gestire le operazioni di lunga durata per gli indici.

Dopo aver iniziato a creare un indice, Firestore con compatibilità MongoDB assegna all'operazione un nome univoco. I nomi delle operazioni sono preceduti da projects/PROJECT_ID/databases/DATABASE_ID/operations/, ad esempio:

projects/PROJECT_ID/databases/DATABASE_ID/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg

Puoi omettere il prefisso quando specifichi un nome dell'operazione per il comando describe.

Elenca 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. 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.

Per stimare l'avanzamento di un'operazione, dividi workCompleted per workEstimated.

Di seguito è riportato un esempio dell'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. Controlla il valore del campo state per il risultato dell'operazione. Se il campo done non è impostato nella risposta, l'operazione non è stata completata.