Tipi di indice in Cloud Firestore

Gli indici sono un fattore importante per le prestazioni di un database. Come l'indice di un libro che mappa gli argomenti ai numeri di pagina, un indice di database mappa gli elementi di un database alle relative posizioni. Quando esegui una query su un database, il database può utilizzare un indice per identificare rapidamente le posizioni degli elementi richiesti.

In questa pagina vengono descritti i due tipi di indici utilizzati da Cloud Firestore: indici a campo singolo e indici composti.

Definizione e struttura dell'indice

Un indice è definito in un elenco di campi di un determinato documento, con una corrispondente modalità di indice per ogni campo.

Un indice contiene una voce per ogni campo denominato nella definizione dell'indice. L' indice include tutti i documenti che sono i potenziali risultati delle query basate sull' indice. Un documento viene incluso nell'indice solo se ha un valore indicizzato impostato per ogni campo utilizzato nell'indice. Se la definizione dell'indice fa riferimento a un campo per il quale non è stato impostato alcun valore nel documento, il documento non verrà visualizzato nell'indice. In questo caso, il documento non verrà mai restituito come risultato di alcuna query basata sull'indice.

L'indice composto è ordinato in base ai valori dei campi, nell'ordine specificato nella definizione dell'indice.

Un indice dietro ogni query

Se non esiste un indice per una query, la maggior parte dei database esegue la scansione dei contenuti elemento per elemento, un processo lento che rallenta ulteriormente con la crescita del database. Cloud Firestore garantisce un'elevata velocità di esecuzione delle query utilizzando gli indici per tutte le query. Di conseguenza, le prestazioni delle query dipendono dalle dimensioni del set di risultati e non dal numero di elementi nel database.

Meno gestione degli indici, più sviluppo di app

Cloud Firestore include funzionalità che riducono il tempo necessario per la gestione dell'indice. Gli indici richiesti per le query più di base vengono creati automaticamente. Mentre usi e testi la tua app, Cloud Firestore ti aiuta a identificare e creare indici aggiuntivi necessari per la tua app.

Tipi di indice

Cloud Firestore utilizza due tipi di indici: a campo singolo e composti. Oltre al numero di campi indicizzati, gli indici a campo singolo e gli indici composti differiscono per il modo in cui vengono gestiti.

Indici a campo singolo

Un indice a campo singolo archivia una mappatura ordinata di tutti i documenti di una raccolta che contengono un campo specifico. Ogni voce di un indice a campo singolo registra il valore di un documento per un campo specifico e la posizione del documento nel database. Cloud Firestore utilizza questi indici per eseguire molte query di base. Gestisci gli indici a campo singolo configurando le impostazioni di indicizzazione automatica e le esenzioni dell'indice del database.

Indicizzazione automatica

Per impostazione predefinita, Cloud Firestore gestisce automaticamente gli indici a campo singolo per ogni campo di un documento e per ogni sottocampo di una mappa. Cloud Firestore utilizza le seguenti impostazioni predefinite per gli indici a campo singolo:

• Per ogni campo non array e non mappa, Cloud Firestore definisce due indici a campo singolo a livello di raccolta, uno in modalità crescente e uno in modalità decrescente.

• Per ogni campo mappa, Cloud Firestore crea quanto segue:

  • Un indice crescente a livello di raccolta per ogni sottocampo non array e non mappa.
  • Un indice decrescente a livello di raccolta per ogni sottocampo non array e non mappa.
  • Un indice array-contains a livello di raccolta per ogni sottocampo dell'array.
  • Cloud Firestore indicizza in modo ricorsivo ogni sottocampo della mappa.

• Per ogni campo array in un documento, Cloud Firestore crea e gestisce un indice contiene array a livello di raccolta.

• Gli indici a campo singolo con ambito del gruppo di raccolte non vengono gestiti per impostazione predefinita.

Esenzioni dell'indice a campo singolo

