Ruby hello world

Contoh kode ini adalah aplikasi "hello world" yang berjalan di Ruby. Contoh ini mengilustrasikan cara menyelesaikan tugas-tugas berikut:

  • Menyiapkan autentikasi
  • Menghubungkan ke instance Bigtable.
  • Membuat tabel baru.
  • Menulis data ke tabel.
  • Membaca kembali data.
  • Menghapus tabel.

Menyiapkan autentikasi

Untuk menggunakan contoh Ruby di halaman ini dalam lingkungan pengembangan lokal, instal dan lakukan inisialisasi gcloud CLI, lalu siapkan Kredensial Default Aplikasi dengan kredensial pengguna Anda.

  1. Instal Google Cloud CLI.

  2. Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus terlebih dahulu login ke gcloud CLI dengan identitas gabungan Anda.

  3. Jika Anda menggunakan shell lokal, buat kredensial autentikasi lokal untuk akun pengguna Anda: 

    gcloud auth application-default login

    Anda tidak perlu melakukannya jika menggunakan Cloud Shell.

    Jika error autentikasi ditampilkan, dan Anda menggunakan penyedia identitas (IdP) eksternal, pastikan Anda telah login ke gcloud CLI dengan identitas gabungan Anda.

Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.

Menyiapkan lingkungan Anda

Untuk menjalankan contoh ini, Anda harus menginstal Ruby.

1. Menginstal Ruby

Untuk memeriksa versi Ruby minimum yang diperlukan untuk library klien, lihat required_ruby_version dalam file google-cloud-bigtable.gemspec.

Menyiapkan Ruby di VM Compute Engine Jika Anda ingin menjalankan contoh di VM Compute Engine, ikuti petunjuk ini untuk menyiapkan Ruby di VM Debian atau Ubuntu.

  1. Di Google Cloud konsol, buka halaman VM instances.

    Buka instance VM

  2. Jika Anda tidak memiliki VM Linux yang menggunakan sistem operasi Debian atau Ubuntu, buat satu dan hubungkan ke VM tersebut. Untuk mengetahui informasi selengkapnya, lihat Panduan memulai menggunakan VM Linux.

  3. Di jendela terminal untuk VM Anda, perbarui daftar paket Anda:

    sudo apt update

  4. Instal Ruby, alat pengembangan Ruby, dan build-essential, yang diperlukan oleh library klien:

    sudo apt install -y ruby ruby-dev build-essential

  5. Verifikasi bahwa versi Ruby yang diinstal memenuhi persyaratan minimum yang ditentukan dalam file google-cloud-bigtable.gemspec:

    ruby --version

2. Menginstal library klien

Untuk menginstal library klien:

  1. Lakukan inisialisasi bundler untuk membuat Gemfile di direktori utama project Anda:

    bundle init

  2. Tambahkan google-cloud-bigtable ke Gemfile Anda dan instal:

    bundle add google-cloud-bigtable

Untuk mengetahui informasi selengkapnya tentang library klien, lihat google-cloud-bigtable README.

Menjalankan contoh

Contoh kode ini menggunakan library klien Ruby untuk Bigtable paket dari Library Klien Google Cloud untuk Ruby guna berkomunikasi dengan Bigtable.

Untuk menjalankan program contoh ini, ikuti petunjuk untuk contoh di GitHub.

Menggunakan Library Klien Cloud dengan Bigtable

Aplikasi contoh terhubung ke Bigtable dan menunjukkan beberapa operasi sederhana.

Memerlukan library klien

Contoh ini memerlukan google/cloud/bigtable, yang menyediakan modul Bigtable.

require "google/cloud/bigtable"

Menghubungkan ke Bigtable

Tetapkan variabel yang akan Anda gunakan dalam aplikasi Anda, dengan mengganti "YOUR_PROJECT_ID" dengan ID project yang valid Google Cloud . Kemudian buat objek Bigtable baru yang akan Anda gunakan untuk terhubung ke Bigtable.

# These variables are used in the sample code below.
# instance_id      = "my-instance"
# table_id         = "my-table"
# column_family    = "cf"
# column_qualifier = "greeting"

bigtable = Google::Cloud::Bigtable.new
table_client = bigtable.table_admin_client

Membuat tabel

Periksa apakah tabel Anda sudah ada. Jika belum ada, panggil metode create_table() untuk membuat objek Table. Tabel memiliki satu grup kolom yang mempertahankan satu versi dari setiap nilai.

# This is the full resource name for the table. Use this name to make admin
# calls for the table, such as reading or deleting the resource.
table_name = table_client.table_path project: bigtable.project_id,
                                     instance: instance_id,
                                     table: table_id
begin
  # Attempt to get the table to see if it already exists
  table_client.get_table name: table_name
  puts "#{table_id} is already exists."
  exit 0
rescue Google::Cloud::NotFoundError
  # The table doesn't exist, so let's create it.
  # The following is the resource name for the table's instance.
  instance_name = table_client.instance_path project: bigtable.project_id,
                                             instance: instance_id
  # This is the configuration of the table's column families.
  table_config = {
    column_families: {
      column_family => {
        gc_rule: Google::Cloud::Bigtable::Admin::V2::GcRule.max_num_versions(1)
      }
    }
  }
  # Now call the API to create the table.
  table_client.create_table parent: instance_name,
                            table_id: table_id,
                            table: table_config
  puts "Table #{table_id} created."
