Riferimento alle proprietà delle entità

Questa API è supportata per i runtime di prima generazione e può essere utilizzata durante l'upgrade ai runtime di seconda generazione corrispondenti. Se esegui l'aggiornamento al runtime Java 11/17 di App Engine, consulta la guida alla migrazione per conoscere le opzioni di migrazione per i servizi in bundle legacy.

Firestore in modalità Datastore (Datastore) supporta diversi tipi di dati per i valori delle proprietà. tra cui:

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

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

Proprietà e tipi di valori

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 su una proprietà P ignoreranno le entità in cui P non è indicizzato). Un'entità può avere al massimo 20.000 proprietà indicizzate.

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

Sono supportati i seguenti tipi di valori:

Tipo di valore	Tipi di Java	Ordinamento	Note
Numero intero	short int long java.lang.Short java.lang.Integer java.lang.Long	Numerico	Archiviato come numero intero lungo, poi convertito nel tipo di campo overflow dei valori fuori intervallo
Numero con virgola mobile	float double java.lang.Float java.lang.Double	Numerico	Precisione doppia a 64 bit, IEEE 754
Booleano	boolean java.lang.Boolean	false<true
Stringa di testo (breve)	java.lang.String	Unicode	Fino a 1500 byte Valori superiori a 1500 byte vengono generati IllegalArgumentException
Stringa di testo (lunga)	com.google.appengine.api.datastore.Text	Nessuna	Fino a 1 megabyte Non indicizzato
Stringa byte (breve)	com.google.appengine.api.datastore.ShortBlob	Ordine byte	Fino a 1500 byte I valori più lunghi di 1500 byte vengono generati IllegalArgumentException
Stringa byte (lunga)	com.google.appengine.api.datastore.Blob	Nessuna	Fino a 1 megabyte Non indicizzato
Data e ora	java.util.Date	Cronologica
Punto geografico	com.google.appengine.api.datastore.GeoPt	Per latitudine, poi per longitudine
Indirizzo postale	com.google.appengine.api.datastore.PostalAddress	Unicode
Numero di telefono	com.google.appengine.api.datastore.PhoneNumber	Unicode
Indirizzo email	com.google.appengine.api.datastore.Email	Unicode
Utente Account Google	com.google.appengine.api.users.User	Indirizzo email nell'ordine Unicode
Handle della messaggistica immediata	com.google.appengine.api.datastore.IMHandle	Unicode
Link	com.google.appengine.api.datastore.Link	Unicode
Categoria	com.google.appengine.api.datastore.Category	Unicode
Valutazione	com.google.appengine.api.datastore.Rating	Numerico
Chiave Datastore	com.google.appengine.api.datastore.Key o l'oggetto a cui viene fatto riferimento (come elemento secondario)	Per elementi del percorso (kind, identifier, kind, identifier...)	Fino a 1500 byte I valori più lunghi di 1500 byte vengono generati IllegalArgumentException
Chiave Blobstore	com.google.appengine.api.blobstore.BlobKey	Ordine byte
Entità incorporata	com.google.appengine.api.datastore.EmbeddedEntity	Nessuna	Non indicizzato
Null	null	Nessuna

Importante:ti consigliamo vivamente di evitare di archiviare users.User come valore di proprietà, perché include l'indirizzo email e l'ID univoco. Se un utente cambia il proprio indirizzo email e confronti il precedente valore user.User archiviato con il nuovo valore di user.User, non corrisponderanno. Utilizza invece il valore ID utente User come identificatore univoco stabile dell'utente.

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 lungo è denominato Blob nell'API Datastore. Questo tipo non è correlato ai BLOB utilizzati nell'API Blobstore.

Quando una query riguarda 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 byte
   • Stringa Unicode
   • Chiavi dell'archivio BLOB
5. Numeri con virgola mobile
6. Punti geografici
7. Utenti con account Google
8. Chiavi Datastore

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

Nota: numeri interi e in virgola mobile sono considerati tipi separati 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 valori in virgola mobile,ad esempio:

7 < 3.2

Proprietà ripetute

Puoi archiviare più valori all'interno di una singola proprietà.

Entity employee = new Entity("Employee");
ArrayList<String> favoriteFruit = new ArrayList<String>();
favoriteFruit.add("Pear");
favoriteFruit.add("Apple");
employee.setProperty("favoriteFruit", favoriteFruit);
datastore.put(employee);

