REST Resource: projects.databases.indexes

Risorsa: indice

Una definizione di indice.

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

string

Il nome della risorsa dell'indice. Solo output.
collectionId

string

L'ID raccolta a cui si applica l'indice. Obbligatoria.
fields[]

object (IndexField)

I campi da indicizzare.
state

enum (State)

Lo stato dell'indice. Solo output.

IndexField

Un campo di un indice.

Rappresentazione JSON 
{
  "fieldPath": string,
  "mode": enum (Mode)
}
Campi
fieldPath

string

Il percorso del campo. Deve corrispondere alla specifica del percorso di campo descritta in [google.firestore.v1beta1.Document.fields][fields]. Il percorso del campo speciale __name__ può essere utilizzato da solo o alla fine di un percorso. __type__ può essere utilizzato solo alla fine del percorso.
mode

enum (Mode)

La modalità del campo.

Modalità

La modalità determina il modo in cui un campo viene indicizzato.

Enum
MODE_UNSPECIFIED La modalità non è specificata.
ASCENDING I valori del campo sono indicizzati in modo da supportare la sequenza in ordine crescente e anche eseguire query per <, >, <=, >= e =.
DESCENDING I valori del campo sono indicizzati in modo da supportare la sequenza in ordine decrescente e anche eseguire query per <, >, <=, >= e =.
ARRAY_CONTAINS I valori array del campo sono indicizzati in modo da supportare l'appartenenza utilizzando le query ARRAY_CONTAINS.

Stato

Lo stato di un indice. Durante la creazione dell'indice, un indice sarà nello stato CREATING. Se l'indice viene creato correttamente, passerà allo stato READY. Se non è possibile creare l'indice, passerà allo stato ERROR.

Enum
STATE_UNSPECIFIED Lo stato non è specificato.
CREATING L'indice è in fase di creazione. È presente un'operazione a lunga esecuzione attiva per l'indice. L'indice viene aggiornato durante la scrittura di un documento. Potrebbero esistere alcuni dati dell'indice.
READY L'indice è pronto per essere utilizzato. L'indice viene aggiornato durante la scrittura di un documento. L'indice viene compilato completamente a partire da tutti i documenti archiviati a cui si applica.
ERROR L'indice è in fase di creazione, ma si è verificato un problema. Non esiste un'operazione a lunga esecuzione attiva per l'indice e l'ultima operazione a lunga esecuzione non è riuscita. L'indice non viene aggiornato durante la scrittura di un documento. Potrebbero esistere alcuni dati dell'indice.

Metodi

create

 Crea l'indice specificato.

delete

 Elimina un indice.

get

 Recupera un indice.

list

 Elenca gli indici che corrispondono ai filtri specificati.