目標
このチュートリアルでは、C# 用の Spanner クライアント ライブラリを使用する以下の手順について説明します。
- Spanner のインスタンスとデータベースを作成します。
- データベースのデータに対し、書き込み、読み取り、SQL クエリの実行を行います。
- データベース スキーマを更新します。
- 読み取り / 書き込みトランザクションを使用してデータを更新します。
- セカンダリ インデックスをデータベースに追加します。
- インデックスを使用して、データの読み込みと SQL クエリの実行を行います。
- 読み取り専用トランザクションを使用してデータを取得します。
費用
このチュートリアルで使用する Spanner は、Google Cloud の有料コンポーネントです。Spanner を使用する際の料金については、料金をご覧ください。
始める前に
設定に示されている手順を完了します。この手順では、デフォルトの Google Cloud プロジェクトの作成と設定、課金の有効化、Cloud Spanner API の有効化、Cloud Spanner API の使用に必要な認証情報を取得するための OAuth 2.0 の設定について説明しています。
特に、ローカルの開発環境に認証情報を設定するために、必ず gcloud auth
application-default login
を実行してください。
ローカルの C# 環境を準備する
環境変数
GOOGLE_PROJECT_ID
に Google Cloud プロジェクト ID を設定します。まず、現在の PowerShell セッションに
GOOGLE_PROJECT_ID
を設定します。$env:GOOGLE_PROJECT_ID = "MY_PROJECT_ID"
次に、このコマンドの後に作成されたすべてのプロセスに
GOOGLE_PROJECT_ID
を設定します。[Environment]::SetEnvironmentVariable("GOOGLE_PROJECT_ID", "MY_PROJECT_ID", "User")
認証情報をダウンロードします。
Google Cloud Console の [認証情報] ページに移動します。
[認証情報を作成] をクリックし、[サービス アカウント キー] を選択します。
[サービス アカウント] で [Compute Engine のデフォルトのサービス アカウント] を選択し、[キーのタイプ] では [JSON] を選択したままにします。[作成] をクリックします。JSON ファイルがダウンロードされます。
認証情報を設定します。
C
ドライブ上のCURRENT_USER
のダウンロード ディレクトリにあるFILENAME.json
という名前のファイルに対して次のコマンドを実行することにより、GOOGLE_APPLICATION_CREDENTIALS
が JSON キーを指すように設定します。この PowerShell セッションの
GOOGLE_APPLICATION_CREDENTIALS
を設定します。$env:GOOGLE_APPLICATION_CREDENTIALS = "C:\Users\CURRENT_USER\Downloads\FILENAME.json"
次に、このコマンドの後に作成されたすべてのプロセス用の
GOOGLE_APPLICATION_CREDENTIALS
を設定します。[Environment]::SetEnvironmentVariable("GOOGLE_APPLICATION_CREDENTIALS", "C:\Users\CURRENT_USER\Downloads\FILENAME.json", "User")
ローカルマシンにサンプルアプリのレポジトリのクローンを作成します。
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples
または、zip ファイル形式のサンプルをダウンロードし、展開します。
ダウンロードしたリポジトリの
dotnet-docs-samples\spanner\api
ディレクトリ内にあるSpanner.sln
を Visual Studio 2017 以降で開き、ビルドします。ダウンロードしたリポジトリ内で、コンパイル済みアプリケーションが含まれているディレクトリに移動します。次に例を示します。
cd dotnet-docs-samples\spanner\api\Spanner
インスタンスを作成する
Spanner を最初に使用する場合は、インスタンスを作成する必要があります。インスタンスとは、Spanner データベースによって使用されるリソースの割り当てのことです。インスタンスを作成するときは、インスタンス構成を選択してデータの格納場所を指定し、さらに使用するノード数も選択して、インスタンスの配信リソースおよびストレージ リソースの量を決定します。
次のコマンドを実行して、1 ノードの us-central1
リージョンに Spanner インスタンスを作成します。
gcloud spanner instances create test-instance --config=regional-us-central1 `
--description="Test Instance" --nodes=1
これにより、次の特性を持つインスタンスが作成されます。
- インスタンス ID
test-instance
- 表示名
Test Instance
- インスタンス構成
regional-us-central1
(リージョン構成ではデータが単一のリージョンに保存され、マルチリージョン構成ではデータが複数のリージョンに分散されます。詳しくは、インスタンスについてをご覧ください)。 - ノード数 1(
node_count
はインスタンスのデータベースで使用可能な配信リソースとストレージ リソースの量に対応します。詳しくは、ノードと処理ユニットをご覧ください)。
以下のように表示されます。
Creating instance...done.
サンプル ファイルの確認
サンプル リポジトリには、C# で Spanner を使用する方法を示すサンプルが含まれています。
Spanner .NET GitHub リポジトリを確認してください。データベースの作成方法とデータベース スキーマの変更方法が示されています。データで使用されているスキーマ例の詳細は、スキーマとデータモデルのページをご覧ください。
データベースの作成
コマンドラインで次のコマンドを実行して、test-instance
というインスタンスに example-db
というデータベースを作成します。
dotnet run createSampleDatabase $env:GOOGLE_PROJECT_ID test-instance example-db
次のように表示されます。
Created sample database example-db on instance test-instance
次のステップでは、データベースにデータを書き込みます。
データベース クライアントの作成
読み取りまたは書き込みを行うには、その前に SpannerConnection
を作成する必要があります。
SpannerConnection
はデータベース接続と考えることができます。Spanner とのすべてのやり取りは SpannerConnection
を経由する必要があります。
詳細については、SpannerConnection
のリファレンスをご覧ください。
DML でのデータの書き込み
読み取り / 書き込みトランザクションでデータ操作言語(DML)を使用してデータを挿入できます。
ExecuteNonQueryAsync()
メソッドを使用して DML ステートメントを実行します。
writeUsingDml
引数を使用してサンプルを実行します。
dotnet run writeUsingDml $env:GOOGLE_PROJECT_ID test-instance example-db
次のように表示されます。
4 row(s) inserted...
ミューテーションを使用してデータを書き込む
ミューテーションを使ってデータを挿入することもできます。
データを挿入するには、connection.CreateInsertCommand()
メソッドを使用します。このメソッドでは、行をテーブルに挿入するための新しい SpannerCommand
を作成します。SpannerCommand.ExecuteNonQueryAsync()
メソッドを使用すると、テーブルに新しい行を追加できます。
次のコードは、ミューテーションを使用してデータを挿入する方法を示しています。
insertSampleData
引数を使用してサンプルを実行します。
dotnet run insertSampleData $env:GOOGLE_PROJECT_ID test-instance example-db
次のように表示されます。
Inserted data.
SQL を使用したデータのクエリ
Spanner では、データの読み取り用に SQL インターフェースがサポートされています。このインターフェースにアクセスするには、コマンドラインで Google Cloud CLI を使用するか、プログラムで C# 用の Spanner クライアント ライブラリを使用します。
コマンドラインから
Albums
テーブルのすべての列から値を読み取るには、次の SQL ステートメントを実行します。
gcloud spanner databases execute-sql example-db --instance=test-instance `
--sql='SELECT SingerId, AlbumId, AlbumTitle FROM Albums'
結果は次のようになります。
SingerId AlbumId AlbumTitle
1 1 Total Junk
1 2 Go, Go, Go
2 1 Green
2 2 Forever Hold Your Peace
2 3 Terrified
C# 用の Spanner クライアント ライブラリを使用する
コマンドラインで SQL ステートメントを実行するだけでなく、プログラムから C# 用 Spanner クライアント ライブラリを使用して同じ SQL ステートメントを発行することもできます。
SQL クエリを実行するには、ExecuteReaderAsync()
を使用します。
クエリを発行してデータにアクセスする方法を次に示します。
dotnet run querySampleData $env:GOOGLE_PROJECT_ID test-instance example-db
次のような結果が表示されます。
SingerId: 1 AlbumId: 1 AlbumTitle: Total Junk
SingerId: 1 AlbumId: 2 AlbumTitle: Go, Go, Go
SingerId: 2 AlbumId: 1 AlbumTitle: Green
SingerId: 2 AlbumId: 2 AlbumTitle: Forever Hold your Peace
SingerId: 2 AlbumId: 3 AlbumTitle: Terrified
SQL パラメータを使用したクエリ
アプリケーションに頻繁に実行されるクエリがある場合は、対象のクエリをパラメータ化してパフォーマンスを改善できます。パラメータ クエリをキャッシュに保存して再利用できます。これにより、コンパイルのコストを削減できます。詳細については、クエリ パラメータを使用して、頻繁に実行するクエリを高速化するをご覧ください。
ここでは、WHERE
句のパラメータを使用して、LastName
の特定の値を含むレコードをクエリします。
パラメータ付きのクエリでデータにアクセスするには、次のコマンドを実行します。
dotnet run queryWithParameter $env:GOOGLE_PROJECT_ID test-instance example-db
次のような結果が表示されます。
SingerId : 12 FirstName : Melissa LastName : Garcia
データベース スキーマの更新
MarketingBudget
という列を新たに Albums
テーブルに追加する必要があるとします。既存のテーブルに新しい列を追加するには、データベース スキーマの更新が必要です。Spanner は、データベースがトラフィックの処理を継続している間にデータベースのスキーマを更新することをサポートしています。スキーマの更新では、データベースをオフラインにする必要がなく、テーブル全体または列全体をロックすることもありません。スキーマの更新中もデータベースへのデータの書き込みを続けることができます。サポートされるスキーマの更新とスキーマ変更のパフォーマンスの詳細については、スキーマの更新をご覧ください。
列の追加
列を追加するには、コマンドラインで Google Cloud CLI を使用するか、プログラムから C# 用 Spanner クライアント ライブラリを使用します。
コマンドラインから
テーブルに新しい列を追加するには、次の ALTER TABLE
コマンドを使用します。
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'
次のように表示されます。
Schema updating...done.
C# 用の Spanner クライアント ライブラリを使用する
スキーマを変更するには、CreateDdlCommand()
を使用します。
addColumn
コマンドを使用してサンプルを実行します。
dotnet run addColumn $env:GOOGLE_PROJECT_ID test-instance example-db
以下のように表示されます。
Added the MarketingBudget column.
新しい列へのデータの書き込み
次のコードは、新しい列にデータを書き込みます。MarketingBudget
の値を、キーが Albums(1, 1)
の行は 100000
に、キーが Albums(2, 2)
の行は 500000
に設定します。
writeDataToNewColumn
コマンドを使用してサンプルを実行します。
dotnet run writeDataToNewColumn $env:GOOGLE_PROJECT_ID test-instance example-db
以下のように表示されます。
Updated data.
さらに、SQL クエリを実行して、書き込んだばかりの値を取得することもできます。
クエリを実行するコードを次に示します。
このクエリを実行するには、queryNewColumn
引数を使用してサンプルを実行します。
dotnet run queryNewColumn $env:GOOGLE_PROJECT_ID test-instance example-db
以下のように表示されます。
SingerId : 1 AlbumId : 1 MarketingBudget : 100000
SingerId : 1 AlbumId : 2 MarketingBudget :
SingerId : 2 AlbumId : 1 MarketingBudget :
SingerId : 2 AlbumId : 2 MarketingBudget : 500000
SingerId : 2 AlbumId : 3 MarketingBudget :
データの更新
読み取り / 書き込みトランザクションで DML を使用してデータを更新できます。
ExecuteNonQueryAsync()
メソッドを使用して DML ステートメントを実行します。
writeWithTransactionUsingDml
引数を使用してサンプルを実行します。
dotnet run writeWithTransactionUsingDml $env:GOOGLE_PROJECT_ID test-instance example-db
次のように表示されます。
Transaction complete.
セカンダリ インデックスの使用
Albums
から AlbumTitle
の値が特定の範囲内にある行すべてを取得すると仮定します。SQL ステートメントまたは読み取り呼び出しを使用して AlbumTitle
列からすべての値を読み取り、基準を満たしていない行を破棄することもできますが、このようなテーブル全体のスキャンは割高です(特に、行数が多いテーブルの場合)。代わりに、テーブルにセカンダリ インデックスを作成することにより、主キー以外の列を検索するときの行の取得速度を上げることができます。
既存のテーブルにセカンダリ インデックスを追加するには、スキーマの更新が必要です。他のスキーマの更新と同様に、Spanner ではデータベースがトラフィックの処理を継続している間にインデックスを追加できます。Spanner では、インデックスに既存のデータが自動的にバックフィルされます。バックフィルには数分かかることがありますが、このプロセスの間に、データベースをオフラインにしたり、インデックス化対象のテーブルへの書き込みを控えたりする必要はありません。詳しくは、セカンダリ インデックスを追加するをご覧ください。
セカンダリ インデックスを追加すると、インデックス効果で実行速度が上がりそうな SQL クエリに対して Spanner ではそのセカンダリ インデックスが自動的に使用されるようになります。読み取りインターフェースを使用する場合は、使用するインデックスを指定する必要があります。
セカンダリ インデックスの追加
コマンドラインでインデックスを追加するには、gcloud CLI を使用するか、プログラムから C# 用 Spanner クライアント ライブラリを使用します。
コマンドラインから
データベースにインデックスを追加するには、次の CREATE INDEX
コマンドを使用します。
gcloud spanner databases ddl update example-db --instance=test-instance `
--ddl='CREATE INDEX AlbumsByAlbumTitle ON Albums(AlbumTitle)'
以下のように表示されます。
Schema updating...done.
C# 用 Spanner クライアント ライブラリの使用
インデックスを追加するには、CreateDdlCommand()
を使用します。
addIndex
コマンドを使用してサンプルを実行します。
dotnet run addIndex $env:GOOGLE_PROJECT_ID test-instance example-db
インデックスの追加には数分かかる場合があります。インデックスが追加されると、次のように表示されます。
Added the AlbumsByAlbumTitle index.
インデックス限定読み取り用のインデックスを追加する
上記の読み取り例には、MarketingBudget
列の読み取りが含まれていませんでした。これは、Spanner の読み取りインターフェースが、インデックスとデータテーブルを結合してインデックスに格納されていない値を検索する機能をサポートしていないためです。
MarketingBudget
のコピーをインデックスに格納する AlbumsByAlbumTitle
の代替定義を作成します。
コマンドラインから
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)
インデックスの追加には数分かかる場合があります。インデックスが追加されると、次のように表示されます。
Schema updating...done.
C# 用 Spanner クライアント ライブラリの使用
CreateDdlCommand()
を使用し、STORING
句を指定してインデックスを追加します。
addStoringIndex
コマンドを使用してサンプルを実行します。
dotnet run addStoringIndex $env:GOOGLE_PROJECT_ID test-instance example-db
以下のように表示されます。
Added the AlbumsByAlbumTitle2 index.
これで、インデックス AlbumsByAlbumTitle2
から AlbumId
、AlbumTitle
、MarketingBudget
列をすべて取得する読み取りを実行できるようになりました。
作成した Storing インデックスを使用してデータを読み取るには、インデックスを明示的に指定するクエリを実行します。
queryDataWithStoringIndex
コマンドを使用してサンプルを実行します。
dotnet run queryDataWithStoringIndex $env:GOOGLE_PROJECT_ID test-instance example-db
次のような出力が表示されます。
AlbumId : 2 AlbumTitle : Forever Hold your Peace MarketingBudget : 300000
AlbumId : 2 AlbumTitle : Go, Go, Go MarketingBudget : 300000
読み取り専用トランザクションを使用したデータの取得
同じタイムスタンプで複数の読み取りを実行する場合について考えます。読み取り専用トランザクションは、トランザクションの commit 履歴で整合性のあるプレフィックスを監視しているため、アプリケーションは常に整合性のあるデータを取得できます。読み取り専用トランザクションを実行するには、.NET Framework の TransactionScope()
と OpenAsReadOnlyAsync()
を一緒に使用します。
同じ読み取り専用トランザクションでクエリと読み取りを実行する方法を次に示します。
.NET Standard 2.0
.NET Standard 1.5
queryDataWithTransaction
コマンドを使用してサンプルを実行します。
dotnet run queryDataWithTransaction $env:GOOGLE_PROJECT_ID test-instance example-db
次のような出力が表示されます。
SingerId : 2 AlbumId : 2 AlbumTitle : Forever Hold your Peace
SingerId : 1 AlbumId : 2 AlbumTitle : Go, Go, Go
SingerId : 2 AlbumId : 1 AlbumTitle : Green
SingerId : 2 AlbumId : 3 AlbumTitle : Terrified
SingerId : 1 AlbumId : 1 AlbumTitle : Total Junk
SingerId : 2 AlbumId : 2 AlbumTitle : Forever Hold your Peace
SingerId : 1 AlbumId : 2 AlbumTitle : Go, Go, Go
SingerId : 2 AlbumId : 1 AlbumTitle : Green
SingerId : 2 AlbumId : 3 AlbumTitle : Terrified
SingerId : 1 AlbumId : 1 AlbumTitle : Total Junk
クリーンアップ
このチュートリアルで使用したリソースについて Cloud 請求先アカウントに課金されないようにするため、作成したデータベースとインスタンスを削除します。
データベースの削除
インスタンスを削除すると、それに含まれるすべてのデータベースが自動的に削除されます。このステップでは、インスタンスを削除しないでデータベースを削除する方法を示します(インスタンスの料金は引き続き発生します)。
コマンドラインから
gcloud spanner databases delete example-db --instance=test-instance
Google Cloud コンソールの使用
Google Cloud コンソールで、[Spanner インスタンス] ページに移動します。
インスタンスをクリックします。
削除するデータベースをクリックします。
[データベースの詳細] ページで [削除] をクリックします。
データベースを削除することを確認し、[削除] をクリックします。
インスタンスを削除する
インスタンスを削除すると、そのインスタンスで作成されたすべてのデータベースが自動的に削除されます。
コマンドラインから
gcloud spanner instances delete test-instance
Google Cloud コンソールの使用
Google Cloud コンソールで、[Spanner インスタンス] ページに移動します。
インスタンスをクリックします。
[削除] をクリックします。
インスタンスを削除することを確認し、[削除] をクリックします。
次のステップ
- Entity Framework Core の Spanner データベース プロバイダのプレビュー リリースを試します。
仮想マシン インスタンスで Spanner にアクセスする方法を確認する。
クライアント ライブラリを使用して Cloud サービスに対する認証を行うで、承認と認証情報について学習する。
Spanner のスキーマ設計のベスト プラクティスを確認する。