Puoi esentare un campo dalle impostazioni di indicizzazione automatica creando un'esenzione per un indice a campo singolo. Un'esenzione dell'indicizzazione esegue l'override delle impostazioni dell'indice automatico a livello di database. Un'esenzione può abilitare un indice a campo singolo che altrimenti verrebbe disabilitato dalle impostazioni dell'indicizzazione automatica oppure può disabilitare un indice a campo singolo che altrimenti verrebbe abilitato dall'indicizzazione automatica. Per i casi in cui le esenzioni possono essere utili, consulta le best practice per l'indicizzazione.

Utilizza il valore del percorso del campo * per aggiungere esenzioni dall'indice a livello di raccolta a tutti i campi di un gruppo di raccolte. Ad esempio, per il gruppo di raccolte comments, imposta il percorso del campo su * per trovare una corrispondenza in tutti i campi del gruppo di raccolte comments e disattiva l'indicizzazione di tutti i campi nel gruppo di raccolte. Puoi quindi aggiungere esenzioni per indicizzare solo i campi richiesti per le query. La riduzione del numero di campi indicizzati riduce i costi di archiviazione e può migliorare le prestazioni di scrittura.

Se crei un'esenzione dell'indice a campo singolo per un campo mappa, i campi secondari della mappa erediteranno queste impostazioni. Tuttavia, puoi definire esenzioni per gli indici a campo singolo per sottocampi specifici. Se elimini un'esenzione per un sottocampo, il sottocampo erediterà le impostazioni di esenzione del campo principale, se esistenti, o le impostazioni a livello di database se non esistono esenzioni principali.

Per creare e gestire le esenzioni dell'indice a campo singolo, consulta Gestire gli indici.

Indici composti

Un indice composto archivia un mapping ordinato di tutti i documenti di una raccolta, in base a un elenco ordinato di campi da indicizzare.

Cloud Firestore utilizza gli indici composti per supportare le query non già supportate dagli indici a campo singolo.

Cloud Firestore non crea automaticamente indici composti come avviene per gli indici a un campo a causa del numero elevato di possibili combinazioni di campi. Cloud Firestore ti aiuta invece a identificare e creare gli indici composti richiesti durante la creazione dell'app.

Ogni volta che provi a eseguire una query non supportata da un indice, Cloud Firestore restituisce un messaggio di errore con un link che puoi seguire per creare l'indice mancante.

Puoi anche definire e gestire manualmente gli indici compositi utilizzando la console o l'interfaccia a riga di comando di Firebase. Per scoprire di più sulla creazione e sulla gestione degli indici compositi, consulta Gestire gli indici.

Modalità di indicizzazione e ambiti di query

Gli indici a campo singolo e composti vengono configurati in modo diverso, ma entrambi richiedono la configurazione delle modalità di indice e degli ambiti di query per gli indici.

Modalità di indicizzazione

Quando definisci un indice, selezioni una modalità di indice per ogni campo indicizzato. La modalità di indice di ogni campo supporta clausole di query specifiche per quel campo. Puoi scegliere tra le seguenti modalità di indice:

Ambiti di query

Ogni indice è limitato a una raccolta o a un gruppo di raccolte. Questo è noto come ambito di query dell'indice:

Ambito della raccolta

Cloud Firestore crea indici con ambito della raccolta per impostazione predefinita. Questi indici supportano le query che restituiscono risultati da una singola raccolta.

Ambito del gruppo di raccolte

Un gruppo di raccolte include tutte le raccolte con lo stesso ID raccolta. Per eseguire una query sul gruppo di raccolte che restituisce risultati filtrati o ordinati da un gruppo di raccolte, devi creare un indice corrispondente con ambito del gruppo di raccolte.

Ordine predefinito e campo __name__

Oltre a ordinare i documenti in base alle modalità di indice specificate per ogni campo (crescente o decrescente) , gli indici applicano un ordinamento finale in base al campo __name__ di ogni documento. Il valore del campo __name__ è impostato sul percorso completo del documento. Ciò significa che i documenti nel set di risultati con gli stessi valori di campo sono ordinati in base al percorso del documento.

Per impostazione predefinita, il campo __name__ viene ordinato nella stessa direzione dell'ultimo campo ordinato nella definizione dell'indice. Ad esempio:

Per ordinare i risultati in base alla direzione __name__ non predefinita, devi creare questo indice.

