Obiettivi
Questo tutorial illustra i passaggi seguenti utilizzando la libreria client Spanner per Java:
- Creare un'istanza e un database Spanner.
- Scrivere, leggere ed eseguire query SQL sui dati nel database.
- Aggiorna lo schema del database.
- Aggiornare i dati utilizzando una transazione di lettura/scrittura.
- Aggiungi un indice secondario al database.
- Utilizza l'indice per leggere ed eseguire query SQL sui dati.
- Recupera i dati utilizzando una transazione di sola lettura.
Costi
Questo tutorial utilizza Spanner, che è un componente fatturabile di Google Cloud. Per informazioni sul costo di utilizzo di Spanner, consulta i prezzi.
Prima di iniziare
Completa i passaggi descritti in Configurazione, che riguardano la creazione e l'impostazione di un progetto Google Cloud predefinito, l'abilitazione della fatturazione, l'abilitazione dell'API Cloud Spanner e la configurazione di OAuth 2.0 per ottenere le credenziali di autenticazione per utilizzare l'API Cloud Spanner.
In particolare, assicurati di eseguire gcloud auth
application-default login
per configurare l'ambiente di sviluppo locale con le credenziali di autenticazione.
Prepara l'ambiente Java locale
Installa sul computer di sviluppo i seguenti elementi, se non sono già installati:
Clona il repository dell'app di esempio nella tua macchina locale:
git clone https://github.com/googleapis/java-spanner.git
Passa alla directory che contiene il codice campione di Spanner:
cd java-spanner/samples/snippets
Creazione di un'istanza
Quando utilizzi Spanner per la prima volta, devi creare un'istanza, ovvero un'allocazione di risorse utilizzate dai database Spanner. Quando crei un'istanza, scegli una configurazione dell'istanza, che determina dove sono archiviati i dati e anche il numero di nodi da utilizzare, che determina la quantità di risorse di servizio e archiviazione nell'istanza.
Esegui questo comando per creare un'istanza Spanner nella regione us-central1
con 1 nodo:
gcloud spanner instances create test-instance --config=regional-us-central1 \
--description="Test Instance" --nodes=1
Tieni presente che viene creata un'istanza con le seguenti caratteristiche:
- ID istanza
test-instance
- Nome visualizzato
Test Instance
- Configurazione dell'istanza
regional-us-central1
(le configurazioni regionali archiviano i dati in una regione, mentre le configurazioni multiregionali distribuiscono i dati in più regioni. Per ulteriori informazioni, consulta Informazioni sulle istanze. - Conteggio dei nodi pari a 1 (
node_count
corrisponde alla quantità di risorse di servizio e archiviazione disponibili per i database nell'istanza. Scopri di più in Nodi e unità di elaborazione.
Dovresti vedere:
Creating instance...done.
Esamina i file di esempio
Il repository di esempi contiene un esempio che mostra come utilizzare Spanner con Java.
Crea un database
Crea un database denominato example-db
nell'istanza denominata test-instance
eseguendo quanto segue sulla riga di comando.
GoogleSQL
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
createdatabase test-instance example-db
PostgreSQL
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
createpgdatabase test-instance example-db
Dovresti vedere:
Created database [example-db]
Il seguente codice crea un database e due tabelle nel database.
GoogleSQL
PostgreSQL
Il passaggio successivo è scrivere dati nel database.
Crea un client di database
Prima di poter eseguire operazioni di lettura o scrittura, devi creare unaDatabaseClient
.
Puoi pensare a DatabaseClient
come a una connessione di database: tutte
le interazioni con Spanner devono passare attraverso un DatabaseClient
. In genere, crei una DatabaseClient
quando l'applicazione viene avviata, quindi la riutilizzi DatabaseClient
per leggere, scrivere ed eseguire transazioni.
GoogleSQL
PostgreSQL
Ogni client utilizza risorse in Spanner, quindi è buona norma chiudere
i client non necessari chiamando close()
.
Scopri di più nella DatabaseClient
Riferimento Javadoc.
Scrivi dati con DML
Puoi inserire dati utilizzando DML (Data Manipulation Language) in una transazione di lettura e scrittura.
Utilizzi il metodo executeUpdate()
per eseguire un'istruzione DML.
Esegui l'esempio utilizzando l'argomento writeusingdml
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
writeusingdml test-instance example-db
Dovresti vedere:
4 records inserted.
Scrivere dati con mutazioni
Puoi anche inserire i dati utilizzando le mutazioni.
Puoi scrivere dati utilizzando
un oggetto Mutation
.
Un oggetto Mutation
è un container per le operazioni di mutazione. Mutation
rappresenta una sequenza di inserimenti, aggiornamenti ed eliminazioni che Spanner si applica atomicamente a righe e tabelle diverse in un database Spanner.
Il metodo newInsertBuilder()
nella classe Mutation
crea una mutazione INSERT
, che inserisce
una nuova riga in una tabella. Se la riga esiste già, la scrittura non riesce. In alternativa,
puoi utilizzare il metodo newInsertOrUpdateBuilder
per creare una mutazione INSERT_OR_UPDATE
, che aggiorna i valori della colonna
se la riga esiste già.
write()
nella classe DatabaseClient
scrive le mutazioni. Tutte le mutazioni in un singolo batch
sono applicate a livello atomico.
Questo codice mostra come scrivere i dati utilizzando le mutazioni:
Esegui l'esempio utilizzando l'argomento write
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
write test-instance example-db
Il comando dovrebbe essere eseguito correttamente.
Eseguire query sui dati utilizzando SQL
Spanner supporta un'interfaccia SQL per la lettura dei dati, a cui puoi accedere dalla riga di comando utilizzando Google Cloud CLI o in modo programmatico utilizzando la libreria client Spanner per Java.
Nella riga di comando
Esegui questa istruzione SQL per leggere i valori di tutte le colonne dalla tabella Albums
:
gcloud spanner databases execute-sql example-db --instance=test-instance \
--sql='SELECT SingerId, AlbumId, AlbumTitle FROM Albums'
Il risultato dovrebbe essere:
SingerId AlbumId AlbumTitle
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Utilizzare la libreria client Spanner per Java
Oltre a eseguire un'istruzione SQL dalla riga di comando, puoi emettere la stessa istruzione SQL in modo programmatico utilizzando la libreria client Spanner per Java.
Per eseguire la query SQL vengono utilizzati i seguenti metodi e classi:- Metodo
singleUse()
nella classeDatabaseClient
: utilizza questo metodo per leggere il valore di una o più colonne da una o più righe in una tabella Spanner.singleUse()
restituisce un oggettoReadContext
, utilizzato per eseguire un'istruzione SQL o di lettura. - Metodo
executeQuery()
della classeReadContext
: utilizza questo metodo per eseguire una query su un database. - La classe
Statement
: utilizza questa classe per creare una stringa SQL. - La classe
ResultSet
: utilizza questa opzione per accedere ai dati restituiti da un'istruzione SQL o da una chiamata di lettura.
Ecco come inviare la query e accedere ai dati:
Esegui l'esempio utilizzando l'argomento query
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
query test-instance example-db
Dovresti vedere il seguente risultato:
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Query utilizzando un parametro SQL
Se la tua applicazione ha una query eseguita di frequente, puoi migliorarne le prestazioni Parametrizzandola. La query parametrica risultante può essere memorizzata nella cache e riutilizzata, riducendo i costi di compilazione. Per maggiori informazioni, consulta Utilizzare parametri di ricerca per velocizzare le query eseguite di frequente.
Ecco un esempio di utilizzo di un parametro nella clausola WHERE
per eseguire query su record contenenti un valore specifico per LastName
.
GoogleSQL
PostgreSQL
Esegui l'esempio utilizzando l'argomento queryWithParameter.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
querywithparameter test-instance example-db
Dovresti vedere il seguente risultato:
12 Melissa Garcia
Leggere i dati utilizzando l'API Read
Oltre all'interfaccia SQL di Spanner, Spanner supporta anche un'interfaccia di lettura.
Utilizza il metodoread()
della classe ReadContext
per leggere le righe dal database. Utilizza un oggetto KeySet
per definire una raccolta di chiavi e intervalli di chiavi da leggere.
Ecco come leggere i dati:
Esegui l'esempio utilizzando l'argomento read
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
read test-instance example-db
Dovresti visualizzare un output simile al seguente:
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Aggiorna lo schema del database
Supponi di dover aggiungere una nuova colonna denominata MarketingBudget
alla tabella
Albums
. L'aggiunta di una nuova colonna a una tabella esistente richiede un aggiornamento dello schema del database. Spanner supporta gli aggiornamenti dello schema
di un database mentre quest'ultimo continua a gestire il traffico. Gli aggiornamenti dello schema non richiedono la modalità offline del database e non bloccano intere tabelle o colonne; puoi continuare a scrivere dati nel database durante l'aggiornamento dello schema. Scopri di più sugli aggiornamenti degli schemi supportati e sulle prestazioni delle modifiche degli schemi in Eseguire aggiornamenti dello schema.
Aggiungi una colonna
Puoi aggiungere una colonna nella riga di comando utilizzando Google Cloud CLI o in modo programmatico utilizzando la libreria client Spanner per Java.
Nella riga di comando
Utilizza il seguente comando ALTER TABLE
per
aggiungere la nuova colonna alla tabella:
GoogleSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='ALTER TABLE Albums ADD COLUMN MarketingBudget INT64'
PostgreSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='ALTER TABLE Albums ADD COLUMN MarketingBudget BIGINT'
Dovresti vedere:
Schema updating...done.
Utilizzare la libreria client Spanner per Java
Utilizza il metodoupdateDatabaseDdl()
della classe DatabaseAdminClient
per modificare lo schema:
GoogleSQL
PostgreSQL
Esegui l'esempio utilizzando l'argomento addmarketingbudget
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
addmarketingbudget test-instance example-db
Dovresti vedere:
Added MarketingBudget column.
Scrivi i dati nella nuova colonna
Il seguente codice scrive i dati nella nuova colonna. Consente di impostare MarketingBudget
su
100000
per la riga associata a Albums(1, 1)
e su 500000
per la riga associata
a Albums(2, 2)
.
Esegui l'esempio utilizzando l'argomento update
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
update test-instance example-db
Puoi anche eseguire una query SQL o una chiamata di lettura per recuperare i valori che hai appena scritto.
Ecco il codice per eseguire la query:
GoogleSQL
PostgreSQL
Per eseguire questa query, esegui l'esempio utilizzando l'argomento querymarketingbudget
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
querymarketingbudget test-instance example-db
Dovresti vedere:
1 1 100000
1 2 NULL
2 1 NULL
2 2 500000
2 3 NULL
Aggiorna dati
Puoi aggiornare i dati utilizzando DML in una transazione di lettura/scrittura.
Utilizza il metodo executeUpdate()
per eseguire un'istruzione DML.
GoogleSQL
PostgreSQL
Esegui l'esempio utilizzando l'argomento writewithtransactionusingdml
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
writewithtransactionusingdml test-instance example-db
Utilizza un indice secondario
Supponiamo di voler recuperare tutte le righe di Albums
con valori AlbumTitle
in un determinato intervallo. Puoi leggere tutti i valori della colonna AlbumTitle
utilizzando
un'istruzione SQL o una chiamata di lettura, quindi ignorare le righe che non soddisfano i
criteri, ma eseguire questa analisi completa della tabella è costosa, soprattutto per le tabelle
con molte righe. In alternativa, puoi velocizzare il recupero delle righe durante la ricerca in base a colonne non di chiave primaria creando un indice secondario nella tabella.
L'aggiunta di un indice secondario a una tabella esistente richiede un aggiornamento dello schema. Come altri aggiornamenti dello schema, Spanner supporta l'aggiunta di un indice mentre il database continua a gestire traffico. Spanner esegue automaticamente il backfill dell'indice con i dati esistenti. Il completamento dei backfill potrebbe richiedere alcuni minuti, ma non è necessario mettere offline il database o evitare di scrivere nella tabella indicizzata durante questo processo. Per maggiori dettagli, consulta Aggiungere un indice secondario.
Dopo aver aggiunto un indice secondario, Spanner lo utilizza automaticamente per le query SQL che hanno maggiori probabilità di essere eseguite più velocemente con l'indice. Se usi l'interfaccia di lettura, devi specificare l'indice che vuoi utilizzare.
Aggiungi un indice secondario
Puoi aggiungere un indice dalla riga di comando utilizzando gcloud CLI o in modo programmatico utilizzando la libreria client Spanner per Java.
Nella riga di comando
Utilizza il seguente comando CREATE INDEX
per aggiungere un indice al database:
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle ON Albums(AlbumTitle)'
Dovresti vedere:
Schema updating...done.
Utilizzo della libreria client Spanner per Java
Utilizza il metodoupdateDatabaseDdl()
della classe DatabaseAdminClient
per aggiungere un indice:
Esegui l'esempio utilizzando l'argomento addindex
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
addindex test-instance example-db
L'aggiunta di un indice può richiedere alcuni minuti. Dopo aver aggiunto l'indice, dovresti vedere:
Added the AlbumsByAlbumTitle index.
Leggi utilizzando l'indice
Per le query SQL, Spanner utilizza automaticamente un indice appropriato. Nell'interfaccia di lettura, devi specificare l'indice nella richiesta.
Per utilizzare l'indice nell'interfaccia di lettura, usa il metodo readUsingIndex()
della classe ReadContext
.
Il seguente codice recupera tutte le colonne AlbumId
e AlbumTitle
dall'indice AlbumsByAlbumTitle
.
Esegui l'esempio utilizzando l'argomento readindex
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
readindex test-instance example-db
Dovresti vedere:
2 Forever Hold Your Peace
2 Go, Go, Go
1 Green
3 Terrified
1 Total Junk
Aggiungi un indice per le letture solo dell'indice
Potresti aver notato che l'esempio di lettura precedente non include la lettura
della colonna MarketingBudget
. Questo perché l'interfaccia di lettura di Spanner non supporta la possibilità di unire un indice a una tabella di dati per cercare valori che non sono archiviati nell'indice.
Crea una definizione alternativa di AlbumsByAlbumTitle
che memorizzi una copia di MarketingBudget
nell'indice.
Nella riga di comando
GoogleSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle) STORING (MarketingBudget)
PostgreSQL
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle) INCLUDE (MarketingBudget)
L'aggiunta di un indice può richiedere alcuni minuti. Dopo aver aggiunto l'indice, dovresti vedere:
Schema updating...done.
Utilizzo della libreria client Spanner per Java
Utilizza il metodo updateDatabaseDdl()
della classe DatabaseAdminClient
per aggiungere un indice con una clausola STORING
per GoogleSQL e INCLUDE
per PostgreSQL:
GoogleSQL
PostgreSQL
Esegui l'esempio utilizzando l'argomento addstoringindex
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
addstoringindex test-instance example-db
L'aggiunta di un indice può richiedere alcuni minuti. Dopo aver aggiunto l'indice, dovresti vedere:
Added AlbumsByAlbumTitle2 index
Ora puoi eseguire una lettura che recupera tutte le colonne AlbumId
, AlbumTitle
e
MarketingBudget
dall'indice AlbumsByAlbumTitle2
:
Esegui l'esempio utilizzando l'argomento readstoringindex
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
readstoringindex test-instance example-db
Dovresti visualizzare un output simile al seguente:
2 Forever Hold Your Peace 300000
2 Go, Go, Go NULL
1 Green NULL
3 Terrified NULL
1 Total Junk 300000
Recuperare i dati utilizzando le transazioni di sola lettura
Supponiamo di voler eseguire più di una lettura per lo stesso timestamp. Le transazioni di sola lettura osservano un prefisso coerente della cronologia di commit delle transazioni, in modo che l'applicazione riceva sempre dati coerenti.
Utilizza un oggetto ReadOnlyTransaction
per l'esecuzione di transazioni di sola lettura. Usa il metodo readOnlyTransaction()
della classe DatabaseClient
per ottenere un oggetto ReadOnlyTransaction
.
Di seguito viene illustrato come eseguire una query ed eseguire una lettura nella stessa transazione di sola lettura:
Esegui l'esempio utilizzando l'argomento readonlytransaction
.
java -jar target/spanner-snippets/spanner-google-cloud-samples.jar \
readonlytransaction test-instance example-db
Dovresti visualizzare un output simile al seguente:
2 2 Forever Hold Your Peace
1 2 Go, Go, Go
2 1 Green
2 3 Terrified
1 1 Total Junk
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
esegui la pulizia
Per evitare che al tuo account di fatturazione Cloud vengano addebitati costi aggiuntivi per le risorse utilizzate in questo tutorial, elimina il database ed elimina l'istanza che hai creato.
Elimina il database
Se elimini un'istanza, tutti i database al suo interno vengono eliminati automaticamente. Questo passaggio mostra come eliminare un database senza eliminare un'istanza (i costi per l'istanza continueranno a essere addebitati).
Nella riga di comando
gcloud spanner databases delete example-db --instance=test-instance
Utilizzo della console Google Cloud
Vai alla pagina Istanze Spanner nella console Google Cloud.
Fai clic sull'istanza.
Fai clic sul database che vuoi eliminare.
Nella pagina Dettagli database, fai clic su Elimina.
Conferma di voler eliminare il database e fai clic su Elimina.
Elimina l'istanza
L'eliminazione di un'istanza elimina automaticamente tutti i database creati al suo interno.
Nella riga di comando
gcloud spanner instances delete test-instance
Utilizzo della console Google Cloud
Vai alla pagina Istanze Spanner nella console Google Cloud.
Fai clic sulla tua istanza.
Fai clic su Elimina.
Conferma di voler eliminare l'istanza e fai clic su Elimina.
Passaggi successivi
- Prova il modulo Spring Data per Spanner.
Scopri come accedere a Spanner con un'istanza di una macchina virtuale.
Scopri di più sulle credenziali di autorizzazione e autenticazione in Autenticare nei servizi Cloud utilizzando librerie client.
Scopri di più sulle best practice per la progettazione dello schema di Spanner.