Entità, proprietà e chiavi

Nota: gli sviluppatori che creano nuove applicazioni sono vivamente incoraggiati a utilizzare la libreria client NDB, che offre diversi vantaggi rispetto a questa libreria client, ad esempio la memorizzazione nella cache automatica delle entità tramite l'API Memcache. Se al momento utilizzi la libreria client DB precedente, leggi la guida alla migrazione da DB a NDB

Gli oggetti dati in Datastore sono noti come entità. Un'entità ha una o più proprietà denominate, ciascuna delle quali può avere uno o più valori. Le entità dello stesso tipo non devono avere le stesse proprietà e i valori di un'entità per una determinata proprietà non devono necessariamente essere dello stesso tipo di dati. Se necessario, un'applicazione può stabilire e applicare queste limitazioni nel proprio modello dei dati.

Datastore supporta diversi tipi di dati per i valori delle proprietà. tra cui, a titolo esemplificativo:

• Numeri interi
• Numeri in virgola mobile
• Stringhe
• Date
• Dati binari

Per un elenco completo dei tipi, consulta Proprietà e tipi di valori.

Ogni entità in Datastore ha una chiave che la identifica in modo univoco. La chiave è composta dai seguenti componenti:

• Lo spazio dei nomi dell'entità, che consente il multitenancy
• Il tipo dell'entità, che la classifica ai fini delle query di Datastore
• Un identificatore per la singola entità, che può essere:
  • una stringa del nome della chiave
  • un ID numerico intero
• Un percorso dell'antenato facoltativo che individua l'entità all'interno della gerarchia di Datastore

Non assegnare a una proprietà il nome "chiave". Questo nome è riservato per una proprietà speciale utilizzata per memorizzare la chiave del modello. Anche se potrebbe funzionare localmente, una proprietà denominata "key" impedirà il deployment in App Engine.

Un'applicazione può recuperare una singola entità da Datastore utilizzando la relativa chiave oppure può recuperare una o più entità emettendo una query in base alle chiavi o ai valori delle proprietà delle entità.

L'SDK App Engine per Python include una libreria di modellazione dei dati per rappresentare le entità Datastore come istanze di classi Python e per archiviare e recuperare queste istanze in Datastore.

Datastore stesso non applica alcuna restrizione alla struttura delle entità, ad esempio se una determinata proprietà ha un valore di un determinato tipo; questa attività è lasciata all'applicazione e alla libreria di modellazione dei dati.

Tipi e identificatori

Ogni entità di Datastore è di un determinato tipo,che la classifica ai fini delle query: ad esempio, un'applicazione per le risorse umane potrebbe rappresentare ogni dipendente di un'azienda con un'entità di tipo Employee. Nell'API Datastore per Python, il tipo di un'entità è determinato dalla relativa classe del modello, che definisci nella tua applicazione come sottoclasse della classe della libreria di modellazione dei dati db.Model. Il nome della classe del modello diventa il tipo di entità che gli appartengono. Tutti i nomi di tipo che iniziano con due trattini bassi (__) sono riservati e non possono essere utilizzati.

L'esempio seguente crea un'entità di tipo Employee, compila i valori delle proprietà e la salva in Datastore:

import datetime
from google.appengine.ext import db


class Employee(db.Model):
  first_name = db.StringProperty()
  last_name = db.StringProperty()
  hire_date = db.DateProperty()
  attended_hr_training = db.BooleanProperty()


employee = Employee(first_name='Antonio',
                    last_name='Salieri')

employee.hire_date = datetime.datetime.now().date()
employee.attended_hr_training = True

employee.put()

La classe Employee dichiara quattro proprietà per il modello dei dati: first_name, last_name, hire_date e attended_hr_training. La superclasse Model garantisce che gli attributi degli oggetti Employee siano conformi a questo modello: ad esempio, un tentativo di assegnare un valore di stringa all'attributo hire_date causerebbe un errore di runtime, poiché il modello dei dati per hire_date è stato dichiarato come db.DateProperty.

Oltre a un tipo, ogni entità ha un identificatore, assegnato al momento della creazione. Poiché fa parte della chiave dell'entità, l'identificatore è associato in modo permanente all'entità e non può essere modificato. Può essere assegnata in due modi:

