Pertinente solo per la versione Enterprise di Cloud Firestore. |
Questa pagina descrive come gestire gli indici. Per saperne di più sugli indici, consulta la panoramica degli indici.
Prima di iniziare
Prima di poter creare un indice in Cloud Firestore con compatibilità MongoDB, assicurati di disporre di uno dei seguenti ruoli:
roles/datastore.owner
roles/datastore.indexAdmin
roles/editor
roles/owner
Per concedere un ruolo, vedi Concedere un singolo ruolo. Per ulteriori informazioni sui ruoli Cloud Firestore e sulle autorizzazioni associate, consulta Ruoli predefiniti.
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
Crea un indice
Per creare un indice, completa i seguenti passaggi:
API MongoDB
Utilizza il metodo createIndex()
per creare un indice. Ad esempio:
-
db.restaurants.createIndex({"cuisine" : 1})
-
db.restaurants.createIndex({"cuisine" : 1}, {sparse: true})
-
È supportata anche la creazione di indici con
db.runCommand()
, con al massimo un indice.db.runCommand({"createIndexes":"restaurant", "index": [{"key": {"cuisine":1}, {"name": "cuisine_index"}]})
Tieni presenti le seguenti limitazioni:
- Puoi creare un solo indice per richiesta.
db.collection.createIndexes()
non è supportato. - Gli audit log per la creazione di indici con l'API MongoDB utilizzano il nome del metodo
google.firestore.admin.v1.FirestoreAdmin.CreateIndex
. - Per le opzioni di indice supportate, vedi Indici e proprietà degli indici.
Console Firebase
-
Nella console Firebase, vai alla pagina Database Firestore.
- Seleziona un database dall'elenco.
- Nella scheda Indici, fai clic su Crea indice.
- Inserisci un ID raccolta.
- Aggiungi uno o più percorsi dei campi e seleziona un'opzione di indice per ciascuno.
- Seleziona un'opzione di presenza del campo, non sparsa o sparsa.
- Se vuoi, puoi impostare l'opzione Indice multikey.
- Fai clic su Crea.
- Il nuovo indice viene visualizzato nell'elenco degli indici e Cloud Firestore con compatibilità MongoDB inizia a crearlo. Una volta creato l'indice, vedrai un segno di spunta verde accanto. Se l'indice non viene creato, consulta la sezione Errori di creazione dell'indice per possibili cause.
gcloud CLI
Per creare un indice, utilizza il
comando gcloud firestore indexes composite create
. Imposta api-scope
su mongodb-compatible-api
.
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
Sostituisci quanto segue:
- DATABASE_ID: un ID database.
- COLLECTION: un nome di raccolta.
- FIELD_CONFIGURATION: una configurazione del campo. Per ogni campo,
aggiungi
--field-config=field-path=
. Ad esempio:--field-config=field-path=user-id,order=descending \ --field-config=field-path=score,order=descending
Per ulteriori informazioni sulla configurazione di questi campi, consulta
--field-config
.
Per creare un indice sparso, imposta --density=sparse-any
.
Per creare un indice multikey, aggiungi il flag --multikey
.
Per creare un indice univoco, aggiungi il flag --unique
.
Terraform
Utilizza la risorsa google_firestore_index
e imposta api_scope
su MONGODB_COMPATIBLE_API
e query_scope
su COLLECTION_GROUP
.
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" }
Sostituisci quanto segue:
- DATABASE_ID: l'ID del database scelto
- COLLECTION: Il nome della raccolta da indicizzare
- FIELD_PATH: il nome del campo da indicizzare
- ORDER: Uno tra
ASCENDING
oDESCENDING
- DENSITY: Uno tra
SPARSE_ANY
oDENSE
Eliminare un indice
Per eliminare un indice, completa i seguenti passaggi:
API MongoDB
Utilizza il metodo dropIndex()
per eliminare un indice. Ad esempio:
Eliminare un indice utilizzando il nome dell'indice
db.restaurants.dropIndex("cuisine_index")
Eliminare un indice utilizzando la definizione dell'indice
db.restaurants.dropIndex({"cuisine" : 1})
Console Firebase
-
Nella console Firebase, vai alla pagina Database Firestore.
- Seleziona un database dall'elenco.
- Fai clic sulla scheda Indici.
- Nell'elenco degli indici, scegli Elimina dal pulsante Altro per l'indice che vuoi eliminare.
- Fai clic su Elimina indice.
gcloud CLI
Per trovare il nome dell'indice, utilizza il comando
gcloud firestore indexes composite list
.gcloud firestore indexes composite list \ --database='DATABASE_ID'
Sostituisci DATABASE_ID con l'ID database.
-
Per eliminare l'indice, utilizza il comando
gcloud firestore indexes composite delete
.gcloud firestore indexes composite delete INDEX_NAME \ --database='DATABASE_ID'
Sostituisci quanto segue:
- INDEX_NAME: il nome di un indice
- DATABASE_ID: un ID database
Tempo di creazione dell'indice
Per creare un indice, Cloud Firestore con compatibilità MongoDB deve creare l'indice e poi riempire le 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 alcuni minuti, anche per un database vuoto.
Il tempo necessario per eseguire il backfill delle voci di indice dipende dalla quantità di dati esistenti che appartengono al nuovo indice. Più valori di campo corrispondono alla definizione dell'indice, più tempo è necessario 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 utilizzare le operazioni di lunga durata per gli indici.
Dopo aver iniziato a creare un indice, Cloud Firestore con compatibilità MongoDB assegna
all'operazione un nome univoco. I nomi delle operazioni hanno il prefisso 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 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
. 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
.
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
. Visualizza il valore del campo state
per
il risultato dell'operazione. Se il campo done
non è impostato nella risposta,
l'operazione non è stata completata.