Obiettivi
Questo tutorial illustra i passaggi seguenti utilizzando Spanner libreria client per Ruby:
- Crea 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, un componente fatturabile di Google Cloud. Per informazioni sul costo di utilizzo di Spanner, consulta Prezzi.
Prima di iniziare
Completa i passaggi descritti in Configurazione, che riguardano la creazione e la configurazione di un progetto Google Cloud predefinito, l'attivazione della fatturazione, l'attivazione 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 Ruby locale
Installa i seguenti elementi sul computer di sviluppo, se non sono già installati:
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 di Spanner:
cd ruby-docs-samples/spanner/
Installa le dipendenze:
bundle install
Imposta la variabile di ambiente GOOGLE_CLOUD_PROJECT su Google Cloud ID progetto:
export GOOGLE_CLOUD_PROJECT=[MY_PROJECT_ID]
Crea un'istanza
Quando utilizzi Spanner per la prima volta, devi creare un'istanza, ovvero delle risorse usate dai database Spanner. Quando Quando crei un'istanza, scegli una configurazione dell'istanza, che determina dove sono archiviati i dati e il numero di nodi da utilizzare, che determina e la quantità di risorse di servizio e archiviazione nell'istanza.
Esegui il seguente 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 memorizzano i dati in una regione, mentre quelle multiregionali li distribuiscono in più regioni. Per ulteriori informazioni, consulta Informazioni sulle istanze. - Conteggio dei nodi pari a 1 (
node_count
corrisponde alla quantità di pubblicazione e archiviazione e le risorse 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 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
utilizza lo schema di esempio mostrato
Pagina Schema e modello dei dati.
Crea un database
Crea un database denominato example-db
nell'istanza test-instance
eseguendo quanto segue 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 passaggio successivo consiste nello scrivere i dati nel database.
Crea un client di database
Prima di poter eseguire operazioni di lettura o scrittura, devi creare unClient
Tu
può pensare a Client
come a una connessione di database: tutte le tue interazioni con
Spanner deve passare attraverso un Client
. Di solito crei una Client
quando
viene avviata l'applicazione, quindi riutilizzi Client
per leggere, scrivere
eseguire transazioni. Il codice seguente mostra come creare un client.
Scopri di più nel riferimento Client
.
Scrivere dati con DML
Puoi inserire dati utilizzando il linguaggio Data Manipulation Language (DML) in una transazione di lettura/scrittura.
Utilizza 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 modifiche
Puoi anche inserire i dati utilizzando le mutazioni.
Scrivi i dati utilizzando un
Client
. Il metodo
Client#commit
crea e conferma una transazione per le scritture che vengono eseguite in modo atomico
in un singolo punto logico nel tempo su 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
Eseguire query sui dati utilizzando SQL
Spanner supporta un'interfaccia SQL per la lettura dei dati, che puoi l'accesso dalla riga di comando utilizzando Google Cloud CLI in modo programmatico utilizzando la libreria client Spanner per Ruby.
Nella riga di comando
Esegui la seguente istruzione SQL per leggere i valori di tutte le colonne della tabellaAlbums
:
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 Ruby
Oltre a eseguire un'istruzione SQL sulla riga di comando, puoi inviare la stessa istruzione SQL in modo programmatico mediante la libreria client Spanner per Ruby.
Utilizza la
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 eseguire 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
Esegui una 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, riduce i costi di compilazione. Per ulteriori informazioni, consulta Utilizzare i parametri di query 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 di lettura
Oltre all'interfaccia SQL, 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
Supponiamo che tu debba 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
continua a gestire traffico. Gli aggiornamenti dello schema non richiedono il 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 sul rendimento delle modifiche dello schema in Eseguire aggiornamenti dello schema.
Aggiungi una colonna
Puoi aggiungere una colonna nella riga di comando utilizzando Google Cloud CLI oppure in modo programmatico utilizzando la libreria client Spanner per Ruby.
Nella riga di comando
Utilizza il seguente comando ALTER TABLE
per
aggiungi 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 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
Scrivi i dati nella nuova colonna
Il codice seguente scrive i dati nella nuova colonna. Imposta MarketingBudget
su
100000
per la riga con chiave Albums(1, 1)
e su 500000
per la riga con chiave
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 appena scritti.
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
Aggiornare i dati
Puoi aggiornare i dati utilizzando DML in una transazione di lettura/scrittura.
Utilizza 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
Supponiamo che tu voglia recuperare tutte le righe di Albums
con valori AlbumTitle
in un determinato intervallo. Potresti 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 questa scansione completa della tabella è costosa, in particolare per le tabelle
con molte righe. In alternativa, puoi velocizzare il recupero delle righe quando effettui ricerche in base a colonne di chiavi non principali creando un indice secondario nella tabella.
L'aggiunta di un indice secondario a una tabella esistente richiede un aggiornamento dello schema. Come per gli 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 mettere offline il database o evitare di scrivere nell'elenco durante questo processo. Per maggiori dettagli, consulta Aggiungere un indice secondario.
Dopo aver aggiunto un indice secondario, Spanner lo utilizza automaticamente per Query SQL che hanno maggiori probabilità di essere eseguite più velocemente con l'indice. Se utilizzi l'interfaccia read, devi specificare l'indice che vuoi utilizzare.
Aggiungi un indice secondario
Puoi aggiungere un indice sulla riga di comando utilizzando la CLI gcloud o programmaticamente 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 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. Una volta aggiunto l'indice, consulta:
Added the AlbumsByAlbumTitle index
Lettura utilizzando l'indice
Per le query SQL, Spanner utilizza automaticamente un indice appropriato. Nella di lettura, devi specificare l'indice nella richiesta.
Per utilizzare l'indice nell'interfaccia di lettura, fornisci un parametro index
alla
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
Aggiungere un indice per le letture solo dell'indice
Potresti aver notato che l'esempio di lettura precedente non include la lettura
la 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. Una volta aggiunto l'indice, consulta:
Schema updating...done.
Utilizzo della libreria client Spanner per Ruby
Utilizza laDatabase#update
di 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 tutti i valori AlbumId
, AlbumTitle
e
MarketingBudget
colonne 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 le transazioni di sola lettura
Supponiamo che tu voglia eseguire più letture con lo stesso timestamp. Sola lettura
transazioni osservano una coerenza
della cronologia di commit delle transazioni, in modo che l'applicazione
la coerenza dei dati.
Utilizza un oggetto Snapshot
per eseguire 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 sessione transazione:
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 (dovresti sono comunque addebitati costi per l'istanza).
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 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.
Scopri di più sulle credenziali di autorizzazione e autenticazione in Eseguire l'autenticazione per i servizi Cloud utilizzando le librerie client.
Scopri di più sulle best practice per la progettazione dello schema di Spanner.