• L'applicazione può specificare la propria stringa nome chiave per l'entità.
• Puoi chiedere a Datastore di assegnare automaticamente all'entità un ID numerico intero.

Per assegnare a un'entità un nome della chiave, fornisci l'argomento denominato key_name al costruttore della classe del modello quando crei l'entità:

# Create an entity with the key Employee:'asalieri'.
employee = Employee(key_name='asalieri')

Nota:

• I nomi delle chiavi non possono iniziare e terminare con due trattini bassi (__*__)
• Oltre ad argomenti come key_name, il costruttore Model accetta valori iniziali per le proprietà come argomenti delle parole chiave. Di conseguenza, non è consigliabile avere una proprietà denominata key_name.

Per ulteriori informazioni, consulta Nomi proprietà non consentiti.

Per fare in modo che Datastore assegni automaticamente un ID numerico, ometti l'argomento key_name:

# Create an entity with a key such as Employee:8261.
employee = Employee()

Assegnazione degli identificatori

Datastore può essere configurato per generare ID automatici utilizzando due diversi criteri di ID automatico:

• Il criterio default genera una sequenza casuale di ID inutilizzati distribuiti in modo approssimativamente uniforme. Ogni ID può essere composto da un massimo di 16 cifre decimali.
• Il criterio legacy crea una sequenza di ID interi più piccoli non consecutivi.

Se vuoi mostrare all'utente gli ID entità e/o dipendere dal loro ordine, ti consigliamo di utilizzare l'allocazione manuale.

Nota: anziché utilizzare stringhe di nomi di chiavi o generare automaticamente ID numerici, a volte le applicazioni avanzate potrebbero voler assegnare manualmente i propri ID numerici alle entità che creano. Tieni presente, tuttavia, che non c'è nulla che impedisca a Datastore di assegnare uno dei tuoi ID numerici manuali a un'altra entità. L'unico modo per evitare questi conflitti è fare in modo che l'applicazione ottenga un blocco di ID con i metodi allocate_ids() o allocate_ids_async(). Il generatore di ID automatico di Datastore tiene traccia degli ID allocati con questi metodi ed evita di riutilizzarli per un'altra entità, in modo da poterli utilizzare in sicurezza senza conflitti.

Datastore genera una sequenza casuale di ID inutilizzati distribuiti in modo approssimativamente uniforme. Ogni ID può essere composto da un massimo di 16 cifre decimali.

Percorsi degli antenati

Le entità in Cloud Datastore formano uno spazio strutturato gerarchicamente simile alla struttura di directory di un file system. Quando crei un'entità, puoi optionally designare un'altra entità come principale; la nuova entità è secondaria dell'entità padre (tieni presente che, a differenza di un file system, l'entità principale non deve necessariamente esistere). Un'entità senza un elemento principale è un'entità radice. L'associazione tra un'entità e la relativa entità principale è permanente e non può essere modificata dopo la creazione dell'entità. Cloud Datastore non assegnerà mai lo stesso ID numerico a due entità con lo stesso elemento principale o a due entità principali (quelle senza un elemento principale).

L'entità principale, l'entità principale dell'entità principale e così via in modo ricorsivo sono i suoi antenati; le sue entità figlio, le entità figlio delle entità figlio e così via sono i suoi discendenti. Un'entità base e tutti i suoi discendenti appartengono allo stesso gruppo di entità. La sequenza di entità che inizia con un'entità principale e procede da una entità principale a una secondaria, fino a una determinata entità, costituisce il percorso degli antenati di quell'entità. La chiave completa che identifica l'entità è costituita da una sequenza di coppie di tipo-identificatore che specificano il percorso dell'antenato e termina con quelli dell'entità stessa:

[Person:GreatGrandpa, Person:Grandpa, Person:Dad, Person:Me]

Per unentità base, il percorso dell'antenato è vuoto e la chiave è costituita unicamente dal tipo e dall'identificatore dell'entità:

[Person:GreatGrandpa]

Questo concetto è illustrato dal seguente diagramma:

Per designare l'entità principale di un'entità, utilizza l'argomento parent per il costruttore della classe del modello durante la creazione dell'entità secondaria. Il valore di questo argomento può essere l'entità padre stessa o la relativa chiave. Puoi ottenere la chiave chiamando il metodo key() dell'entità padre. L'esempio seguente crea un'entità di tipo Address e mostra due modi per designare un'entità Employee come principale:

