Obiettivi
Questo tutorial illustra i passaggi seguenti relativi all'utilizzo della libreria client Spanner per Ruby:
- Creare un'istanza e un database Spanner.
- Scrivi, leggi ed esegui 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 dell'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 l'utilizzo dell'API Cloud Spanner.
In particolare, assicurati di eseguire gcloud auth
application-default login
per configurare il tuo ambiente di sviluppo locale con credenziali di autenticazione.
Prepara l'ambiente Ruby locale
Installa il file seguente sul tuo computer di sviluppo, se non è già installato:
Clona il repository dell'app di esempio nella tua macchina locale:
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples
In alternativa puoi scaricare l'esempio come file ZIP ed estrarlo.
Passa alla directory che contiene il codice campione Spanner:
cd ruby-docs-samples/spanner/
Installa le dipendenze:
bundle install
Imposta la variabile di ambiente GOOGLE_CLOUD_PROJECT sul tuo ID progetto Google Cloud:
export GOOGLE_CLOUD_PROJECT=[MY_PROJECT_ID]
Crea 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, nonché il numero di nodi da utilizzare, che determina la quantità di risorse di pubblicazione 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 in questo modo viene creata un'istanza con le seguenti caratteristiche:
- ID istanza
test-instance
- Nome visualizzato
Test Instance
- La configurazione dell'istanza
regional-us-central1
(le configurazioni regionali archiviano i dati in un'unica regione, mentre le configurazioni a più regioni distribuiscono i dati in più regioni. Per saperne di più, consulta Informazioni sulle istanze. - Numero di nodi pari a 1 (
node_count
corrisponde alla quantità di risorse di gestione e archiviazione disponibili per i database nell'istanza. Scopri di più in Nodi e unità di elaborazione.
Dovresti vedere:
Creating instance...done.
Cercare tra i file di esempio
Il repository di esempio contiene un esempio che mostra come utilizzare Spanner con Ruby.
Dai un'occhiata al filespanner_samples.rb
, che mostra come utilizzare Spanner. Il codice mostra come creare e utilizzare un nuovo database. I dati utilizzano lo schema di esempio mostrato nella pagina Schema e modello dei dati.
Crea un database
Crea un database denominato example-db
nell'istanza denominata test-instance
eseguendo la seguente azione nella riga di comando.
bundle exec ruby spanner_samples.rb create_database test-instance example-db
Dovresti vedere:
Created database example-db on instance test-instance
Il codice seguente crea un database e due tabelle nel database.
Il passaggio successivo consiste nella scrittura dei dati nel database.
Crea un client di database
Prima di poter eseguire operazioni di lettura o scrittura, devi creare un elementoClient
. Puoi
considerare un Client
come una connessione al database: tutte le tue interazioni con
Spanner devono passare attraverso un Client
. In genere si crea un Client
all'avvio dell'applicazione, per poi riutilizzarlo Client
per leggere, scrivere ed eseguire transazioni. Il codice seguente mostra come creare un client.
Per saperne di più, consulta il riferimento Client
.
Scrivere dati con DML
Puoi inserire i dati utilizzando DML (Data Manipulation Language) in una transazione di lettura-scrittura.
Usa il metodo execute_update()
per eseguire un'istruzione DML.
Esegui l'esempio utilizzando l'argomento write_using_dml
.
bundle exec ruby spanner_samples.rb write_using_dml test-instance example-db
Dovresti vedere:
4 records inserted.
Scrivere dati con mutazioni
Puoi anche inserire dati usando le mutazioni.
Puoi scrivere i dati utilizzando un oggetto Client
. Il metodo Client#commit
crea ed esegue il commit di una transazione per le scritture eseguite a livello atomico in un singolo momento logico in colonne, righe e tabelle di un database.
Questo codice mostra come scrivere i dati utilizzando le mutazioni:
Esegui l'esempio utilizzando l'argomento insert_data
.
bundle exec ruby spanner_samples.rb insert_data test-instance example-db
Dovresti vedere:
Inserted data
Esegui query sui dati utilizzando SQL
Spanner supporta un'interfaccia SQL per la lettura dei dati, a cui puoi accedere dalla riga di comando tramite Google Cloud CLI o in modo programmatico mediante la libreria client Spanner per Ruby.
Nella riga di comando
Esegui la seguente istruzione SQL per leggere i valori di tutte le colonne della 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
Utilizzo della libreria client di Spanner per Ruby
Oltre a eseguire un'istruzione SQL nella riga di comando, puoi emettere la stessa istruzione SQL in modo programmatico utilizzando la libreria client Spanner per Ruby.
Utilizza il metodo Client#execute
per eseguire la query SQL. Utilizza un simbolo Ruby :ColumnName
per accedere ai dati di una colonna specifica di una riga.
Ecco come inviare la query e accedere ai dati:
Esegui l'esempio utilizzando l'argomento query_data
.
bundle exec ruby spanner_samples.rb query_data 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 con 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 ulteriori 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 sui record contenenti un valore specifico per LastName
.
Esegui l'esempio utilizzando l'argomento query_with_parameter.
bundle exec ruby spanner_samples.rb query_with_parameter 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 metodo Client#read
della classe Client
per leggere le righe dal database.
Ecco come leggere i dati:
Esegui l'esempio utilizzando l'argomento read_data
.
bundle exec ruby spanner_samples.rb read_data 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 in un database mentre il database continua a gestire il traffico. Gli aggiornamenti dello schema non richiedono di mettere offline il 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 dello schema supportati e sulle prestazioni delle modifiche dello schema 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 Ruby.
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.
Utilizzo della libreria client di Spanner per Ruby
Utilizza il metodoDatabase#update
della classe Database
per modificare lo schema:
Esegui l'esempio utilizzando l'argomento add_column
.
bundle exec ruby spanner_samples.rb add_column test-instance example-db
Dovresti vedere:
Added the MarketingBudget column
Scrivere i dati nella nuova colonna
Il codice seguente scrive i dati nella nuova colonna. Imposta MarketingBudget
su 100000
per la riga codificata da Albums(1, 1)
e su 500000
per la riga codificata da Albums(2, 2)
.
Esegui l'esempio utilizzando l'argomento update_data
.
bundle exec ruby spanner_samples.rb update_data test-instance example-db
Dovresti vedere:
Updated data
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:
Per eseguire questa query, esegui l'esempio utilizzando l'argomento query_data_with_new_column
.
bundle exec ruby spanner_samples.rb query_data_with_new_column test-instance example-db
Dovresti vedere:
1 1 100000
1 2
2 1
2 2 500000
2 3
Aggiorna dati
Puoi aggiornare i dati utilizzando DML in una transazione di lettura-scrittura.
Usa il metodo execute_update()
per eseguire un'istruzione DML.
Esegui l'esempio utilizzando l'argomento write_with_transaction_using_dml
.
bundle exec ruby spanner_samples.rb write_with_transaction_using_dml test-instance example-db
Dovresti vedere:
Transaction complete
Utilizza un indice secondario
Supponi di voler recuperare tutte le righe di Albums
con valori di AlbumTitle
in un determinato intervallo. Puoi leggere tutti i valori della colonna AlbumTitle
utilizzando un'istruzione SQL o una chiamata di lettura e quindi ignorare le righe che non soddisfano i criteri, ma eseguire questa scansione completa della tabella è costosa, soprattutto per le tabelle con molte righe. Puoi però velocizzare il recupero delle righe quando esegui ricerche per colonne di chiave non primaria creando un indice secondario nella tabella.
L'aggiunta di un indice secondario a una tabella esistente richiede un aggiornamento dello schema. Come per altri aggiornamenti dello schema, Spanner supporta l'aggiunta di un indice mentre il database continua a gestire il traffico. Spanner esegue automaticamente il backfill dell'indice con i dati esistenti. Il completamento dei backfill potrebbe richiedere alcuni minuti, ma non è necessario portare 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 potrebbero essere eseguite più velocemente con l'indice. Se usi l'interfaccia di lettura, devi specificare l'indice che vuoi usare.
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 Ruby.
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 di Spanner per Ruby
Utilizza il metodo Database#update
della classe Database
per aggiungere un indice:
Esegui l'esempio utilizzando l'argomento create_index
.
bundle exec ruby spanner_samples.rb create_index test-instance example-db
L'aggiunta di un indice può richiedere alcuni minuti. Dopo aver aggiunto l'indice, dovresti vedere:
Added the AlbumsByAlbumTitle index
Lettura 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, fornisci un parametro index
al metodo read
della classe Client
.
Esegui l'esempio utilizzando l'argomento read_data_with_index
.
bundle exec ruby spanner_samples.rb read_data_with_index 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 non archiviati nell'indice.
Crea una definizione alternativa di AlbumsByAlbumTitle
che archivi 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 di Spanner per Ruby
Utilizza il metodoDatabase#update
della classe Database
per aggiungere un indice con una clausola STORING
:
Esegui l'esempio utilizzando l'argomento create_storing_index
.
bundle exec ruby spanner_samples.rb create_storing_index test-instance example-db
Dovresti vedere:
Added the 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 read_data_with_storing_index
.
bundle exec ruby spanner_samples.rb read_data_with_storing_index test-instance example-db
Dovresti visualizzare un output simile al seguente:
2 Forever Hold Your Peace 300000
2 Go, Go, Go
1 Green
3 Terrified
1 Total Junk 300000
Recuperare i dati utilizzando transazioni di sola lettura
Supponi di voler eseguire più di una lettura allo stesso timestamp. Le transazioni di sola lettura seguono un prefisso coerente nella cronologia del commit delle transazioni, in modo che l'applicazione riceva sempre dati coerenti.
Utilizza un oggetto Snapshot
per l'esecuzione di transazioni di sola lettura. Utilizza il metodo snapshot
della classe Client
per ottenere un oggetto Snapshot
.
Di seguito viene illustrato come eseguire una query ed eseguire una lettura nella stessa transazione di sola lettura:
Esegui l'esempio utilizzando l'argomento read_only_transaction
.
bundle exec ruby spanner_samples.rb read_only_transaction test-instance example-db
Dovresti visualizzare un output simile al seguente:
2 Forever Hold Your Peace 2
2 Go, Go, Go 1
1 Green 2
3 Terrified 2
1 Total Junk 1
1 Total Junk 1
2 Go, Go, Go 1
1 Green 2
2 Forever Hold Your Peace 2
3 Terrified 2
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 (per l'istanza ti verranno comunque addebitati costi).
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 l'eliminazione del database e fai clic su Elimina.
Elimina l'istanza
L'eliminazione di un'istanza comporta l'eliminazione automatica di 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 sull'istanza.
Fai clic su Elimina.
Conferma di voler eliminare l'istanza e fai clic su Elimina.
Passaggi successivi
Scopri come accedere a Spanner con un'istanza di macchina virtuale.
Per saperne di più sulle credenziali di autorizzazione e autenticazione, vedi Autenticazione nei servizi Cloud utilizzando librerie client.
Scopri di più sulle best practice per la progettazione di schemi di Spanner.