Query Datastore

Una query Datastore recupera entità da Cloud Datastore che soddisfano un insieme specificato di condizioni.

Una query tipica include quanto segue:

  • Un tipo di entità a cui si applica la query
  • Filtri facoltativi basati su valori, chiavi e predecessori delle proprietà delle entità
  • (Facoltativo) Ordinare gli ordini per mettere in sequenza i risultati
Quando viene eseguita, una query recupera tutte le entità del tipo specificato che soddisfano tutti i filtri specificati, ordinate nell'ordine specificato. Le query vengono eseguite in sola lettura.

Questa pagina descrive la struttura e i tipi di query utilizzate in App Engine per recuperare dati da Cloud Datastore.

Filtri

I filtri di una query impostano vincoli per le proprietà, le chiavi e i predecessori delle entità da recuperare.

Filtri proprietà

Un filtro di proprietà specifica

  • Il nome di una proprietà
  • Un operatore di confronto
  • Il valore di una proprietà
Ad esempio:

q := datastore.NewQuery("Person").Filter("Height <=", maxHeight)

Il valore della proprietà deve essere fornito dall'applicazione e non può fare riferimento ad altre proprietà né essere calcolato. Un'entità soddisfa il filtro se ha una proprietà del nome specificato il cui valore si raffronta a quello specificato nel filtro nel modo descritto dall'operatore di confronto.

L'operatore di confronto può essere uno dei seguenti:

Operatore Significato
= Uguale a
< Minore di
<= Minore o uguale a
> Maggiore di
>= Maggiore o uguale a

Filtri principali

Per filtrare in base al valore della chiave di un'entità, utilizza la proprietà speciale __key__:

q := datastore.NewQuery("Person").Filter("__key__ >", lastSeenKey)

Quando si confrontano le disuguaglianze, le chiavi vengono ordinate in base ai seguenti criteri:

  1. Percorso predecessore
  2. Tipo di entità
  3. Identificatore (nome della chiave o ID numerico)

Gli elementi del percorso predecessore vengono confrontati in modo simile: per tipo (stringa) e poi per nome chiave o ID numerico. I tipi e i nomi delle chiavi sono stringhe ordinati per valore in byte; gli ID numerici sono numeri interi in ordine numerico. Se le entità con lo stesso tipo e padre utilizzano una combinazione di stringhe di nomi chiave e ID numerici, quelle con ID numerici precedono quelle con i nomi delle chiavi.

Le query sulle chiavi utilizzano gli indici proprio come le query sulle proprietà e richiedono indici personalizzati negli stessi casi, con un paio di eccezioni: i filtri di disuguaglianza o un ordinamento crescente sulla chiave non richiedono un indice personalizzato, a differenza di un ordinamento decrescente della chiave. Come per tutte le query, il server web di sviluppo crea le voci appropriate nel file di configurazione dell'indice quando viene testata una query che richiede un indice personalizzato.

Filtri predecessore

Puoi filtrare le query Datastore in base a un ancestor specificato in modo che i risultati restituiti includano solo le entità discendenti da tale predecessore:

q := datastore.NewQuery("Person").Ancestor(ancestorKey)

Tipi di query speciali

Alcuni tipi di query specifici meritano una menzione speciale:

Query disponibili

Una query senza tipo o senza filtro dei predecessori recupera tutte le entità di un'applicazione da Datastore. Sono incluse entità create e gestite da altre funzionalità di App Engine, ad esempio entità statistiche ed entità di metadati Blobstore (se presenti). Queste query ordinate non possono includere filtri o ordinamenti in base ai valori delle proprietà. Tuttavia, possono filtrare in base alle chiavi di entità specificando __key__ come nome della proprietà:

q := datastore.NewQuery("").Filter("__key__ >", lastSeenKey)

Query predecessori

Una query con un filtro predecessore limita i risultati all'entità specificata e ai suoi discendenti:

// Create two Photo entities in the datastore with a Person as their ancestor.
tomKey := datastore.NewKey(ctx, "Person", "Tom", 0, nil)

wPhoto := Photo{URL: "http://example.com/some/path/to/wedding_photo.jpg"}
wKey := datastore.NewKey(ctx, "Photo", "", 0, tomKey)
_, err := datastore.Put(ctx, wKey, wPhoto)
// check err

bPhoto := Photo{URL: "http://example.com/some/path/to/baby_photo.jpg"}
bKey := datastore.NewKey(ctx, "Photo", "", 0, tomKey)
_, err = datastore.Put(ctx, bKey, bPhoto)
// check err

// Now fetch all Photos that have tomKey as an ancestor.
// This will populate the photos slice with wPhoto and bPhoto.
q := datastore.NewQuery("Photo").Ancestor(tomKey)
var photos []Photo
_, err = q.GetAll(ctx, &photos)
// check err
// do something with photos

Query sui predecessori Kindless

Una query senza tipo che include un filtro dei predecessori recupererà l'antenato specificato e tutti i suoi discendenti, indipendentemente dal tipo. Questo tipo di query non richiede indici personalizzati. Come tutte le query senza tipo, non può includere filtri o ordinare ordini in base ai valori delle proprietà, ma può filtrare in base alla chiave dell'entità:

q := datastore.NewQuery("").Ancestor(ancestorKey).Filter("__key__ >", lastSeenKey)

L'esempio seguente illustra come recuperare tutte le entità discendenti da un determinato predecessore:

tomKey := datastore.NewKey(ctx, "Person", "Tom", 0, nil)

weddingPhoto := &Photo{URL: "http://example.com/some/path/to/wedding_photo.jpg"}
_, err := datastore.Put(ctx, datastore.NewIncompleteKey(ctx, "Photo", tomKey), weddingPhoto)

weddingVideo := &Video{URL: "http://example.com/some/path/to/wedding_video.avi"}
_, err = datastore.Put(ctx, datastore.NewIncompleteKey(ctx, "Video", tomKey), weddingVideo)

// The following query returns both weddingPhoto and weddingVideo,
// even though they are of different entity kinds.
q := datastore.NewQuery("").Ancestor(tomKey)
t := q.Run(ctx)
for {
	var x interface{}
	_, err := t.Next(&x)
	if err == datastore.Done {
		break
	}
	if err != nil {
		log.Errorf(ctx, "fetching next Photo/Video: %v", err)
		break
	}
	// Do something (e.g. switch on types)
	doSomething(x)
}

Query basate solo su chiavi

Una query basata solo su chiavi restituisce solo le chiavi delle entità risultato anziché le entità stesse, con una latenza e un costo inferiori rispetto al recupero di intere entità:

q := datastore.NewQuery("Person").KeysOnly()

Spesso è più economico eseguire prima una query basata solo su chiavi e poi recuperare un sottoinsieme di entità dai risultati, anziché eseguire una query generale che potrebbe recuperare più entità di quelle effettivamente necessarie.

Tieni presente che una query basata solo su chiavi può restituire più di 1000 risultati, ma GetAll può recuperare solo 1000 chiavi alla volta e restituisce un errore se viene richiamata su un risultato di dimensioni maggiori. Pertanto, consigliamo di aggiungere un limite di 1000 chiavi alla query.

Query di proiezione

A volte, l'unica cosa di cui hai bisogno dai risultati di una query sono i valori di alcune proprietà specifiche. In questi casi, puoi utilizzare una query di proiezione per recuperare solo le proprietà che ti interessano effettivamente, con latenza e costi inferiori rispetto al recupero dell'intera entità. Per i dettagli, consulta la pagina Query di proiezione.

Ordina gli ordini

Un ordinamento di query specifica

  • Il nome di una proprietà
  • Una direzione di ordinamento (crescente o decrescente)

In Go, l'ordinamento decrescente è indicato da un trattino (-) che precede il nome della proprietà; l'omissione del trattino specifica l'ordine crescente per impostazione predefinita. Ad esempio:

// Order alphabetically by last name:
q := datastore.NewQuery("Person").Order("LastName")

// Order by height, tallest to shortest:
q = datastore.NewQuery("Person").Order("-Height")

Se una query include più ordinamenti, questi vengono applicati nella sequenza specificata. Nell'esempio seguente, l'ordinamento viene ordinato prima in base al cognome crescente e poi in base all'altezza decrescente:

q := datastore.NewQuery("Person").Order("LastName").Order("-Height")

Se non vengono specificati ordini di ordinamento, i risultati vengono restituiti nell'ordine in cui sono stati recuperati da Datastore.

Nota: a causa del modo in cui Datastore esegue le query, se una query specifica filtri di disuguaglianza su una proprietà e ordini in altre proprietà, la proprietà utilizzata nei filtri di disuguaglianza deve essere ordinata prima delle altre.

Indici

Ogni query Datastore calcola i risultati utilizzando uno o più indici che contengono chiavi di entità in una sequenza specificata dalle proprietà dell'indice e, facoltativamente, dai predecessori dell'entità. Gli indici vengono aggiornati in modo incrementale per riflettere eventuali modifiche apportate dall'applicazione alle sue entità, in modo che siano disponibili i risultati corretti di tutte le query senza bisogno di ulteriori calcoli.

App Engine predefinisce un indice semplice su ogni proprietà di un'entità. Un'applicazione App Engine può definire ulteriori indici personalizzati in un file di configurazione degli indici denominato index.yaml. Il server di sviluppo aggiunge automaticamente suggerimenti a questo file quando rileva query che non possono essere eseguite con gli indici esistenti. Puoi ottimizzare gli indici manualmente modificando il file prima di caricare l'applicazione.

Esempio di interfaccia di query

L'API Go Datastore fornisce un tipo di query per la preparazione e l'esecuzione delle query.

type Person struct {
	FirstName string
	LastName  string
	City      string
	BirthYear int
	Height    int
}

func handle(w http.ResponseWriter, r *http.Request) {
	ctx := appengine.NewContext(r)

	// The Query type and its methods are used to construct a query.
	q := datastore.NewQuery("Person").
		Filter("LastName =", "Smith").
		Filter("Height <=", maxHeight).
		Order("-Height")

	// To retrieve the results,
	// you must execute the Query using its GetAll or Run methods.
	var people []Person
	if _, err := q.GetAll(ctx, &people); err != nil {
		// Handle error.
	}
	// ...
}

Che cosa succede dopo?