REST Resource: projects.databases.collectionGroups.indexes

Risorsa: indice

Gli indici di Cloud Firestore consentono di eseguire query semplici e complesse sui documenti di un database.

Rappresentazione JSON 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Campi
name

string

Solo output. Un nome definito dal server per questo indice. Il nome utilizzato per gli indici composti sarà: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Per gli indici a campo singolo, questo campo sarà vuoto.
queryScope

enum (QueryScope)

Gli indici con un ambito di query di raccolta specificato consentono di eseguire query su una raccolta che è l'elemento figlio di un documento specifico, specificato al momento della query e che ha lo stesso ID raccolta.

Gli indici con un ambito di query del gruppo di raccolte specificato consentono di eseguire query su tutte le raccolte discese da un documento specifico, specificato al momento della query e che hanno lo stesso ID raccolta di questo indice.
fields[]

object (IndexField)

I campi supportati da questo indice.

Per gli indici composti, sono sempre due o più campi. L'ultimo campo inserito si riferisce sempre al percorso del campo __name__. Se, al momento della creazione, __name__ non è stato specificato come ultimo campo, verrà aggiunto automaticamente con la stessa direzione dell'ultimo campo definito. Se il campo finale in un indice composto non è direzionale, __name__ verrà ordinato IN ordine crescente (se non diversamente specificato in modo esplicito).

Per gli indici a campo singolo, sarà sempre esattamente una voce con un percorso del campo uguale a quello del campo associato.
state

enum (State)

Solo output. Lo stato di elaborazione dell'indice.

Metodi

create

 Crea un indice composto.

delete

 Elimina un indice composto.

get

 Recupera un indice composto.

list

 Elenca gli indici composti.