Gestisci indici

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 per scopi di ricerca.

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

Per essere indicizzato, un campo deve essere una stringa o un array di stringhe. 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 unico 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"
    }
  ]
})

Specifica una lingua predefinita

Se vuoi, puoi anche specificare 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 della 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 utilizzando il nome in formato esteso (english) o il codice lingua ISO di due lettere (en).
• Se la lingua predefinita non viene impostata, Cloud Firestore viene impostato per impostazione predefinita sull'inglese.
• Il campo di override della lingua deve essere un campo di primo livello. Se non viene impostato, il campo di override della lingua viene impostato su language per impostazione predefinita.
• Se imposti la lingua predefinita sul carattere null, Cloud Firestore non utilizza alcun campo come override della lingua.

Partiziona 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 devi sempre filtrare un campo specifico nell'indice su cui stai eseguendo la query.

Per creare un indice con una partizione, configura il campo firestoreOptions come segue:

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 nell'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 è 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, consulta Indici e proprietà degli indici.

Console Firebase

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

   Vai a Database Firestore

2. Seleziona un database dall'elenco dei database.

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 viene creato, consulta Errori di creazione dell'indice per le possibili cause.

gcloud CLI

Per creare un indice di testo, 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_GROUP \
  --field-config=field-path=FIELD_NAME,search-config='{"text-spec": {"index-specs": [{"index-type": "tokenized", "match-type": "match-globally"}]}}' \
  --api-scope=mongodb-compatible-api \
  --search-index-options=text-language=en \
  --async

Sostituisci quanto segue:

• DATABASE_ID: un ID database.
• COLLECTION_GROUP: l'ID della raccolta da indicizzare.
• FIELD_NAME: il nome del campo da indicizzare.

Il flag --async esegue l'operazione di creazione dell'indice in background.

API MongoDB

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

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

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

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

Partiziona 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 devi sempre filtrare un campo specifico nell'indice su cui stai eseguendo la query.

Per creare un indice con una partizione, configura il campo firestoreOptions come segue:

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 l'indice ha un campo region per le località 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 query solo se è 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, consulta Indici e proprietà degli indici.

Console Firebase

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

   Vai a Database Firestore

2. Seleziona un database dall'elenco dei database.

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 viene creato, consulta Errori di creazione dell'indice per le possibili cause.

gcloud CLI

Per creare un indice 2dsphere, 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_GROUP \
  --field-config=field-path=FIELD_NAME,search-config='{"geo-spec": {}}' \
  --api-scope=mongodb-compatible-api \
  --async

Sostituisci quanto segue:

• DATABASE_ID: un ID database.
• COLLECTION_GROUP: l'ID della raccolta da indicizzare.
• FIELD_NAME: il nome del campo da indicizzare.

Il flag --async esegue l'operazione di creazione dell'indice in background.