Configurazione degli indici datastore con index.yaml

Puoi utilizzare Firestore in modalità Datastore (Datastore) per archiviare i dati delle tue applicazioni eseguite nell'ambiente flessibile. Datastore utilizza gli indici per ogni query eseguita dall'applicazione. Questi indici vengono aggiornati ogni volta che un'entità cambia, quindi i risultati possono essere restituiti rapidamente quando l'app esegue una query. Per farlo, Datastore deve sapere in anticipo quali query eseguirà l'applicazione. Specifica gli indici necessari per la tua app in un file di configurazione index.yaml. Puoi utilizzare l'emulatore Datastore per generare il file automaticamente durante il test dell'app o scrivere il file autonomamente. Il file index.yaml deve essere caricato quando esegui il deployment dell'app.

Informazioni su index.yaml

Ogni query Datastore eseguita da un'applicazione richiede un indice corrispondente. Gli indici delle query semplici, come le query su una singola proprietà, vengono creati automaticamente. Gli indici delle query complesse devono essere definiti in un file di configurazione denominato index.yaml. Questo file viene caricato con l'applicazione per creare gli indici in Datastore.

Ecco un esempio di file index.yaml:

indexes:

- kind: Cat
  ancestor: no
  properties:
  - name: name
  - name: age
    direction: desc

- kind: Cat
  properties:
  - name: name
    direction: asc
  - name: whiskers
    direction: desc

- kind: Store
  ancestor: yes
  properties:
  - name: business
    direction: asc
  - name: owner
    direction: asc

La sintassi di index.yaml è il formato YAML. Per ulteriori informazioni su questa sintassi, consulta il sito web YAML.

Definizioni degli indici

index.yaml ha un singolo elemento elenco chiamato indexes. Ogni elemento nell'elenco rappresenta un indice per l'applicazione.

Un elemento indice può avere i seguenti elementi:

kind
Il tipo di entità per la query. In genere, si tratta del nome della classe Model che definisce il modello per le entità. Questo elemento è obbligatorio.
properties

Un elenco di proprietà da includere come colonne dell'indice, in ordine di ordinamento: prima le proprietà utilizzate nei filtri di uguaglianza, seguite dalla proprietà usata nei filtri di disuguaglianza, poi gli ordini e le relative indicazioni stradali.

Ogni elemento di questo elenco ha i seguenti elementi:

name
Il nome del datastore della proprietà.
direction
La direzione di ordinamento: asc per crescente o desc per decrescente. Questa proprietà è obbligatoria solo per le proprietà utilizzate in ordinamenti della query e deve corrispondere alla direzione utilizzata dalla query. Il valore predefinito è asc.
ancestor

yes se la query ha una clausola precedente (Query.ancestor() o una clausola ANCESTOR IS di GQL). Il valore predefinito è no.

Creazione di file indice

Puoi creare un file indice manualmente, utilizzando un editor di testo e seguendo il layout del file descritto sopra. Un approccio più efficiente consiste nel generare automaticamente il file durante il test locale dell'app. Puoi combinare i due metodi.

Quando esegui test nel tuo ambiente locale, puoi utilizzare il comando gcloud emulatore per avviare un servizio che emula Datastore prima di eseguire l'app:

gcloud beta emulators datastore start --data-dir DATA-DIR

Utilizza il flag --data-dir per specificare la directory in cui verrà visualizzato il file index.yaml generato automaticamente.

Quando testi l'app, ogni volta che generi una query Datastore, l'emulatore aggiunge una definizione di indice generata a index.yaml. Tutte le definizioni di indice generate automaticamente verranno visualizzate nel file sotto la seguente riga:

# AUTOGENERATED

Tutte le definizioni di indice sopra questa riga sono considerate sotto il controllo manuale e non vengono aggiornate dal server web di sviluppo. Il server web apporta modifiche solo sotto la riga e lo fa solo se il file index.yaml completo non descrive un indice che tiene conto di una query eseguita dall'applicazione. Per assumere il controllo di una definizione di indice automatica, spostala sopra questa riga.

L'emulatore potrebbe aggiornare le definizioni esistenti sotto questa riga, man mano che l'applicazione esegue le query. Se l'app genera ogni query eseguita durante il test, le voci generate in index.yaml verranno completate. Potrebbe essere necessario modificare manualmente il file per eliminare gli indici non utilizzati in produzione o definire gli indici che non sono stati creati durante il test.

Deployment del file di configurazione di indice

Per eseguire il deployment del file di configurazione index.yaml, esegui questo comando:

gcloud app deploy index.yaml

Eliminazione degli indici non utilizzati

Quando modifichi o rimuovi un indice dalla configurazione dell'indice, l'indice originale non viene eliminato automaticamente da App Engine. Questo ti offre l'opportunità di lasciare in esecuzione una versione precedente dell'app durante la creazione di nuovi indici o di ripristinare immediatamente la versione precedente se viene rilevato un problema con una versione più recente.

Quando hai la certezza che i vecchi indici non sono più necessari, puoi eliminarli da App Engine nel seguente modo:

gcloud datastore indexes cleanup index.yaml