Tujuan
Tutorial ini memandu Anda melakukan langkah-langkah berikut menggunakan library klien Spanner untuk Ruby:
- Membuat instance dan database Spanner.
- Menulis, membaca, dan mengeksekusi kueri SQL pada data dalam {i>database<i}.
- Perbarui skema database.
- Memperbarui data menggunakan transaksi baca-tulis.
- Tambahkan indeks sekunder ke database.
- Menggunakan indeks untuk membaca dan mengeksekusi kueri SQL pada data.
- Mengambil data menggunakan transaksi hanya baca.
Biaya
Tutorial ini menggunakan Spanner, yang merupakan komponen Google Cloud yang dapat ditagih. Untuk mengetahui informasi tentang biaya penggunaan Spanner, lihat Harga.
Sebelum memulai
Selesaikan langkah-langkah yang dijelaskan dalam Penyiapan, yang mencakup pembuatan dan penetapan project Google Cloud default, mengaktifkan penagihan, mengaktifkan Cloud Spanner API, dan menyiapkan OAuth 2.0 untuk mendapatkan kredensial autentikasi agar dapat menggunakan Cloud Spanner API.
Secara khusus, pastikan Anda menjalankan gcloud auth
application-default login
untuk menyiapkan lingkungan pengembangan lokal dengan kredensial
autentikasi.
Mempersiapkan lingkungan Ruby lokal
Instal yang berikut ini pada mesin pengembangan Anda jika belum terinstal:
Clone repositori aplikasi contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples
Atau, Anda dapat mendownload sampel sebagai file ZIP dan mengekstraknya.
Ubah ke direktori yang berisi kode contoh Spanner:
cd ruby-docs-samples/spanner/
Instal dependensi:
bundle install
Tetapkan variabel lingkungan GOOGLE_CLOUD_PROJECT ke ID project Google Cloud Anda:
export GOOGLE_CLOUD_PROJECT=[MY_PROJECT_ID]
Membuat instance
Saat pertama kali menggunakan Spanner, Anda harus membuat instance, yang merupakan alokasi resource yang digunakan oleh database Spanner. Saat membuat instance, Anda memilih konfigurasi instance, yang menentukan tempat data disimpan, dan juga jumlah node yang akan digunakan, yang menentukan jumlah penayangan dan resource penyimpanan dalam instance Anda.
Jalankan perintah berikut untuk membuat instance Spanner di region us-central1
dengan 1 node:
gcloud spanner instances create test-instance --config=regional-us-central1 \
--description="Test Instance" --nodes=1
Perhatikan bahwa tindakan ini akan membuat instance dengan karakteristik berikut:
- ID Instance
test-instance
- Nama tampilan
Test Instance
- Konfigurasi instance
regional-us-central1
(Konfigurasi regional menyimpan data di satu region, sedangkan konfigurasi multi-region mendistribusikan data di beberapa region. Untuk mengetahui informasi lebih lanjut, lihat artikel Tentang instance.) - Jumlah node 1 (
node_count
sesuai dengan jumlah resource penyajian dan penyimpanan yang tersedia untuk database dalam instance. Pelajari lebih lanjut di Node dan unit pemrosesan.)
Anda akan melihat:
Creating instance...done.
Mencari contoh file
Repositori sampel berisi contoh yang menunjukkan cara menggunakan Spanner dengan Ruby.
Lihat filespanner_samples.rb
, yang menunjukkan cara menggunakan
Spanner. Kode ini menunjukkan cara membuat dan menggunakan database baru. Data menggunakan skema contoh yang ditampilkan di halaman Model data dan skema.
Buat database
Buat database yang disebut example-db
dalam instance bernama test-instance
dengan
menjalankan baris berikut di command line.
bundle exec ruby spanner_samples.rb create_database test-instance example-db
Anda akan melihat:
Created database example-db on instance test-instance
Kode berikut membuat database dan dua tabel dalam database.
Langkah selanjutnya adalah menulis data ke database Anda.
Membuat klien database
Sebelum dapat melakukan pembacaan atau penulisan, Anda harus membuatClient
. Anda
dapat menganggap Client
sebagai koneksi database: semua interaksi Anda dengan
Spanner harus melalui Client
. Biasanya Anda membuat Client
saat
aplikasi dimulai, lalu menggunakan kembali Client
tersebut untuk membaca, menulis, dan
menjalankan transaksi. Kode berikut menunjukkan cara membuat klien.
Baca selengkapnya dalam referensi
Client
.
Menulis data dengan DML
Anda dapat menyisipkan data menggunakan Data Manipulation Language (DML) dalam transaksi baca-tulis.
Anda menggunakan metode execute_update()
untuk mengeksekusi pernyataan DML.
Jalankan contoh menggunakan argumen write_using_dml
.
bundle exec ruby spanner_samples.rb write_using_dml test-instance example-db
Anda akan melihat:
4 records inserted.
Menulis data dengan mutasi
Anda juga dapat menyisipkan data menggunakan mutasi.
Anda menulis data menggunakan
objek
Client
. Metode Client#commit
membuat dan meng-commit transaksi untuk penulisan yang berjalan secara atomik pada satu waktu logis di seluruh kolom, baris, dan tabel dalam suatu database.
Kode ini menunjukkan cara menulis data menggunakan mutasi:
Jalankan contoh menggunakan argumen insert_data
.
bundle exec ruby spanner_samples.rb insert_data test-instance example-db
Anda akan melihat:
Inserted data
Membuat kueri data menggunakan SQL
Spanner mendukung antarmuka SQL untuk membaca data, yang dapat Anda akses dari command line menggunakan Google Cloud CLI atau secara terprogram menggunakan library klien Spanner untuk Ruby.
Pada command line
Jalankan pernyataan SQL berikut untuk membaca nilai semua kolom dari
tabel Albums
:
Hasilnya seharusnya:
SingerId AlbumId AlbumTitle
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Menggunakan library klien Spanner untuk Ruby
Selain menjalankan pernyataan SQL di command line, Anda dapat mengeluarkan pernyataan SQL yang sama secara terprogram menggunakan library klien Spanner untuk Ruby.
Gunakan
metode Client#execute
untuk menjalankan kueri SQL. Gunakan simbol Ruby :ColumnName
untuk mengakses data untuk kolom tertentu dari sebuah baris.
Berikut cara mengeluarkan kueri dan mengakses data:
Jalankan contoh menggunakan argumen query_data
.
bundle exec ruby spanner_samples.rb query_data test-instance example-db
Anda akan melihat hasil berikut:
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Kueri menggunakan parameter SQL
Jika aplikasi Anda memiliki kueri yang sering dijalankan, Anda dapat meningkatkan performanya dengan membuat parameter pada kueri tersebut. Kueri parametrik yang dihasilkan dapat disimpan dalam cache dan digunakan kembali, sehingga mengurangi biaya kompilasi. Untuk informasi selengkapnya, lihat Menggunakan parameter kueri untuk mempercepat kueri yang sering dijalankan.
Berikut adalah contoh penggunaan parameter dalam klausa WHERE
untuk
mengueri data yang berisi nilai tertentu untuk LastName
.
Jalankan contoh menggunakan argumen query_with_parameter.
bundle exec ruby spanner_samples.rb query_with_parameter test-instance example-db
Anda akan melihat hasil berikut:
12 Melissa Garcia
Membaca data menggunakan read API
Selain antarmuka SQL Spanner, Spanner juga mendukung antarmuka baca.
Gunakan metode Client#read
dari class Client
untuk membaca baris dari database.
Berikut cara membaca data:
Jalankan contoh menggunakan argumen read_data
.
bundle exec ruby spanner_samples.rb read_data test-instance example-db
Anda akan melihat output yang mirip dengan:
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
Memperbarui skema database
Asumsikan Anda perlu menambahkan kolom baru bernama MarketingBudget
ke tabel
Albums
. Untuk menambahkan kolom baru ke tabel yang ada, skema database Anda harus diperbarui. Spanner mendukung pembaruan skema pada database sementara database terus menyalurkan traffic. Pembaruan skema tidak memerlukan pembuatan database
secara offline dan pembaruan tersebut tidak mengunci seluruh tabel atau kolom. Anda dapat terus
menulis data ke database selama pembaruan skema. Baca selengkapnya tentang update skema yang didukung dan performa perubahan skema di Membuat pembaruan skema.
Menambahkan kolom
Anda dapat menambahkan kolom di command line menggunakan Google Cloud CLI atau secara terprogram menggunakan library klien Spanner untuk Ruby.
Pada command line
Gunakan perintah ALTER TABLE
berikut untuk
menambahkan kolom baru ke tabel:
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'
Anda akan melihat:
Schema updating...done.
Menggunakan library klien Spanner untuk Ruby
Gunakan metodeDatabase#update
dari class Database
untuk mengubah skema:
Jalankan contoh menggunakan argumen add_column
.
bundle exec ruby spanner_samples.rb add_column test-instance example-db
Anda akan melihat:
Added the MarketingBudget column
Menulis data ke kolom baru
Kode berikut menulis data ke kolom baru. Fungsi ini menetapkan MarketingBudget
ke
100000
untuk baris yang dikunci oleh Albums(1, 1)
dan ke 500000
untuk baris yang dikunci
oleh Albums(2, 2)
.
Jalankan contoh menggunakan argumen update_data
.
bundle exec ruby spanner_samples.rb update_data test-instance example-db
Anda akan melihat:
Updated data
Anda juga dapat menjalankan kueri SQL atau panggilan baca untuk mengambil nilai yang baru saja Anda tulis.
Berikut adalah kode untuk mengeksekusi kueri:
Untuk menjalankan kueri ini, jalankan contoh menggunakan argumen query_data_with_new_column
.
bundle exec ruby spanner_samples.rb query_data_with_new_column test-instance example-db
Anda akan melihat:
1 1 100000
1 2
2 1
2 2 500000
2 3
Memperbarui data
Anda dapat memperbarui data menggunakan DML dalam transaksi baca-tulis.
Anda menggunakan metode execute_update()
untuk mengeksekusi pernyataan DML.
Jalankan contoh menggunakan argumen write_with_transaction_using_dml
.
bundle exec ruby spanner_samples.rb write_with_transaction_using_dml test-instance example-db
Anda akan melihat:
Transaction complete
Menggunakan indeks sekunder
Misalkan Anda ingin mengambil semua baris Albums
yang memiliki nilai AlbumTitle
dalam rentang tertentu. Anda dapat membaca semua nilai dari kolom AlbumTitle
menggunakan
pernyataan SQL atau panggilan baca, lalu menghapus baris yang tidak memenuhi
kriteria, tetapi melakukan pemindaian tabel lengkap ini mahal, terutama untuk tabel
dengan banyak baris. Namun, Anda dapat mempercepat pengambilan baris saat melakukan penelusuran berdasarkan kolom kunci non-utama dengan membuat indeks sekunder pada tabel.
Menambahkan indeks sekunder ke tabel yang ada memerlukan update skema. Seperti update skema lainnya, Spanner mendukung penambahan indeks saat database terus menyalurkan traffic. Spanner secara otomatis mengisi ulang indeks dengan data yang ada. Pengisian ulang mungkin memerlukan waktu beberapa menit untuk diselesaikan, tetapi Anda tidak perlu membuat database offline atau menghindari penulisan ke tabel yang diindeks selama proses ini. Untuk mengetahui detail selengkapnya, lihat Menambahkan indeks sekunder.
Setelah Anda menambahkan indeks sekunder, Spanner akan otomatis menggunakannya untuk kueri SQL yang cenderung berjalan lebih cepat dengan indeks tersebut. Jika menggunakan antarmuka baca, Anda harus menentukan indeks yang ingin digunakan.
Menambahkan indeks sekunder
Anda dapat menambahkan indeks di command line menggunakan gcloud CLI atau secara terprogram menggunakan library klien Spanner untuk Ruby.
Pada command line
Gunakan perintah CREATE INDEX
berikut untuk menambahkan indeks ke database:
gcloud spanner databases ddl update example-db --instance=test-instance \
--ddl='CREATE INDEX AlbumsByAlbumTitle ON Albums(AlbumTitle)'
Anda akan melihat:
Schema updating...done.
Menggunakan library klien Spanner untuk Ruby
Gunakan metode
Database#update
dari class Database
untuk menambahkan indeks:
Jalankan contoh menggunakan argumen create_index
.
bundle exec ruby spanner_samples.rb create_index test-instance example-db
Menambahkan indeks dapat memerlukan waktu beberapa menit. Setelah indeks ditambahkan, Anda akan melihat:
Added the AlbumsByAlbumTitle index
Membaca menggunakan indeks
Untuk kueri SQL, Spanner secara otomatis menggunakan indeks yang sesuai. Di antarmuka baca, Anda harus menentukan indeks dalam permintaan.
Untuk menggunakan indeks di antarmuka baca, sediakan parameter index
ke
metode read
dari class Client
.
Jalankan contoh menggunakan argumen read_data_with_index
.
bundle exec ruby spanner_samples.rb read_data_with_index test-instance example-db
Anda akan melihat:
2 Forever Hold Your Peace
2 Go, Go, Go
1 Green
3 Terrified
1 Total Junk
Menambahkan indeks untuk pembacaan khusus indeks
Anda mungkin telah memperhatikan bahwa contoh pembacaan sebelumnya tidak menyertakan pembacaan
kolom MarketingBudget
. Hal ini karena antarmuka baca Spanner
tidak mendukung kemampuan untuk menggabungkan indeks dengan tabel data guna mencari nilai
yang tidak disimpan dalam indeks.
Buat definisi alternatif AlbumsByAlbumTitle
yang menyimpan salinan
MarketingBudget
dalam indeks.
Pada command line
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)
Menambahkan indeks dapat memerlukan waktu beberapa menit. Setelah indeks ditambahkan, Anda akan melihat:
Schema updating...done.
Menggunakan library klien Spanner untuk Ruby
Gunakan metodeDatabase#update
dari class Database
untuk menambahkan indeks dengan klausa STORING
:
Jalankan contoh menggunakan argumen create_storing_index
.
bundle exec ruby spanner_samples.rb create_storing_index test-instance example-db
Anda akan melihat:
Added the AlbumsByAlbumTitle2 index
Sekarang Anda dapat menjalankan operasi baca yang mengambil semua kolom AlbumId
, AlbumTitle
, dan MarketingBudget
dari indeks AlbumsByAlbumTitle2
:
Jalankan contoh menggunakan argumen read_data_with_storing_index
.
bundle exec ruby spanner_samples.rb read_data_with_storing_index test-instance example-db
Anda akan melihat output yang mirip dengan:
2 Forever Hold Your Peace 300000
2 Go, Go, Go
1 Green
3 Terrified
1 Total Junk 300000
Mengambil data menggunakan transaksi hanya baca
Misalnya Anda ingin mengeksekusi lebih dari satu pembacaan pada stempel waktu yang sama. Transaksi hanya baca mengamati awalan yang konsisten dari histori commit transaksi, sehingga aplikasi Anda selalu mendapatkan data yang konsisten.
Gunakan objek Snapshot
untuk menjalankan transaksi hanya baca. Gunakan metode
snapshot
dari class Client
untuk mendapatkan objek Snapshot
.
Berikut ini cara menjalankan kueri dan melakukan pembacaan dalam transaksi hanya baca yang sama:
Jalankan contoh menggunakan argumen read_only_transaction
.
bundle exec ruby spanner_samples.rb read_only_transaction test-instance example-db
Anda akan melihat output yang mirip dengan:
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
Pembersihan
Agar tidak menimbulkan biaya tambahan pada akun Penagihan Cloud Anda untuk resource yang digunakan dalam tutorial ini, hapus database dan hapus instance yang Anda buat.
Menghapus database
Jika instance dihapus, semua database di dalamnya akan dihapus secara otomatis. Langkah ini menunjukkan cara menghapus database tanpa menghapus instance (Anda masih akan dikenai biaya untuk instance tersebut).
Pada command line
gcloud spanner databases delete example-db --instance=test-instance
Menggunakan Konsol Google Cloud
Buka halaman Spanner Instances di konsol Google Cloud.
Klik instance.
Klik database yang ingin dihapus.
Di halaman Database details, klik Delete.
Konfirmasi bahwa Anda ingin menghapus database, lalu klik Delete.
Menghapus instance
Jika sebuah instance dihapus, semua database yang dibuat dalam instance tersebut akan otomatis dihapus.
Pada command line
gcloud spanner instances delete test-instance
Menggunakan Konsol Google Cloud
Buka halaman Spanner Instances di konsol Google Cloud.
Klik instance Anda.
Klik Delete.
Konfirmasi bahwa Anda ingin menghapus instance, lalu klik Hapus.
Langkah selanjutnya
Pelajari cara mengakses Spanner dengan instance virtual machine.
Pelajari kredensial autentikasi dan autentikasi di Melakukan autentikasi ke layanan Cloud menggunakan library klien.
Pelajari Praktik terbaik desain skema Spanner lebih lanjut.