Proprietà dell'indice

Un indice che consente di eseguire la query in modo più efficiente è definito dalle seguenti proprietà:

• Campi utilizzati nei filtri di uguaglianza
• Campi utilizzati negli ordini di ordinamento
• Campi utilizzati nei filtri di intervallo e di disuguaglianza (non ancora inclusi negli ordini di ordinamento)
• Campi utilizzati nelle aggregazioni (che non sono già inclusi negli ordini di ordinamento e nei filtri di intervallo e disuguaglianza)

Cloud Firestore calcola i risultati delle query come segue:

1. Identifica l'indice corrispondente alla raccolta, alle proprietà di filtro, agli operatori di filtro e agli ordini di ordinamento della query.
2. Identifica la posizione dell'indice da cui inizia la scansione. La posizione iniziale è preceduta dai filtri di uguaglianza della query e termina con i filtri di intervallo e di disuguaglianza nel primo campo orderBy.
3. Inizia a eseguire la scansione dell'indice, restituendo ogni documento che soddisfa tutti i filtri, finché il processo di scansione non esegue una delle seguenti operazioni:
   • Rileva un documento che non soddisfa le condizioni del filtro e conferma che nessun documento successivo soddisferà mai completamente le condizioni del filtro.
   • Raggiunge la fine dell'indice.
   • Raccoglie il numero massimo di risultati richiesti dalla query.

Esempio di indicizzazione

Creando automaticamente indici a campo singolo, Cloud Firestore consente alla tua applicazione di supportare rapidamente le query di database più semplici. Gli indici a campo singolo ti consentono di eseguire query semplici in base ai valori di campo e ai comparatori <, <=, ==, >=, > e in. Per i campi array, ti consentono di eseguire query array-contains e array-contains-any.

Per fare un esempio, esamina i seguenti esempi dal punto di vista della creazione dell'indice. Il seguente snippet crea alcuni documenti city in una raccolta cities e imposta i campi name, state, country, capital, population e tags per ogni documento:

var citiesRef = db.collection("cities");

citiesRef.doc("SF").set({
    name: "San Francisco", state: "CA", country: "USA",
    capital: false, population: 860000,
    regions: ["west_coast", "norcal"] });
citiesRef.doc("LA").set({
    name: "Los Angeles", state: "CA", country: "USA",
    capital: false, population: 3900000,
    regions: ["west_coast", "socal"] });
citiesRef.doc("DC").set({
    name: "Washington, D.C.", state: null, country: "USA",
    capital: true, population: 680000,
    regions: ["east_coast"] });
citiesRef.doc("TOK").set({
    name: "Tokyo", state: null, country: "Japan",
    capital: true, population: 9000000,
    regions: ["kanto", "honshu"] });
citiesRef.doc("BJ").set({
    name: "Beijing", state: null, country: "China",
    capital: true, population: 21500000,
    regions: ["jingjinji", "hebei"] });
test.firestore.js

Supponendo che le impostazioni di indicizzazione automatica predefinite siano attive, Cloud Firestore aggiorna un indice a campo singolo crescente per ogni campo non array, un indice a campo singolo decrescente per ogni campo non array e un indice a campo singolo contenente array per il campo array. Ogni riga della tabella seguente rappresenta una voce in un indice a un campo:

Query supportate dagli indici a campo singolo

Utilizzando questi indici a un campo creati automaticamente, puoi eseguire query semplici come la seguente:

const stateQuery = citiesRef.where("state", "==", "CA");
const populationQuery = citiesRef.where("population", "<", 100000);
const nameQuery = citiesRef.where("name", ">=", "San Francisco");
test.firestore.js

Puoi anche creare query di uguaglianza composta (==) e in:

citiesRef.where('country', 'in', ["USA", "Japan", "China"])

// Compound equality queries
citiesRef.where("state", "==", "CO").where("name", "==", "Denver")
citiesRef.where("country", "==", "USA")
         .where("capital", "==", false)
         .where("state", "==", "CA")
         .where("population", "==", 860000)