// Sometime later
employee = datastore.get(employee.getKey());
@SuppressWarnings("unchecked") // Cast can't verify generic type.
    ArrayList<String> retrievedFruits = (ArrayList<String>) employee
    .getProperty("favoriteFruit");

Entità incorporate

A volte potrebbe essere pratico incorporare un'entità come proprietà di un'altra entità. Questo può essere utile, ad esempio, per creare una struttura gerarchica dei valori delle proprietà all'interno di un'entità. La classe Java EmbeddedEntity consente di eseguire queste operazioni:

// Entity employee = ...;
EmbeddedEntity embeddedContactInfo = new EmbeddedEntity();

embeddedContactInfo.setProperty("homeAddress", "123 Fake St, Made, UP 45678");
embeddedContactInfo.setProperty("phoneNumber", "555-555-5555");
embeddedContactInfo.setProperty("emailAddress", "[e-mail]");

employee.setProperty("contactInfo", embeddedContactInfo);

Le proprietà di un'entità incorporata non sono indicizzate e non possono essere utilizzate nelle query. Facoltativamente, puoi associare una chiave a un'entità incorporata, ma (a differenza di un'entità completa) la chiave non è obbligatoria e, anche se presente, non può essere utilizzata per recuperare l'entità.

Anziché compilare manualmente le proprietà dell'entità incorporata, puoi utilizzare il metodo setPropertiesFrom() per copiarle da un'entità esistente:

// Entity employee = ...;
// Entity contactInfo = ...;
EmbeddedEntity embeddedContactInfo = new EmbeddedEntity();

embeddedContactInfo.setKey(contactInfo.getKey()); // Optional, used so we can recover original.
embeddedContactInfo.setPropertiesFrom(contactInfo);

employee.setProperty("contactInfo", embeddedContactInfo);

In seguito, puoi utilizzare lo stesso metodo per recuperare l'entità originale dall'entità incorporata:

Entity employee = datastore.get(employeeKey);
EmbeddedEntity embeddedContactInfo = (EmbeddedEntity) employee.getProperty("contactInfo");

Key infoKey = embeddedContactInfo.getKey();
Entity contactInfo = new Entity(infoKey);
contactInfo.setPropertiesFrom(embeddedContactInfo);

Utilizzo di un elenco vuoto

Storicamente Datastore non aveva una rappresentazione per una proprietà che rappresenta un elenco vuoto. L'SDK Java ha risolto questo problema memorizzando le raccolte vuote come valori nulli, quindi non è possibile distinguere tra valori nulli ed elenchi vuoti. Per mantenere la compatibilità con le versioni precedenti, questo rimane il comportamento predefinito, sintetizzato come segue:

• Le proprietà null sono scritte come null in Datastore
• Le raccolte vuote vengono scritte come null in Datastore
• Un valore null viene letto come null in Datastore
• Una raccolta vuota viene letta come nulla.

Importante: una lettura/modifica di un'entità con un elenco vuoto farà sì che l'elenco venga convertito in un valore null.

Tuttavia, se modifichi il comportamento predefinito, l'SDK Java di Appengine Datastore supporterà l'archiviazione di elenchi vuoti. Ti consigliamo di valutare le implicazioni della modifica del comportamento predefinito dell'applicazione e di attivare il supporto per gli elenchi vuoti.

Per modificare il comportamento predefinito in modo da utilizzare elenchi vuoti, imposta la proprietà DATASTORE_EMPTY_LIST_SUPPORT durante l'inizializzazione dell'app come segue:

System.setProperty(DatastoreServiceConfig.DATASTORE_EMPTY_LIST_SUPPORT, Boolean.TRUE.toString());

Con questa proprietà impostata su true come mostrato sopra:

• Le proprietà null sono scritte come null in Datastore
• Le raccolte vuote vengono scritte come un elenco vuoto in Datastore.
• Un valore null viene letto come null in Datastore
• Durante la lettura da Datastore, viene restituito un elenco vuoto come raccolta vuota.

Importante: l'attivazione del supporto per elenchi vuoti potrebbe influire sulle tue query. I valori null sono indicizzati in Datastore, mentre gli elenchi vuoti non lo sono. Se archiviavi elenchi vuoti come valori nulli e poi esegui una query su un elenco per trovarli, cambiando l'elenco in un elenco vuoto, queste query non restituiranno risultati.