C# の Hello World
このコードサンプルは C# で記述された「Hello World」アプリケーションです。このサンプルでは、次のタスクを行う方法を説明します。
- 認証の設定
- Bigtable インスタンスに接続する
- 新しいテーブルを作成する
- テーブルにデータを書き込む
- そのデータを読み取る
- テーブルを削除する
認証の設定
このページの .NET サンプルをローカル開発環境から使用するには、gcloud CLI をインストールして初期化し、自身のユーザー認証情報を使用してアプリケーションのデフォルト認証情報を設定してください。
- Google Cloud CLI をインストールします。
-
gcloud CLI を初期化するには:
gcloud init
-
Google アカウントのローカル認証情報を作成します。
gcloud auth application-default login
詳細については、 ローカル開発環境の認証の設定 をご覧ください。
サンプルの実行
このコードは、.NET 用の Google Cloud クライアント ライブラリの C# Admin API ライブラリと C# Data API ライブラリを使用して Bigtable と通信します。
このサンプル プログラムを実行するには、GitHub の .NET Bigtable サンプルの使用方法を実施してください。Hello World アプリケーションで使用できるリソースを作成するには、Build and Run と Quickstart の手順を実行します。HelloWorld.cs
ファイルを編集して、作成するリソースの名前を追加してください。
Bigtable での Cloud クライアント ライブラリの使用
このサンプル アプリケーションは Bigtable に接続して、いくつかの単純なオペレーションを行います。
Bigtable への接続
まず、Bigtable への接続に使用できる 2 つのクライアント オブジェクトを作成します。C# Admin API の BigtableTableAdminClient
を使用すると、インスタンスとテーブルの作成と削除を行えます。C# Data API の BigtableClient
を使用すると、テーブルデータの読み取りと書き込みを行えます。
// BigtableTableAdminClient API lets us create, manage and delete tables.
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
// BigtableClient API lets us read and write to a table.
BigtableClient bigtableClient = BigtableClient.Create();
テーブルの作成
BigtableTableAdminClient
クラスの CreateTable()
メソッドを呼び出して、「Hello World」というあいさつを保存する Table
オブジェクトを生成します。このテーブルには、各値の 1 つのバージョンを保持する単一の列ファミリーがあります。
// Create a table with a single column family.
Console.WriteLine($"Create new table: {tableId} with column family: {columnFamily}, instance: {instanceId}");
// Check whether a table with given TableName already exists.
if (!TableExist(bigtableTableAdminClient))
{
bigtableTableAdminClient.CreateTable(
new InstanceName(projectId, instanceId),
tableId,
new Table
{
Granularity = Table.Types.TimestampGranularity.Millis,
ColumnFamilies =
{
{
columnFamily, new ColumnFamily
{
GcRule = new GcRule
{
MaxNumVersions = 1
}
}
}
}
});
// Confirm that table was created successfully.
Console.WriteLine(TableExist(bigtableTableAdminClient)
? $"Table {tableId} created successfully\n"
: $"There was a problem creating a table {tableId}");
}
else
{
Console.WriteLine($"Table: {tableId} already exists");
}
テーブルへの行の書き込み
テーブルに書き込むデータのソースとして、3 つの単純なあいさつを含む文字列配列 s_greetings[]
を使用します。まず、MutateRow()
を使用してテーブルに単一の行を書き込みます。次に、配列の残りの部分をループして、各あいさつのエントリを含む MutateRowsRequest
オブジェクトを作成します。MutateRows()
を使用して、すべてのエントリを一度に書き込むリクエストを行います。次に、返されたレスポンスをループ処理し、各エントリのステータス コードを調べて、正常に書き込まれたことを確認します。
// Initialize Google.Cloud.Bigtable.V2.TableName object.
Google.Cloud.Bigtable.Common.V2.TableName tableName = new Google.Cloud.Bigtable.Common.V2.TableName(projectId, instanceId, tableId);
// Write some rows
/* Each row has a unique row key.
Note: This example uses sequential numeric IDs for simplicity, but
this can result in poor performance in a production application.
Since rows are stored in sorted order by key, sequential keys can
result in poor distribution of operations across nodes.
For more information about how to design a Bigtable schema for the
best performance, see the documentation:
https://cloud.google.com/bigtable/docs/schema-design */
Console.WriteLine($"Write some greetings to the table {tableId}");
// Insert 1 row using MutateRow()
s_greetingIndex = 0;
try
{
bigtableClient.MutateRow(tableName, rowKeyPrefix + s_greetingIndex, MutationBuilder());
Console.WriteLine($"\tGreeting: -- {s_greetings[s_greetingIndex],-18}-- written successfully");
}
catch (Exception ex)
{
Console.WriteLine($"\tFailed to write greeting: --{s_greetings[s_greetingIndex]}");
Console.WriteLine(ex.Message);
throw;
}
// Insert multiple rows using MutateRows()
// Build a MutateRowsRequest (contains table name and a collection of entries).
MutateRowsRequest request = new MutateRowsRequest
{
TableNameAsTableName = tableName
};
s_mapToOriginalGreetingIndex = new List<int>();
while (++s_greetingIndex < s_greetings.Length)
{
s_mapToOriginalGreetingIndex.Add(s_greetingIndex);
// Build an entry for every greeting (consists of rowkey and a collection of mutations).
string rowKey = rowKeyPrefix + s_greetingIndex;
request.Entries.Add(Mutations.CreateEntry(rowKey, MutationBuilder()));
}
// Make the request to write multiple rows.
MutateRowsResponse response = bigtableClient.MutateRows(request);
// Check the status code of each entry to ensure that it was written successfully.
foreach (MutateRowsResponse.Types.Entry entry in response.Entries)
{
s_greetingIndex = s_mapToOriginalGreetingIndex[(int)entry.Index];
if (entry.Status.Code == 0)
{
Console.WriteLine($"\tGreeting: -- {s_greetings[s_greetingIndex],-18}-- written successfully");
}
else
{
Console.WriteLine($"\tFailed to write greeting: --{s_greetings[s_greetingIndex]}");
Console.WriteLine(entry.Status.Message);
}
}
Mutation MutationBuilder() =>
Mutations.SetCell(columnFamily, columnName, s_greetings[s_greetingIndex], new BigtableVersion(DateTime.UtcNow));
フィルタの作成
書き込んだデータを読み取る前に、Bigtable によって返されるデータを制限するためのフィルタを作成します。このフィルタは、ガベージ コレクションの対象であるがまだ削除されていない古いセルがテーブルに含まれていても、各値の最新バージョンのみを返すように Bigtable に指示します。
RowFilter filter = RowFilters.CellsPerRowLimit(1);
行キーによる行の読み取り
ReadRow()
メソッドを使用して、先ほど作成したフィルタを渡し、その行の各値の 1 つのバージョンを取得します。
// Read from the table.
Console.WriteLine("Read the first row");
int rowIndex = 0;
// Read a specific row. Apply a filter to return latest only cell value accross entire row.
Row rowRead = bigtableClient.ReadRow(
tableName, rowKey: rowKeyPrefix + rowIndex, filter: filter);
Console.WriteLine(
$"\tRow key: {rowRead.Key.ToStringUtf8()} " +
$" -- Value: {rowRead.Families[0].Columns[0].Cells[0].Value.ToStringUtf8(),-16} " +
$" -- Time Stamp: {rowRead.Families[0].Columns[0].Cells[0].TimestampMicros}");
すべてのテーブル行のスキャン
テーブル内のすべての行を取得するには、ReadRows()
メソッドを呼び出してフィルタを渡します。フィルタを渡しているため、Bigtable は各値の 1 つのバージョンのみを返します。
Console.WriteLine("Read all rows using streaming");
// stream the content of the whole table. Apply a filter to return latest only cell values accross all rows.
ReadRowsStream responseRead = bigtableClient.ReadRows(tableName, filter: filter);
Task printRead = PrintReadRowsAsync();
printRead.Wait();
async Task PrintReadRowsAsync()
{
var responseEnumerator = responseRead.GetAsyncEnumerator(default);
while (await responseEnumerator.MoveNextAsync())
{
Row row = responseEnumerator.Current;
Console.WriteLine(
$"\tRow key: {row.Key.ToStringUtf8()} " +
$" -- Value: {row.Families[0].Columns[0].Cells[0].Value.ToStringUtf8(),-16} " +
$" -- Time Stamp: {row.Families[0].Columns[0].Cells[0].TimestampMicros}");
}
}
テーブルの削除
DeleteTable()
メソッドを使用してテーブルを削除します。
// Clean up. Delete the table.
Console.WriteLine($"Delete table: {tableId}");
bigtableTableAdminClient.DeleteTable(name: tableName);
if (!TableExist(bigtableTableAdminClient))
{
Console.WriteLine($"Table: {tableId} deleted successfully");
}
すべてを組み合わせる
コメントなしの完全なコードサンプルを以下に示します。
// Copyright 2018 Google Inc.
using Google.Cloud.Bigtable.Admin.V2;
using Google.Cloud.Bigtable.V2;
using Grpc.Core;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
namespace GoogleCloudSamples.Bigtable
{
public class HelloWorld
{
private const string projectId = "YOUR-PROJECT-ID";
private const string instanceId = "YOUR-INSTANCE-ID";
private const string tableId = "Hello-Bigtable";
private const string columnFamily = "cf";
private const string columnName = "greeting";
private static readonly string[] s_greetings = { "Hello World!", "Hello Bigtable!", "Hello C#!" };
private static List<int> s_mapToOriginalGreetingIndex;
private const string rowKeyPrefix = "greeting";
private static int s_greetingIndex;
private static void DoHelloWorld()
{
try
{
BigtableTableAdminClient bigtableTableAdminClient = BigtableTableAdminClient.Create();
BigtableClient bigtableClient = BigtableClient.Create();
Console.WriteLine($"Create new table: {tableId} with column family: {columnFamily}, instance: {instanceId}");
if (!TableExist(bigtableTableAdminClient))
{
bigtableTableAdminClient.CreateTable(
new InstanceName(projectId, instanceId),
tableId,
new Table
{
Granularity = Table.Types.TimestampGranularity.Millis,
ColumnFamilies =
{
{
columnFamily, new ColumnFamily
{
GcRule = new GcRule
{
MaxNumVersions = 1
}
}
}
}
});
Console.WriteLine(TableExist(bigtableTableAdminClient)
? $"Table {tableId} created successfully\n"
: $"There was a problem creating a table {tableId}");
}
else
{
Console.WriteLine($"Table: {tableId} already exists");
}
Google.Cloud.Bigtable.Common.V2.TableName tableName = new Google.Cloud.Bigtable.Common.V2.TableName(projectId, instanceId, tableId);
Note: This example uses sequential numeric IDs for simplicity, but
this can result in poor performance in a production application.
Since rows are stored in sorted order by key, sequential keys can
result in poor distribution of operations across nodes.
For more information about how to design a Bigtable schema for the
best performance, see the documentation:
https://cloud.google.com/bigtable/docs/schema-design */
Console.WriteLine($"Write some greetings to the table {tableId}");
s_greetingIndex = 0;
try
{
bigtableClient.MutateRow(tableName, rowKeyPrefix + s_greetingIndex, MutationBuilder());
Console.WriteLine($"\tGreeting: -- {s_greetings[s_greetingIndex],-18}-- written successfully");
}
catch (Exception ex)
{
Console.WriteLine($"\tFailed to write greeting: --{s_greetings[s_greetingIndex]}");
Console.WriteLine(ex.Message);
throw;
}
MutateRowsRequest request = new MutateRowsRequest
{
TableNameAsTableName = tableName
};
s_mapToOriginalGreetingIndex = new List<int>();
while (++s_greetingIndex < s_greetings.Length)
{
s_mapToOriginalGreetingIndex.Add(s_greetingIndex);
string rowKey = rowKeyPrefix + s_greetingIndex;
request.Entries.Add(Mutations.CreateEntry(rowKey, MutationBuilder()));
}
MutateRowsResponse response = bigtableClient.MutateRows(request);
foreach (MutateRowsResponse.Types.Entry entry in response.Entries)
{
s_greetingIndex = s_mapToOriginalGreetingIndex[(int)entry.Index];
if (entry.Status.Code == 0)
{
Console.WriteLine($"\tGreeting: -- {s_greetings[s_greetingIndex],-18}-- written successfully");
}
else
{
Console.WriteLine($"\tFailed to write greeting: --{s_greetings[s_greetingIndex]}");
Console.WriteLine(entry.Status.Message);
}
}
Mutation MutationBuilder() =>
Mutations.SetCell(columnFamily, columnName, s_greetings[s_greetingIndex], new BigtableVersion(DateTime.UtcNow));
RowFilter filter = RowFilters.CellsPerRowLimit(1);
Console.WriteLine("Read the first row");
int rowIndex = 0;
Row rowRead = bigtableClient.ReadRow(
tableName, rowKey: rowKeyPrefix + rowIndex, filter: filter);
Console.WriteLine(
$"\tRow key: {rowRead.Key.ToStringUtf8()} " +
$" -- Value: {rowRead.Families[0].Columns[0].Cells[0].Value.ToStringUtf8(),-16} " +
$" -- Time Stamp: {rowRead.Families[0].Columns[0].Cells[0].TimestampMicros}");
Console.WriteLine("Read all rows using streaming");
ReadRowsStream responseRead = bigtableClient.ReadRows(tableName, filter: filter);
Task printRead = PrintReadRowsAsync();
printRead.Wait();
async Task PrintReadRowsAsync()
{
var responseEnumerator = responseRead.GetAsyncEnumerator(default);
while (await responseEnumerator.MoveNextAsync())
{
Row row = responseEnumerator.Current;
Console.WriteLine(
$"\tRow key: {row.Key.ToStringUtf8()} " +
$" -- Value: {row.Families[0].Columns[0].Cells[0].Value.ToStringUtf8(),-16} " +
$" -- Time Stamp: {row.Families[0].Columns[0].Cells[0].TimestampMicros}");
}
}
Console.WriteLine($"Delete table: {tableId}");
bigtableTableAdminClient.DeleteTable(name: tableName);
if (!TableExist(bigtableTableAdminClient))
{
Console.WriteLine($"Table: {tableId} deleted successfully");
}
}
catch (Exception ex)
{
Console.WriteLine($"Exception while running HelloWorld: {ex.Message}");
}
}
private static bool TableExist(BigtableTableAdminClient bigtableTableAdminClient)
{
GetTableRequest request = new GetTableRequest
{
TableName = new Google.Cloud.Bigtable.Common.V2.TableName(projectId, instanceId, tableId),
View = Table.Types.View.NameOnly
};
try
{
var tables = bigtableTableAdminClient.GetTable(request);
return true;
}
catch (RpcException ex)
{
if (ex.StatusCode == StatusCode.NotFound)
{
return false;
}
throw;
}
}
public static int Main(string[] args)
{
if (projectId == "YOUR-PROJECT" + "-ID")
{
Console.WriteLine("Edit HelloWorld.cs and replace YOUR-PROJECT-ID with your project ID.");
return -1;
}
if (instanceId == "YOUR-INSTANCE" + "-ID")
{
Console.WriteLine("Edit HelloWorld.cs and replace YOUR-INSTANCE-ID with your instance ID.");
return -1;
}
DoHelloWorld();
return 0;
}
}
}