Se devi eseguire una query composta che utilizza un confronto di intervalli (<, <=, > o >=) o se devi ordinare in base a un campo diverso, devi creare un indice composito per quella query.

L'indice array-contains ti consente di eseguire query sul campo dell'array regions:

citiesRef.where("regions", "array-contains", "west_coast")
// array-contains-any and array-contains use the same indexes
citiesRef.where("regions", "array-contains-any", ["west_coast", "east_coast"])

Query supportate dagli indici composti

Cloud Firestore utilizza gli indici composti per supportare le query composte non ancora supportate dagli indici a campo singolo. Ad esempio, avresti bisogno di un indice composto per le seguenti query:

citiesRef.where("country", "==", "USA").orderBy("population", "asc")
citiesRef.where("country", "==", "USA").where("population", "<", 3800000)
citiesRef.where("country", "==", "USA").where("population", ">", 690000)
// in and == clauses use the same index
citiesRef.where("country", "in", ["USA", "Japan", "China"])
         .where("population", ">", 690000)

Queste query richiedono l'indice composto riportato di seguito. Poiché la query utilizza un'uguaglianza (== o in) per il campo country, puoi utilizzare una modalità di indice crescente o decrescente per questo campo. Per impostazione predefinita, le clausole di disuguaglianza applicano un ordinamento crescente in base al campo nella clausola di disuguaglianza.

Per eseguire le stesse query, ma con un ordinamento decrescente, hai bisogno di un indice composito aggiuntivo in ordine decrescente per population:

citiesRef.where("country", "==", "USA").orderBy("population", "desc")

citiesRef.where("country", "==", "USA")
         .where("population", "<", 3800000)
         .orderBy("population", "desc")

citiesRef.where("country", "==", "USA")
         .where("population", ">", 690000)
         .orderBy("population", "desc")

citiesRef.where("country", "in", ["USA", "Japan", "China"])
         .where("population", ">", 690000)
         .orderBy("population", "desc")

Per evitare la perdita di prestazioni causata dall'unione di indici, ti consigliamo di creare un indice composito per combinare una query array-contains o array-contains-any con clausole aggiuntive:

citiesRef.where("regions", "array-contains", "east_coast")
         .where("capital", "==", true)

// array-contains-any and array-contains use the same index
citiesRef.where("regions", "array-contains-any", ["west_coast", "east_coast"])
         .where("capital", "==", true)

Query supportate dagli indici dei gruppi di raccolte

Per dimostrare un indice con ambito del gruppo di raccolte, aggiungi una landmarks sottoraccolta ad alcuni dei documenti city:

var citiesRef = db.collection("cities");

citiesRef.doc("SF").collection("landmarks").doc().set({
    name: "Golden Gate Bridge",
    category : "bridge" });
citiesRef.doc("SF").collection("landmarks").doc().set({
    name: "Golden Gate Park",
    category : "park" });

citiesRef.doc("DC").collection("landmarks").doc().set({
    name: "National Gallery of Art",
    category : "museum" });
citiesRef.doc("DC").collection("landmarks").doc().set({
    name: "National Mall",
    category : "park" });

Utilizzando il seguente indice a campo singolo con ambito della raccolta, puoi eseguire query sulla raccolta landmarks di una singola città in base al campo category:

citiesRef.doc("SF").collection("landmarks").where("category", "==", "park")
citiesRef.doc("SF").collection("landmarks").where("category", "in", ["park", "museum"])

Ad esempio, se ti interessa eseguire query sui punti di riferimento di tutte le città, esegui questa query sul gruppo di raccolte costituito da tutte le raccolte landmarks. Devi anche attivare un landmarks indice a campo singolo con ambito del gruppo di raccolte:

Con questo indice attivato, puoi eseguire query sul gruppo di raccolte landmarks:

var landmarksGroupRef = db.collectionGroup("landmarks");

landmarksGroupRef.where("category", "==", "park")
landmarksGroupRef.where("category", "in", ["park", "museum"])

Per eseguire una query sul gruppo di raccolte che restituisce risultati filtrati o ordinati, devi attivare un indice composito o a campo singolo corrispondente con ambito del gruppo di raccolte. Tuttavia, le query sui gruppi di raccolte che non filtrano o ordinano i risultati non richiedono definizioni di indici aggiuntive.

