Panoramica della libreria client NDB di App Engine per Python 2

La libreria client NDB di Google Datastore consente alle app Python di App Engine di connettersi a Datastore. La libreria client NDB si basa sulla libreria DB Datastore precedente e aggiunge le seguenti funzionalità di datastore:

  • La classe StructuredProperty, che consente alle entità di avere una struttura nidificata.
  • Memorizzazione nella cache automatica integrata, che in genere offre letture rapide ed economiche tramite una cache in contesto e Memcache.
  • Supporta sia le API asincrone per azioni simultanee sia le API sincrone.

Questa pagina fornisce un'introduzione e una panoramica della libreria client NDB di App Engine. Per informazioni su come eseguire la migrazione a Cloud NDB, che supporta Python 3, consulta l'articolo Migrazione a Cloud NDB.

Definizione di entità, chiavi e proprietà

Datastore archivia oggetti di dati, chiamati entità. Un'entità ha una o più proprietà, valori denominati di uno dei diversi tipi di dati supportati. Ad esempio, una proprietà può essere una stringa, un numero intero o un riferimento a un'altra entità.

Ogni entità è identificata da una chiave, un identificatore univoco all'interno del datastore dell'applicazione. La chiave può avere un genitore, un'altra chiave. Questo elemento principale può a sua volta avere un elemento principale e così via. In cima a questa "catena" di elementi principali si trova una chiave senza elemento principale, chiamata radice.

Mostra la relazione tra l'entità base e le entità secondarie in un gruppo di entità

Le entità le cui chiavi hanno la stessa radice formano un gruppo di entità o un gruppo. Se le entità si trovano in gruppi diversi, le modifiche apportate a queste entità a volte potrebbero sembrare "fuori ordine". Se le entità non sono correlate nella semantica della tua applicazione, non c'è problema. Tuttavia, se le modifiche di alcune entità devono essere coerenti, la tua applicazione deve includerle nello stesso gruppo durante la creazione.

Il seguente diagramma delle relazioni tra entità e l'esempio di codice mostrano come un Guestbook possa avere più Greetings, ognuno con proprietà content e date.

Mostra le relazioni tra le entità come create dalesempio di codiceo incluso

Questa relazione è implementata nel esempio di codice riportato di seguito.

import cgi
import textwrap
import urllib

from google.appengine.ext import ndb

import webapp2


class Greeting(ndb.Model):
    """Models an individual Guestbook entry with content and date."""
    content = ndb.StringProperty()
    date = ndb.DateTimeProperty(auto_now_add=True)

    @classmethod
    def query_book(cls, ancestor_key):
        return cls.query(ancestor=ancestor_key).order(-cls.date)


class MainPage(webapp2.RequestHandler):
    def get(self):
        self.response.out.write('<html><body>')
        guestbook_name = self.request.get('guestbook_name')
        ancestor_key = ndb.Key("Book", guestbook_name or "*notitle*")
        greetings = Greeting.query_book(ancestor_key).fetch(20)

        greeting_blockquotes = []
        for greeting in greetings:
            greeting_blockquotes.append(
                '<blockquote>%s</blockquote>' % cgi.escape(greeting.content))

        self.response.out.write(textwrap.dedent("""\
            <html>
              <body>
                {blockquotes}
                <form action="/sign?{sign}" method="post">
                  <div>
                    <textarea name="content" rows="3" cols="60">
                    </textarea>
                  </div>
                  <div>
                    <input type="submit" value="Sign Guestbook">
                  </div>
                </form>
                <hr>
                <form>
                  Guestbook name:
                    <input value="{guestbook_name}" name="guestbook_name">
                    <input type="submit" value="switch">
                </form>
              </body>
            </html>""").format(
                blockquotes='\n'.join(greeting_blockquotes),
                sign=urllib.urlencode({'guestbook_name': guestbook_name}),
                guestbook_name=cgi.escape(guestbook_name)))


class SubmitForm(webapp2.RequestHandler):
    def post(self):
        # We set the parent key on each 'Greeting' to ensure each guestbook's
        # greetings are in the same entity group.
        guestbook_name = self.request.get('guestbook_name')
        greeting = Greeting(parent=ndb.Key("Book",
                                           guestbook_name or "*notitle*"),
                            content=self.request.get('content'))
        greeting.put()
        self.redirect('/?' + urllib.urlencode(
            {'guestbook_name': guestbook_name}))


app = webapp2.WSGIApplication([
    ('/', MainPage),
    ('/sign', SubmitForm)
])

Utilizzo dei modelli per l'archiviazione dei dati

Un modello è una classe che descrive un tipo di entità, inclusi i tipi e la configurazione delle relative proprietà. È più o meno analogo a una tabella in SQL. Un'entità può essere creata chiamando il costruttore della classe del modello e poi archiviata chiamando il metodo put().

Questo codice campione definisce la classe del modello Greeting. Ogni entità Greeting ha due proprietà: il contenuto di testo del saluto e la data di creazione del saluto.

class Greeting(ndb.Model):
    """Models an individual Guestbook entry with content and date."""
    content = ndb.StringProperty()
    date = ndb.DateTimeProperty(auto_now_add=True)
 
class SubmitForm(webapp2.RequestHandler):
    def post(self):
        # We set the parent key on each 'Greeting' to ensure each guestbook's
        # greetings are in the same entity group.
        guestbook_name = self.request.get('guestbook_name')
        greeting = Greeting(parent=ndb.Key("Book",
                                           guestbook_name or "*notitle*"),
                            content=self.request.get('content'))
        greeting.put()

Per creare e memorizzare un nuovo saluto, l'applicazione crea un nuovo oggetto Greeting e chiama il relativo metodo put().

