Creazione e utilizzo delle chiavi di entità

Ogni entità è identificata da una chiave univoca all'interno dell'istanza Datastore dell'applicazione e si compone di quanto segue:

  • kind. In genere, il tipo è il nome della classe del modello a cui appartiene l'entità, ma puoi impostarlo su un'altra stringa sostituendo la classmethod _get_kind().
  • identifier. Specifica il tuo nome chiave come identificatore o lascia che Datastore generi automaticamente un ID numerico intero.

Specifica il nome della chiave

L'esempio seguente crea implicitamente una chiave con un identificatore di stringa utilizzando il parametro denominato id:

account = Account(
    username='Sandy', userid=1234, email='sandy@example.com',
    id='sandy@example.com')

return account.key.id()  # returns 'sandy@example.com'

In alternativa, puoi impostare direttamente il nome della chiave:

account.key = ndb.Key('Account', 'sandy@example.com')

# You can also use the model class object itself, rather than its name,
# to specify the entity's kind:
account.key = ndb.Key(Account, 'sandy@example.com')

Consentire a Datastore di generare un ID da utilizzare per la chiave

Questo codice mostra come utilizzare un ID generato automaticamente come chiave:

# note: no id kwarg
account = Account(username='Sandy', userid=1234, email='sandy@example.com')
account.put()
# account.key will now have a key of the form: ndb.Key(Account, 71321839)
# where the value 71321839 was generated by Datastore for us.

Utilizzo del percorso dell'antenato nella chiave

La sequenza di entità che inizia con un'entità base principale e procede da quella principale a quella secondaria, fino a una determinata entità, costituisce il percorso di antenati di quell'entità. Un'entità, la relativa entità principale, l'entità principale dell'entità principale e così via in modo ricorsivo sono gli antenati dell'entità. Le entità in Datastore formano uno spazio delle chiavi gerarchico simile alla struttura di directory gerarchica di un file system.

La chiave completa che identifica un'entità è costituita da una sequenza di coppie di tipo-identificatore che specificano il percorso del suo predecessore e termina con quelle dell'entità stessa. Il metodo del costruttore della classe Key accetta una sequenza di tipi e identificativi e restituisce un oggetto che rappresenta la chiave per l'entità corrispondente.

L'esempio seguente mostra un servizio di blogging che memorizza i messaggi in base alla revisione. I messaggi sono organizzati in base agli account e le revisioni in base ai messaggi.

class Revision(ndb.Model):
    message_text = ndb.StringProperty()
... 
ndb.Key('Account', 'sandy@example.com', 'Message', 123, 'Revision', '1')
ndb.Key('Account', 'sandy@example.com', 'Message', 123, 'Revision', '2')
ndb.Key('Account', 'larry@example.com', 'Message', 456, 'Revision', '1')
ndb.Key('Account', 'larry@example.com', 'Message', 789, 'Revision', '2')

Nel campione, ('Account', 'sandy@example.com'), ('Message', 123) e ('Revision', '1') sono tutti esempi di coppie di tipo di identificatore.

Tieni presente che Message non è una classe di modelli; viene utilizzato solo come modo per raggruppare le revisioni, non per archiviare i dati.

Come mostrato nel codice campione, il tipo di entità è designato dall'ultima coppia di tipo e nome nell'elenco: ndb.Key('Revision', '1').

Utilizzo di parametri denominati

Puoi utilizzare il parametro denominato parent per designare direttamente qualsiasi entità nel percorso dell'antenato. Tutte le seguenti notazioni rappresentano la stessa chiave:

ndb.Key('Account', 'sandy@example.com', 'Message', 123, 'Revision', '1')

ndb.Key('Revision', '1', parent=ndb.Key(
    'Account', 'sandy@example.com', 'Message', 123))

ndb.Key('Revision', '1', parent=ndb.Key(
    'Message', 123, parent=ndb.Key('Account', 'sandy@example.com')))

Specifica di un'entità base

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

sandy_key = ndb.Key(Account, 'sandy@example.com')

Specifica di un'entità con antenati

Per inserire un nuovo messaggio con chiavi principali

account_key = ndb.Key(Account, 'sandy@example.com')

# Ask Datastore to allocate an ID.
new_id = ndb.Model.allocate_ids(size=1, parent=account_key)[0]

# Datastore returns us an integer ID that we can use to create the message
# key
message_key = ndb.Key('Message', new_id, parent=account_key)

# Now we can put the message into Datastore
initial_revision = Revision(
    message_text='Hello', id='1', parent=message_key)
initial_revision.put()

Per le chiavi create con un'entità principale, il metodo parent() restituisce una chiave rappresentante l&#entità padre:

message_key = initial_revision.key.parent()

Utilizzare ID chiave numerici

Puoi creare un'entità senza specificare un ID, in questo caso il datastore genera automaticamente un ID numerico. Se scegli di specificare alcuni ID e poi lascia che Datastore ne generi automaticamente alcuni, potresti violare il requisito delle chiavi univoche. Per evitare questo problema, riserva un intervallo di numeri da utilizzare per scegliere gli ID o utilizza ID di stringa.

Per prenotare un intervallo di ID, utilizza il metodo della classe allocate_ids() della classe del modello:

  • per allocare un numero specificato di ID
  • per allocare tutti gli ID fino a un determinato valore massimo.

ID allocazione

Per allocare 100 ID per una determinata classe di modelli MyModel:

first, last = MyModel.allocate_ids(100)

Per allocare 100 ID per le entità con chiave principale p:

first, last = MyModel.allocate_ids(100, parent=p)

I valori restituiti, first e last, sono gli ID primo e ultimo (inclusi) assegnati. Puoi utilizzarli per creare chiavi come segue:

keys = [ndb.Key(MyModel, id) for id in range(first, last+1)]

È garantito che queste chiavi non siano state restituite in precedenza dal generatore di ID interno del data store né verranno restituite da chiamate future al generatore di ID interno. Tuttavia, il metodo allocate_ids() non controlla se gli ID restituiti sono presenti nello datastore, ma interagisce solo con il generatore di ID.

Per allocare tutti gli ID fino a un determinato valore massimo:

first, last = MyModel.allocate_ids(max=N)

Questo modulo garantisce che tutti gli ID inferiori o uguali a N siano considerati assegnati. I valori restituiti, first e last, indicano l'intervallo di ID riservati da questa operazione. Non è un errore tentare di prenotare ID già assegnati. In questo caso, first indica il primo ID non ancora assegnato e last è l'ultimo ID assegnato.