Ad esempio, puoi eseguire la seguente query sul gruppo di raccolte senza attivare un indice aggiuntivo:

db.collectionGroup("landmarks").get()

Voci dell'indice

Gli indici configurati del progetto e la struttura di un documento determinano il numero di voci di indice per un documento. Le voci di indice concorrono al raggiungimento del limite di voci di indice.

L'esempio seguente mostra le voci di indice di un documento.

Documento

/cities/SF

city_name : "San Francisco"
temperatures : {summer: 67, winter: 55}
neighborhoods : ["Mission", "Downtown", "Marina"]

Indici a campo singolo

• city_name ASC
• city_name DESC
• temperatures.summer ASC
• temperatures.summer DESC
• temperatures.winter ASC
• temperatures.winter DESC
• Array contiene quartieri (ASC e DESC)

Indici composti

• city_name ASC, ARRAY di quartieri
• city_name DESC, neighborhoods ARRAY

Voci dell'indice

Questa configurazione dell'indicizzazione genera le seguenti voci dell'indice per il documento:

Indici e prezzi

Gli indici contribuiscono ai costi di archiviazione della tua applicazione. Per ulteriori informazioni su come calcolare le dimensioni dello spazio di archiviazione per gli indici, consulta Dimensioni delle voci di indice.

Utilizzare l'unione degli indici

Sebbene Cloud Firestore utilizzi un indice per ogni query, non richiede necessariamente un indice per query. Per le query con più clausole di uguaglianza (==) e, facoltativamente, una clausola orderBy, Cloud Firestore può riutilizzare gli indici esistenti. Cloud Firestore può unire gli indici per i filtri di uguaglianza semplici per creare gli indici composti necessari per query di uguaglianza più grandi.

Puoi ridurre i costi di indicizzazione identificando le situazioni in cui puoi utilizzare l'unione di indici. Ad esempio, in una raccolta restaurants per un'app di valutazione dei ristoranti:

• collections_bookmark ristoranti

  • class burgerthyme

    name : "Burger Thyme"
category : "burgers"
city : "San Francisco"
editors_pick : true
star_rating : 4
    

Questa app utilizza query come la seguente. L'app utilizza combinazioni di clausole di uguaglianza per category, city e editors_pick, ordina sempre in ordine crescente per star_rating:

db.collection("restaurants").where("category", "==", "burgers")
                            .orderBy("star_rating")

db.collection("restaurants").where("city", "==", "San Francisco")
                            .orderBy("star_rating")

db.collection("restaurants").where("category", "==", "burgers")
                            .where("city", "==", "San Francisco")
                            .orderBy("star_rating")

db.collection("restaurants").where("category", "==", "burgers")
                            .where("city", "==" "San Francisco")
                            .where("editors_pick", "==", true )
                            .orderBy("star_rating")

Puoi creare un indice per ogni query:

Come soluzione migliore, puoi ridurre il numero di indici sfruttando la capacità di Cloud Firestore di unire gli indici per le clausole di uguaglianza:

Questo insieme di indici non è solo più piccolo, ma supporta anche un'altra query:

db.collection("restaurants").where("editors_pick", "==", true)
                            .orderBy("star_rating")

Limiti di indicizzazione

Ai seguenti limiti si applicano gli indici. Per ulteriori informazioni su quote e limiti, consulta Quote e limiti.

Best practice per l'indicizzazione

Per la maggior parte delle app, puoi fare affidamento sull'indicizzazione automatica e sui link dei messaggi di errore per gestire gli indici. Tuttavia, ti consigliamo di aggiungere eccezioni per un singolo campo nei seguenti casi:

Se utilizzi query con operatori di intervallo e di disuguaglianza su più campi, consulta le considerazioni sull'indicizzazione da tenere presenti per ottimizzare il rendimento e il costo delle query Cloud Firestore.

Per ulteriori informazioni su come risolvere i problemi di indicizzazione (fanout dell'indice, errori INVALID_ARGUMENT), consulta la pagina sulla risoluzione dei problemi.