# Create Employee entity
employee = Employee()
employee.put()

# Set Employee as Address entity's parent directly...
address = Address(parent=employee)

# ...or using its key
e_key = employee.key()
address = Address(parent=e_key)

# Save Address entity to datastore
address.put()

Transazioni e gruppi di entità

Ogni tentativo di creare, aggiornare o eliminare un'entità avviene nel contesto di una transazione. Una singola transazione può includere un numero qualsiasi di queste operazioni. Per mantenere la coerenza dei dati, la transazione garantisce che tutte le operazioni in essa contenute vengano applicate a Datastore come un'unità o, se una delle operazioni non va a buon fine, che nessuna venga applicata. Inoltre, tutte le letture fortemente coerenti (query o get di antenati) eseguite all'interno della stessa transazione osservano un'istantanea coerente dei dati.

Nota: se l'applicazione riceve un'eccezione durante il tentativo di commit di una transazione, non significa necessariamente che la transazione non sia riuscita. È possibile ricevere un'eccezione Timeout, TransactionFailedError o InternalError anche quando una transazione è stata eseguita e verrà applicata correttamente. Se possibile, struttura le transazioni del datastore in modo che il risultato finale non venga modificato se la stessa transazione viene applicata più volte.

Come accennato sopra, un gruppo di entità è un insieme di entità collegate tramite l'ascendenza a un elemento principale comune. L'organizzazione dei dati in gruppi di entità può limitare le transazioni che possono essere eseguite:

• Tutti i dati a cui accede una transazione devono essere contenuti in massimo 25 gruppi di entità.
• Se vuoi utilizzare le query all'interno di una transazione, i dati devono essere organizzati in gruppi di entità in modo da poter specificare filtri di antenato che corrispondano ai dati corretti.
• Esiste un limite di velocità effettiva di scrittura di circa una transazione al secondo all'interno di un singolo gruppo di entità. Questa limitazione esiste perché Datastore esegue la replica sincrona senza master di ogni gruppo di entità su un'ampia area geografica per garantire elevata affidabilità e tolleranza di errori.

In molte applicazioni, è accettabile utilizzare la coerenza finale (ovvero una query non principale che include più gruppi di entità, che a volte può restituire dati leggermente obsoleti) per ottenere una visione ampia di dati non correlati e poi utilizzare la elevata coerenza (una query da predecessore o un get di una singola entità) per visualizzare o modificare un singolo insieme di dati altamente correlati. In queste applicazioni, in genere è consigliabile utilizzare un gruppo di entità distinto per ogni insieme di dati altamente correlati. Per ulteriori informazioni, consulta la sezione Strutturare i dati per una coerenza elevata.

Nota: evita di memorizzare informazioni sensibili nella chiave del gruppo di entità. Le chiavi del gruppo di entità possono essere conservate dopo l'eliminazione del gruppo di entità per fornire un servizio rapido e affidabile in Datastore.

Proprietà e tipi di valore

I valori dei dati associati a un'entità sono costituiti da una o più proprietà. Ogni proprietà ha un nome e uno o più valori. Una proprietà può avere valori di più di un tipo e due entità possono avere valori di tipi diversi per la stessa proprietà. Le proprietà possono essere indicizzate o non indicizzate (le query che ordinano o filtrano in base a una proprietà P ignorano le entità in cui P non è indicizzata). Un'entità può avere al massimo 20.000 proprietà indicizzate.

Nota: le proprietà con più valori possono essere utili, ad esempio, quando esegui query con filtri di uguaglianza: un'entità soddisfa la query se uno dei suoi valori per una proprietà corrisponde al valore specificato nel filtro. Per ulteriori dettagli sulle proprietà con più valori, inclusi i problemi da tenere presenti, consulta la pagina Query Datastore.

Sono supportati i seguenti tipi di valori:

Tipo di valore	Tipi di Python	Ordinamento	Note
Numero intero	int long	Numerico	Numero intero a 64 bit con segno
Numero in virgola mobile	float	Numerico	Precisione doppia a 64 bit, IEEE 754
Booleano	bool	False<True
Stringa di testo (breve)	str unicode	Unicode (str trattato come ASCII)	Fino a 1500 byte
Stringa di testo (lunga)	db.Text	Nessuno	Fino a 1 megabyte Non indicizzate
Stringa di byte (breve)	db.ByteString	Ordine dei byte	Fino a 1500 byte
Stringa di byte (lunga)	db.Blob	Nessuno	Fino a 1 megabyte Non indicizzate
Data e ora	datetime.date datetime.time datetime.datetime	Cronologica
Punto geografico	db.GeoPt	Per latitudine, poi per longitudine
Indirizzo postale	db.PostalAddress	Unicode
Numero di telefono	db.PhoneNumber	Unicode
Indirizzo email	db.Email	Unicode
Utente Account Google	users.User	Indirizzo email in ordine Unicode
Handle di messaggistica istantanea	db.IM	Unicode
Link	db.Link	Unicode
Categoria	db.Category	Unicode
Valutazione	db.Rating	Numerico
Chiave Datastore	db.Key	Per elementi del percorso (kind, identifier, kind, identifier...)
Chiave Blobstore	blobstore.BlobKey	Ordine dei byte
Null	NoneType	Nessuno

Importante:ti consigliamo vivamente di non memorizzare un UserProperty, poiché include l'indirizzo email e l'ID univoco dell'utente. Se un utente cambia il proprio indirizzo email e confronti il vecchio User memorizzato con il nuovo valore User, i valori non corrisponderanno.

Per le stringhe di testo e i dati binari non codificati (stringhe di byte), Datastore supporta due tipi di valori:

• Le stringhe brevi (fino a 1500 byte) vengono indicizzate e possono essere utilizzate nelle condizioni di filtro delle query e negli ordini di ordinamento.
• Le stringhe lunghe (fino a 1 megabyte) non vengono indicizzate e non possono essere utilizzate nei filtri delle query e negli ordini di ordinamento.

Nota: il tipo di stringa di byte lunga si chiama Blob nell'API Datastore. Questo tipo non è correlato ai BLOB come utilizzati nell'API Blobstore.

Quando una query coinvolge una proprietà con valori di tipi misti, Datastore utilizza un ordinamento deterministico basato sulle rappresentazioni interne:

1. Valori null
2. Numeri a virgola fissa
   • Numeri interi
   • Date e ore
   • Valutazioni
3. Valori booleani
4. Sequenze di byte
   • Stringa di byte
   • Stringa Unicode
   • Chiavi dell'archivio BLOB
5. Numeri in virgola mobile
6. Punti geografici
7. Utenti con account Google
8. Chiavi del datastore

Poiché le stringhe di testo lunghe e le stringhe di byte lunghe non sono indicizzate, non hanno un ordine definito.

Nota: i numeri interi e i numeri a virgola mobile sono considerati tipi distinti in Datastore. Se un'entità utilizza una combinazione di numeri interi e numeri in virgola mobile per la stessa proprietà, tutti i numeri interi verranno ordinati prima di tutti i numeri in virgola mobile: ad esempio,

7 < 3.2

Utilizzo delle entità

Le applicazioni possono utilizzare l'API Datastore per creare, recuperare, aggiornare ed eliminare le entità. Se l'applicazione conosce la chiave completa di un'entità (o può deriverla dalla chiave, dal tipo e dall'identificatore principali), può utilizzarla per operare direttamente sull'entità. Un'applicazione può anche ottenere la chiave di un'entità come risultato di una query Datastore. Per ulteriori informazioni, consulta la pagina Query Datastore.

Creazione di un'entità

In Python, crei una nuova entità costruendo un'istanza di una classe di modello, compilando le relative proprietà, se necessario, e chiamando il relativo metodo put() per salvarla in Datastore. Puoi specificare il nome della chiave dell'entità passando un argomento key_name al costruttore:

employee = Employee(key_name='asalieri',
                    first_name='Antonio',
                    last_name='Salieri')

employee.hire_date = datetime.datetime.now().date()
employee.attended_hr_training = True

employee.put()

Se non fornisci un nome della chiave, Datastore genererà automaticamente un ID numerico per la chiave dell'entità:

employee = Employee(first_name='Antonio',
                    last_name='Salieri')

employee.hire_date = datetime.datetime.now().date()
employee.attended_hr_training = True

employee.put()

Recupero di un'entità

