Ruby hello world

Este exemplo de código é uma aplicação "hello world" que é executada no Ruby. O exemplo ilustra como concluir as seguintes tarefas:

• Configure a autenticação
• Estabeleça ligação a uma instância do Bigtable.
• Criar uma nova tabela.
• Escreva dados na tabela.
• Ler os dados novamente.
• Eliminar a tabela.

Configure a autenticação

Para usar os Ruby exemplos nesta página num ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e, em seguida, configure as Credenciais predefinidas da aplicação com as suas credenciais de utilizador.

Instale a CLI Google Cloud.

Se estiver a usar um fornecedor de identidade (IdP) externo, primeiro tem de iniciar sessão na CLI gcloud com a sua identidade federada.

If you're using a local shell, then create local authentication credentials for your user account:

gcloud auth application-default login

You don't need to do this if you're using Cloud Shell.

If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Para mais informações, consulte Set up authentication for a local development environment.

Executar o exemplo

Este exemplo de código usa o pacote Ruby client library for Bigtable da Google Cloud Client Library for Ruby para comunicar com o Bigtable.

Para executar este programa de exemplo, siga as instruções do exemplo no GitHub.

Usar a biblioteca cliente da Google Cloud com o Bigtable

A aplicação de exemplo liga-se ao Bigtable e demonstra algumas operações simples.

Requerer a biblioteca de cliente

O exemplo requer o google/cloud/bigtable, que fornece o módulo Bigtable.

require "google/cloud/bigtable"

Associar ao Bigtable

Estabeleça as variáveis que vai usar na sua aplicação, substituindo "YOUR_PROJECT_ID" pelo ID de um Google Cloud projeto válido. Em seguida, crie um novo objeto Bigtable que vai usar para estabelecer ligação ao 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

Criar uma tabela

Verifique se a tabela já existe. Se não existir, chame o método create_table() para criar um objeto Table. A tabela tem uma única família de colunas que retém uma versão de cada valor.

Nota: as colunas relacionadas entre si são normalmente agrupadas numa família de colunas. Para mais informações sobre famílias de colunas, consulte o modelo de armazenamento do Bigtable.

# 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

Escrever linhas numa tabela

Em seguida, use uma matriz de strings de saudações para criar algumas novas linhas para a tabela. Para cada saudação, crie uma entrada com o método new_mutation_entry() da tabela. Em seguida, use o método set_cell() da entrada para atribuir a família de colunas, o qualificador de colunas, a saudação e uma data/hora à entrada. Por fim, escreva essa entrada na tabela através do método mutate_row() da tabela.

Nota: nesta aplicação de exemplo, set_Cell() só é chamado uma vez por mutação, mas pode chamá-lo até 10 000 vezes por mutação única.

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

Criar um filtro

Antes de ler os dados que escreveu, crie um filtro para limitar os dados que o Bigtable devolve. Este filtro indica ao Bigtable que deve devolver apenas a versão mais recente de cada valor, mesmo que a tabela contenha versões mais antigas que não tenham sido recolhidas como lixo.

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

Ler uma linha pela respetiva chave de linha

Crie um objeto de linha e, de seguida, chame o método read_row(), passando o filtro, para obter uma versão de cada valor nessa linha.

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}"

Analisar todas as linhas da tabela

Chame o método read_rows(), transmitindo o filtro, para obter todas as linhas na tabela. Como transmitiu o filtro, o Bigtable devolve apenas uma versão de cada valor.

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

Eliminar uma tabela

Elimine a tabela com o método delete() da tabela.

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

A reunir tudo

Segue-se o exemplo de código completo sem comentários.

# 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