end

Menulis baris ke tabel

Selanjutnya, gunakan array string ucapan untuk membuat beberapa baris baru untuk tabel. Untuk setiap ucapan, buat entri menggunakan metode new_mutation_entry() tabel. Selanjutnya, gunakan set_cell() metode entri untuk menetapkan grup kolom, kualifikasi kolom, ucapan, dan stempel waktu ke entri. Terakhir, tulis entri tersebut ke tabel menggunakan metode mutate_row() tabel.

puts "Write some greetings to the table #{table_id}"
greetings = ["Hello World!", "Hello Bigtable!", "Hello Ruby!"]

# Get a table data object for the new table we created.
table = bigtable.table instance_id, table_id

# Insert rows one by one
# Note: To perform multiple mutation on multiple rows use `mutate_rows`.
greetings.each_with_index do |value, i|
  puts " Writing,  Row key: greeting#{i}, Value: #{value}"

  entry = table.new_mutation_entry "greeting#{i}"
  entry.set_cell(
    column_family,
    column_qualifier,
    value,
    timestamp: (Time.now.to_f * 1_000_000).round(-3)
  )

  table.mutate_row entry
end

Membuat filter

Sebelum membaca data yang Anda tulis, buat filter untuk membatasi data yang ditampilkan Bigtable. Filter ini memberi tahu Bigtable untuk hanya menampilkan versi terbaru dari setiap nilai, meskipun tabel berisi versi lama yang belum di-garbage collect.

# Only retrieve the most recent version of the cell.
filter = Google::Cloud::Bigtable::RowFilter.cells_per_column 1

Membaca baris berdasarkan row key-nya

Buat objek baris, lalu panggil metode read_row(), dengan meneruskan filter, untuk mendapatkan satu versi dari setiap nilai dalam baris tersebut.

puts "Reading a single row by row key"
row = table.read_row "greeting0", filter: filter
puts "Row key: #{row.key}, Value: #{row.cells[column_family].first.value}"

Memindai semua baris tabel

Panggil metode read_rows(), dengan meneruskan filter, untuk mendapatkan semua baris dalam tabel. Karena Anda meneruskan filter, Bigtable hanya menampilkan satu versi dari setiap nilai.

puts "Reading the entire table"
table.read_rows.each do |row|
  puts "Row key: #{row.key}, Value: #{row.cells[column_family].first.value}"
end

Menghapus tabel

Hapus tabel dengan metode delete() tabel.

puts "Deleting the table #{table_id}"
# Call the admin API to delete the table given its full resource path.
table_client.delete_table name: table_name

Menggabungkan semuanya

Berikut adalah contoh kode lengkap tanpa komentar.

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def hello_world instance_id, table_id, column_family, column_qualifier
  require "google/cloud/bigtable"

  # These variables are used in the sample code below.
  # instance_id      = "my-instance"
  # table_id         = "my-table"
  # column_family    = "cf"
  # column_qualifier = "greeting"

  bigtable = Google::Cloud::Bigtable.new
  table_client = bigtable.table_admin_client

  # This is the full resource name for the table. Use this name to make admin
  # calls for the table, such as reading or deleting the resource.
  table_name = table_client.table_path project: bigtable.project_id,
                                       instance: instance_id,
                                       table: table_id
  begin
    # Attempt to get the table to see if it already exists
    table_client.get_table name: table_name
    puts "#{table_id} is already exists."
    exit 0
  rescue Google::Cloud::NotFoundError
    # The table doesn't exist, so let's create it.
    # The following is the resource name for the table's instance.
    instance_name = table_client.instance_path project: bigtable.project_id,
                                               instance: instance_id
    # This is the configuration of the table's column families.
    table_config = {
      column_families: {
        column_family => {
          gc_rule: Google::Cloud::Bigtable::Admin::V2::GcRule.max_num_versions(1)
        }
      }
    }
    # Now call the API to create the table.
    table_client.create_table parent: instance_name,
                              table_id: table_id,
                              table: table_config
    puts "Table #{table_id} created."
  end

  puts "Write some greetings to the table #{table_id}"
  greetings = ["Hello World!", "Hello Bigtable!", "Hello Ruby!"]

  # Get a table data object for the new table we created.
  table = bigtable.table instance_id, table_id

  # Insert rows one by one
  # Note: To perform multiple mutation on multiple rows use `mutate_rows`.
  greetings.each_with_index do |value, i|
    puts " Writing,  Row key: greeting#{i}, Value: #{value}"

    entry = table.new_mutation_entry "greeting#{i}"
    entry.set_cell(
      column_family,
      column_qualifier,
      value,
      timestamp: (Time.now.to_f * 1_000_000).round(-3)
    )

    table.mutate_row entry
  end

  # Only retrieve the most recent version of the cell.
  filter = Google::Cloud::Bigtable::RowFilter.cells_per_column 1

  puts "Reading a single row by row key"
  row = table.read_row "greeting0", filter: filter
  puts "Row key: #{row.key}, Value: #{row.cells[column_family].first.value}"

  puts "Reading the entire table"
  table.read_rows.each do |row|
    puts "Row key: #{row.key}, Value: #{row.cells[column_family].first.value}"
  end

  puts "Deleting the table #{table_id}"
  # Call the admin API to delete the table given its full resource path.
  table_client.delete_table name: table_name
end