Tablestore .NET SDK を使用して、Wide Column モデルのテーブル内のデータを管理します。
クイックスタート
Tablestore .NET SDK の使用を開始します。環境をセットアップし、SDK をインストールして、クライアントを初期化します。
前提条件
この SDK は .NET Standard 2.0 をベースに構築されており、次のプラットフォームとランタイムをサポートしています。
|
プラットフォーム |
ランタイム |
|
Windows |
|
|
Linux および macOS |
|
SDK のインストール
Tablestore .NET SDK を NuGet またはソースコードからインストールします。
NuGet
.NET CLI でインストールします:
dotnet add package Aliyun.TableStore.SDK
または、Visual Studio の NuGet パッケージ マネージャーからインストールします:
-
Visual Studio でプロジェクトを開くか作成し、[ツール] > [NuGet パッケージ マネージャー] > [ソリューションの NuGet パッケージの管理] を選択します。
説明Visual Studio に NuGet がインストールされていない場合は、NuGet からダウンロードしてインストールしてください。
aliyun.tablestoreを検索し、結果からAliyun.TableStore.SDKを選択します。最新バージョンを選択し、[インストール] をクリックします。SDK は自動的にプロジェクトに追加されます。
ソースコード
SDK のソースコードをプロジェクトにインポートします。
-
GitHub から SDK リポジトリをクローンします:
git clone https://github.com/aliyun/aliyun-tablestore-csharp-sdk.git説明Git がインストールされていない場合は、Git からダウンロードしてインストールしてください。
Visual Studio で [ソリューション] を右クリックし、[追加] > [既存のプロジェクト] を選択します。
ダイアログボックスで、
aliyun-tablestore-sdk.csprojファイルを選択し、[開く] をクリックします。[Project] を右クリックし、[参照] > [参照の追加] を選択します。ダイアログボックスで [Projects] タブに切り替え、[aliyun-tablestore-sdk] を選択します。
[OK] をクリックします。
アクセス認証情報の設定
Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey を作成できます。次に、以下に示すように環境変数に AccessKey を設定します。環境変数に AccessKey を設定すると、機密情報がコードにハードコーディングされるのを防ぐことができるため、セキュリティが向上します。
設定が完了したら、IDE、コマンドラインインターフェイス、その他のデスクトップアプリケーション、バックグラウンドサービスなど、開発環境を再起動またはリフレッシュする必要があります。これにより、最新のシステム環境変数が確実に読み込まれます。他の種類のアクセス認証情報の詳細については、「アクセス認証情報の設定」をご参照ください。
Linux
次のコマンドを実行して、環境変数の設定を
~/.bashrcファイルに追加します。echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc次のコマンドを実行して変更を適用します。
source ~/.bashrc次のコマンドを実行して、環境変数が有効であることを確認します。
echo $TABLESTORE_ACCESS_KEY_ID echo $TABLESTORE_ACCESS_KEY_SECRET
macOS
ターミナルで次のコマンドを実行して、デフォルトのシェルタイプを表示します。
echo $SHELLデフォルトのシェルタイプに基づいて、次の操作を実行します。
Zsh
次のコマンドを実行して、環境変数の設定を
~/.zshrcファイルに追加します。echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc次のコマンドを実行して変更を適用します。
source ~/.zshrc次のコマンドを実行して、環境変数が有効であることを確認します。
echo $TABLESTORE_ACCESS_KEY_ID echo $TABLESTORE_ACCESS_KEY_SECRET
Bash
次のコマンドを実行して、環境変数の設定を
~/.bash_profileファイルに追加します。echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bash_profile echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bash_profile次のコマンドを実行して変更を適用します。
source ~/.bash_profile次のコマンドを実行して、環境変数が有効であることを確認します。
echo $TABLESTORE_ACCESS_KEY_ID echo $TABLESTORE_ACCESS_KEY_SECRET
Windows
CMD
コマンドプロンプト (CMD) で次のコマンドを実行して、環境変数を設定します。
setx TABLESTORE_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID" setx TABLESTORE_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"CMD を再起動し、次のコマンドを実行して、環境変数が有効であることを確認します。
echo %TABLESTORE_ACCESS_KEY_ID% echo %TABLESTORE_ACCESS_KEY_SECRET%
PowerShell
PowerShell で次のコマンドを実行します。
[Environment]::SetEnvironmentVariable("TABLESTORE_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User) [Environment]::SetEnvironmentVariable("TABLESTORE_ACCESS_KEY_SECRET", "YOUR_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)次のコマンドを実行して、環境変数が有効であることを確認します。
[Environment]::GetEnvironmentVariable("TABLESTORE_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User) [Environment]::GetEnvironmentVariable("TABLESTORE_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)
クライアントの初期化
Tablestore .NET SDK はスレッドセーフです。複数のスレッドを使用する場合は、単一の OTSClient インスタンスを共有してください。クライアントを初期化した後、インスタンス内のすべてのテーブルをリスト表示して、接続を確認します。
新規インスタンスでは、パブリックネットワークアクセスはデフォルトで無効になっています。パブリックネットワーク経由でインスタンスリソースにアクセスするには、ネットワーク管理 でパブリックアクセスを有効にしてください。
using System;
using Aliyun.OTS;
using Aliyun.OTS.Request;
using Aliyun.OTS.Response;
namespace Aliyun.OTS.Samples
{
public class Sample
{
public static void InitializeClient()
{
// yourEndpoint をインスタンスのエンドポイントに置き換えます
string endpoint = "yourEndpoint";
// yourInstanceName をインスタンス名に置き換えます
string instanceName = "yourInstanceName";
// 環境変数から AccessKey ID と AccessKey Secret を取得します
string accessKeyId = Environment.GetEnvironmentVariable("TABLESTORE_ACCESS_KEY_ID");
string accessKeySecret = Environment.GetEnvironmentVariable("TABLESTORE_ACCESS_KEY_SECRET");
OTSClientConfig config = new OTSClientConfig(endpoint, accessKeyId, accessKeySecret, instanceName)
{
OTSDebugLogHandler = null,
OTSErrorLogHandler = null
};
try
{
// Tablestore クライアントを初期化します
OTSClient client = new OTSClient(config);
// インスタンス内のすべてのテーブルをリスト表示して出力します
ListTableResponse response = client.ListTable(new ListTableRequest());
foreach (var tableName in response.TableNames)
{
Console.WriteLine(tableName);
}
}
catch (Exception ex)
{
Console.WriteLine("テーブルのリスト表示に失敗しました。例外:{0}", ex.Message);
}
}
}
}
バージョン互換性
最新の SDK バージョンは 6.x.x です。以前のバージョンとの互換性は次のとおりです:
|
バージョン |
互換性 |
説明 |
|
5.x.x |
互換性あり |
該当なし |
|
4.x.x |
互換性あり |
該当なし |
|
3.x.x |
互換性あり |
該当なし |
|
2.x.x |
互換性なし |
以下のインターフェイスが削除されました: |
詳細なバージョン履歴については、「Tablestore .NET SDK のバージョン履歴」をご参照ください。
よくある質問
Tablestore .NET SDK に関する一般的な問題:
関連情報
Tablestore でのエラー処理に関する情報については、「エラー処理」をご参照ください。