Gestisci indici

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.

Firebase console

1. Nella console Firebase, vai alla pagina Database Firestore.

   Vai al database Firestore

2. Seleziona un database dall'elenco.
3. Nella scheda Indici, fai clic su Crea indice.
4. Inserisci un ID raccolta.
5. Aggiungi uno o più percorsi dei campi e seleziona un'opzione di indice per ciascuno.
6. Seleziona un'opzione di presenza del campo, non sparsa o sparsa.
7. Se vuoi, puoi impostare l'opzione Indice multikey.
8. Fai clic su Crea.
9. Il nuovo indice viene visualizzato nell'elenco degli indici e Cloud Firestore 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 saperne di più 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 o DESCENDING
• DENSITY: Uno tra SPARSE_ANY o DENSE

API MongoDB

Utilizza il metodo createIndex() per creare un indice di testo. Nell'esempio seguente, quando un documento viene scritto nella raccolta cities con i campi country o food compilati, questi campi vengono indicizzati a fini di ricerca.

db.cities.createIndex({"country": "text", "food": "text"})

Un campo deve essere una stringa o un array di stringhe da indicizzare. Gli indici degli array non sono indicizzati per la ricerca. Di conseguenza, l'indicizzazione di a.1.b indicizzerà something in {a: {1: {b: something}}}, ma non in {a: [one, {b: something}]}.

Puoi anche creare indici con db.runCommand(). Puoi avere un solo indice di testo per raccolta, ma puoi creare più indici di tipi diversi in un db.runCommand(). L'esempio seguente utilizza db.runCommand() per creare un indice di testo:

db.runCommand({
  createIndexes: "cities",
  indexes: [
    {
      key: { "country": "text", "food": "text" },
      name: "country_text_food_text"
    }
  ]
})

Specificare una lingua predefinita

Puoi anche specificare facoltativamente una lingua predefinita o un percorso del campo nel documento che conterrà la lingua predefinita.

Nell'esempio seguente, myLanguageField è specificato come language_override. Quando un documento nella raccolta cities contiene un campo denominato myLanguageField, il valore di questo campo viene utilizzato per determinare la lingua per l'indicizzazione del campo country per quel documento specifico. Questo valore sostituisce la lingua predefinita di french.

db.cities.createIndex({"country": "text"}, {"default_language": "french", "language_override": "myLanguageField"})

• Puoi inserire una lingua come nome completo (english) o come codice lingua ISO di due lettere (en).
• Se la lingua predefinita non viene impostata, Cloud Firestore viene impostato per impostazione predefinita l'inglese.
• Il campo di override della lingua deve essere un campo di primo livello. Se non viene impostato, il campo di override della lingua è impostato su language per impostazione predefinita.
• Se imposti la lingua predefinita sul carattere null, Cloud Firestore non utilizza alcun campo come override della lingua.

Partizionare un indice di testo

Puoi anche partizionare l'indice utilizzando un campo in modo da poter filtrare le query in base a un valore di campo specifico. Questa configurazione ti consente di eseguire query più efficienti se hai sempre bisogno di un campo specifico filtrato nell'indice su cui stai eseguendo la query.

Per creare un indice con una partizione, configura il campo firestoreOptions nel seguente modo:

db.runCommand({
  createIndexes: "cities",
  indexes: [
    {
      key: { "country": "text", "food": "text"},
      name: "country_text_food_text"
      firestoreOptions: {"customPartitionFields": ["PARTITIONED_FIELD"]
    }
  ]
})

Dove:

• PARTITIONED_FIELD è il nome del campo utilizzato per la partizione. Questo valore deve essere una stringa e deve fare riferimento a un campo di primo livello. Quando esegui una query su un indice partizionato, puoi filtrare i risultati in base a un valore di questo campo. Ad esempio, puoi partizionare l'indice utilizzando city. Se nel tuo indice di testo è definito un campo city, gli utenti possono eseguire query su una città specifica.

  La partizione deve essere un solo campo. Se partizioni un indice, puoi eseguire solo query in cui viene specificato il campo partizionato.

Limitazioni

• Puoi creare un solo indice per richiesta.
• 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à dell'indice.

Firebase console

1. Nella console Firebase, vai alla pagina Firestore Database.

   Vai al database Firestore

2. Seleziona un database dall'elenco.

3. Nella scheda Indici, fai clic su Crea indice.

4. Inserisci un ID raccolta.

5. Aggiungi uno o più percorsi dei campi e seleziona un'opzione di indice per ciascuno.

6. Fai clic su Crea.

7. Il nuovo indice viene visualizzato nell'elenco degli indici e le operazioni compatibili con MongoDB iniziano a creare l'indice. Una volta creato l'indice, vedrai un segno di spunta verde accanto. Se l'indice non è stato creato, consulta la sezione Errori di creazione dell'indice per possibili cause.

API MongoDB

Utilizza il metodo createIndex() per creare un indice. Ad esempio:

db.restaurants.createIndex({"location" : "2dsphere", "region": "2dsphere"})

È supportata anche la creazione di indici con db.runCommand() con al massimo un indice:

db.runCommand({
  createIndexes: "restaurants",
  indexes: [
    {
      key: { "location": "2dsphere", "region": "2dsphere" },
      name: "location_2dsphere_region_2dsphere"
    }
  ]
})

Partizionare un indice 2dsphere

Puoi anche partizionare l'indice utilizzando un campo in modo da poter filtrare le query in base a un valore di campo specifico. Questa configurazione ti consente di eseguire query più efficienti se hai sempre bisogno di un campo specifico filtrato nell'indice su cui stai eseguendo la query.

Per creare un indice con una partizione, configura il campo firestoreOptions nel seguente modo:

db.runCommand({
  createIndexes: "restaurants",
  indexes: [
    {
      key: { "location": "2dsphere", "region": "2dsphere" },
      name: "location_2dsphere_region_2dsphere"
      firestoreOptions: {"customPartitionFields": ["PARTITIONED_FIELD"]
    }
  ]
})

Dove:

• PARTITIONED_FIELD è il nome del campo utilizzato per la partizione. Quando esegui una query su un indice partizionato, puoi filtrare i risultati in base a un valore di questo campo. Ad esempio, se il tuo indice ha un campo region per le sedi regionali, puoi partizionare l'indice utilizzando region in modo che gli utenti possano eseguire query sui ristoranti nella loro regione.

  Se partizioni un indice, puoi eseguire solo query in cui viene specificato il campo partizionato.

Limitazioni

• Puoi creare un solo indice per richiesta.
• 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à dell'indice.

Firebase console

1. Nella console Firebase, vai alla pagina Firestore Database.

   Vai al database Firestore

2. Seleziona un database dall'elenco.

3. Nella scheda Indici, fai clic su Crea indice.

4. Inserisci un ID raccolta.

5. Aggiungi uno o più percorsi dei campi e seleziona un'opzione di indice per ciascuno.

6. Fai clic su Crea.

7. Il nuovo indice viene visualizzato nell'elenco degli indici e le operazioni compatibili con MongoDB iniziano a creare l'indice. Una volta creato l'indice, vedrai un segno di spunta verde accanto. Se l'indice non è stato creato, consulta la sezione Errori di creazione dell'indice per possibili cause.

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})

Firebase console

1. Nella console Firebase, vai alla pagina Database Firestore.

   Vai al database Firestore

2. Seleziona un database dall'elenco.
3. Fai clic sulla scheda Indici.
4. Nell'elenco degli indici, scegli Elimina dal pulsante Altro more_vert per l'indice che vuoi eliminare.
5. Fai clic su Elimina indice.

gcloud CLI

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

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