Per recuperare un'entità identificata da una determinata chiave, passa l'oggetto Key come argomento alla funzione db.get(). Puoi generare l'oggetto Key utilizzando il metodo di classe Key.from_path(). Il percorso completo è una sequenza di entità nel percorso dell'antenato, con ogni entità rappresentata dal tipo (una stringa) seguito dal relativo identificatore (nome della chiave o ID numerico):

address_k = db.Key.from_path('Employee', 'asalieri', 'Address', 1)
address = db.get(address_k)

db.get() restituisce un'istanza della classe del modello appropriata. Assicurati di aver importato la classe del modello per l'entità recuperata.

Aggiornamento di un'entità

Per aggiornare un'entità esistente, modifica gli attributi dell'oggetto, quindi chiama il relativo metodo put(). I dati dell'oggetto sovrascrivono l'entità esistente. L'intero oggetto viene inviato a Datastore a ogni chiamata a put().

Nota: l'API Datastore non distingue tra la creazione di una nuova entità e l'aggiornamento di una entità esistente. Se la chiave dell'oggetto rappresenta un'entità esistente, il metodo put() sovrascrive l'entità esistente. Puoi utilizzare una transazione per verificare se esiste un'entità con una determinata chiave prima di crearne una. Vedi anche il metodo Model.get_or_insert().

Per eliminare una proprietà, elimina l'attributo dall'oggetto Python:

del address.postal_code

quindi salva l'oggetto.

Eliminazione di un'entità

Data la chiave di un'entità, puoi eliminarla con la funzione db.delete()

address_k = db.Key.from_path('Employee', 'asalieri', 'Address', 1)
db.delete(address_k)

oppure chiamando il metodo delete() dell'entità:

employee_k = db.Key.from_path('Employee', 'asalieri')
employee = db.get(employee_k)

# ...

employee.delete()

Operazioni batch

Le funzioni db.put(), db.get() e db.delete() (e le relative controparti asincrone db.put_async(), db.get_async() e db.delete_async()) possono accettare un argomento elenco per agire su più entità in una singola chiamata a Datastore:

# A batch put.
db.put([e1, e2, e3])

# A batch get.
entities = db.get([k1, k2, k3])

# A batch delete.
db.delete([k1, k2, k3])

Le operazioni collettive non modificano i costi. Ti verrà addebitato il costo di ogni chiave in un'operazione collettiva, indipendentemente dal fatto che esista o meno. Le dimensioni delle entità coinvolte in un'operazione non influiscono sul costo.

Nota: una chiamata batch a db.put() o db.delete() potrebbe riuscire per alcune entità, ma non per altre. Se è importante che la chiamata vada a buon fine o non vada a buon fine del tutto, devi utilizzare una transazione e tutte le entità interessate devono trovarsi nello stesso gruppo di entità.

Eliminazione di entità in blocco

Se devi eliminare un numero elevato di entità, ti consigliamo di utilizzare Dataflow per eliminare le entità in blocco.

Utilizzo di un elenco vuoto

Per l'interfaccia NDB, in passato Datastore scriveva un elenco vuoto come proprietà omessa sia per le proprietà statiche che per quelle dinamiche. Per mantenere la compatibilità con le versioni precedenti, questo comportamento continuerà a essere predefinito. Per sostituire questo valore globalmente o in base a ListProperty, imposta l'argomento write_empty_list su true nella classe Property. L'elenco vuoto viene poi scritto in Datastore e può essere letto come un elenco vuoto.

Per l'interfaccia del database, le scritture di elenchi vuoti non erano storicamente consentite se la proprietà era dinamica: se hai provato, hai ricevuto un errore. Ciò significa che non è necessario conservare un comportamento predefinito per la compatibilità con le versioni precedenti per le proprietà dinamiche del database, quindi puoi semplicemente scrivere e leggere l'elenco vuoto nel modello dinamico senza apportare modifiche.

Tuttavia, per le proprietà statiche del database, l'elenco vuoto è stato scritto come proprietà omessa e questo comportamento continua per impostazione predefinita per la compatibilità con le versioni precedenti. Se vuoi attivare gli elenchi vuoti per le proprietà statiche del database, utilizza l'argomento write_empty_list per true nella classe Property. L'elenco vuoto viene poi scritto in Datastore.