Per assicurarsi che i saluti in un guestbook non vengano visualizzati "in ordine sparso ", l'applicazione imposta una chiave principale quando crea un nuovo Greeting. Pertanto, il nuovo saluto si troverà nello stesso gruppo di entità degli altri saluti nello stesso guestbook. L'applicazione utilizza questo fatto quando esegue query: utilizza unaquery da predecessorei.

Query e indici

Un'applicazione può eseguire query per trovare entità che corrispondono ad alcuni filtri.

    @classmethod
    def query_book(cls, ancestor_key):
        return cls.query(ancestor=ancestor_key).order(-cls.date)


class MainPage(webapp2.RequestHandler):
    def get(self):
        self.response.out.write('<html><body>')
        guestbook_name = self.request.get('guestbook_name')
        ancestor_key = ndb.Key("Book", guestbook_name or "*notitle*")
        greetings = Greeting.query_book(ancestor_key).fetch(20)

Una tipica query NDB filtra le entità per tipo. In questo esempio, query_book genera una query che restituisce Greeting entità. Una query può anche specificare filtri su chiavi e valori delle proprietà delle entità. Come in questo esempio, una query può specificare un elemento principale, trovando solo le entità che "appartengono a" un elemento principale. Una query può specificare l'ordinamento. Se una determinata entità ha almeno un valore (possibilmente nullo) per ogni proprietà nei filtri e negli ordinamenti e tutti i criteri di filtro sono soddisfatti dai valori delle proprietà, l'entità viene restituita come risultato.

Ogni query utilizza un indice, una tabella che contiene i risultati della query nell'ordine desiderato. Datastore sottostante gestisce automaticamente gli indici semplici (indici che utilizzano una sola proprietà).

Definisce gli indici complessi in un file di configurazione, index.yaml. Il server web di sviluppo aggiunge automaticamente suggerimenti a questo file quando rileva query per le quali non sono ancora stati configurati indici.

Puoi ottimizzare gli indici manualmente modificando il file prima di caricare l'applicazione. Puoi aggiornare gli indici separatamente dal caricamento dell'applicazione eseguendo gcloud app deploy index.yaml. Se il tuo datastore contiene molte entità, la creazione di un nuovo indice richiede molto tempo. In questo caso, è consigliabile aggiornare le definizioni dell'indice prima di caricare il codice che utilizza il nuovo indice. Puoi utilizzare la Console di amministrazione per scoprire quando è terminata la creazione degli indici.

Questo meccanismo di indicizzazione supporta un'ampia gamma di query ed è adatto alla maggior parte delle applicazioni. Tuttavia, non supporta alcuni tipi di query comuni in altre tecnologie di database. In particolare, i join non sono supportati.

Informazioni sulle scritture NDB: commit, annullamento della convalida della cache e applicazione

NDB scrive i dati in passaggi:

  • Nella fase di commit, il servizio Datastore sottostante registra le modifiche.
  • NDB invalida le cache delle entità interessate. Pertanto, le letture future leggeranno (e memorizzeranno nella cache) il Datastore sottostante anziché leggere valori non aggiornati dalla cache.
  • Infine, forse qualche secondo dopo, Datastore sottostante applica la modifica. Rende la modifica visibile alle query globali e alla fine alle letture coerenti.

La funzione NDB che scrive i dati (ad esempio put()) viene restituita dopo l'invalidazione della cache; la fase di applicazione avviene in modo asincrono.

Se si verifica un errore durante la fase di commit, vengono eseguiti nuovi tentativi automatici, ma se gli errori continuano, l'applicazione riceve un'eccezione. Se la fase Commit va a buon fine, ma la fase Apply non riesce, l'operazione Apply viene eseguita fino al completamento quando si verifica una delle seguenti condizioni:

  • Le "pulizie" periodiche di Datastore controllano i job Commit non completati e li applicano.
  • La successiva scrittura, transazione o lettura fortemente coerente nel gruppo di entità interessato fa sì che le modifiche non ancora applicate vengano applicate prima della lettura, della scrittura o della transazione.

Questo comportamento influisce su come e quando i dati sono visibili alla tua applicazione. La modifica potrebbe non essere applicata completamente al datastore sottostante qualche centinaio di millisecondi circa dopo la restituzione della funzione NDB. Una query non discendente eseguita durante l'applicazione di una modifica potrebbe visualizzare uno stato incoerente, ovvero parte della modifica, ma non tutta.

Transazioni e dati memorizzati nella cache

La libreria client NDB può raggruppare più operazioni in una singola transazione. La transazione non può andare a buon fine a meno che ogni operazione al suo interno non riesca; se una delle operazioni non riesce, la transazione viene automaticamente annullata. Ciò è particolarmente utile per le applicazioni web distribuite, in cui più utenti potrebbero accedere o manipolare gli stessi dati contemporaneamente.

NDB utilizza Memcache come servizio di memorizzazione nella cache per gli "hotspot" nei dati. Se l'applicazione legge spesso alcune entità, NDB può leggerle rapidamente dalla cache.

Utilizzo di Django con NDB

Per utilizzare NDB con il framework web Django, aggiungi google.appengine.ext.ndb.django_middleware.NdbDjangoMiddleware all'elemento MIDDLEWARE_CLASSES nel file settings.py di Django. È meglio inserirlo prima di qualsiasi altra classe middleware, perché alcuni altri middleware potrebbero effettuare chiamate al datastore e queste non verranno gestite correttamente se il middleware viene richiamato prima di questo. Puoi scoprire di più sul middleware Django.

Passaggi successivi

Scopri di più su: