Tablestore:データを書き込む

API操作

/// <summary>
/// 指定されたテーブル名、プライマリキー、および属性に基づいてデータの行を書き込みます。操作で消費される容量ユニット（CU）の数が返されます。
/// </summary>
/// <param name="request">データ挿入リクエスト</param>
/// <returns>操作で消費されるCUの数</returns>
public PutRowResponse PutRow(PutRowRequest request);

/// <summary>
/// PutRowの非同期モード。
/// </summary>
public Task<PutRowResponse> PutRowAsync(PutRowRequest request);                    

パラメーター

例

// 行のプライマリキーを指定します。プライマリキーのスキーマは、テーブルの作成時にTableMetaで指定されたスキーマと同じである必要があります。
var primaryKey = new PrimaryKey();
primaryKey.Add("pk0", new ColumnValue(0));
primaryKey.Add("pk1", new ColumnValue("abc"));

// 行の属性列を指定します。
var attribute = new AttributeColumns();
attribute.Add("col0", new ColumnValue(0));
attribute.Add("col1", new ColumnValue("a"));
attribute.Add("col2", new ColumnValue(true));

try
{
    // データ行を挿入するためのリクエストオブジェクトを構築します。RowExistenceExpectation.IGNOREは、指定された行が存在するかどうかに関係なくデータが挿入されることを指定します。
    var request = new PutRowRequest("SampleTable", new Condition(RowExistenceExpectation.IGNORE),
                            primaryKey, attribute);

    // PutRow操作を呼び出してデータを挿入します。
    otsClient.PutRow(request);

    // 操作が成功すると、例外は返されません。
    Console.WriteLine("Put row succeeded.");
}
catch (Exception ex)
{
    // 操作が失敗すると、例外が返されます。例外を処理します。
    Console.WriteLine("Put row failed, exception:{0}", ex.Message);
}                    

// 行のプライマリキーを指定します。プライマリキーのスキーマは、テーブルの作成時にTableMetaで指定されたスキーマと同じである必要があります。
var primaryKey = new PrimaryKey();
primaryKey.Add("pk0", new ColumnValue(0));
primaryKey.Add("pk1", new ColumnValue("abc"));

// 行の属性列を指定します。
AttributeColumns attribute = new AttributeColumns();
attribute.Add("col0", new ColumnValue(0));
attribute.Add("col1", new ColumnValue("a"));
attribute.Add("col2", new ColumnValue(true));

// col0列の値が24より大きい場合、元の値を上書きするために、行を挿入できます。
try
{
    var request = new PutRowRequest("SampleTable", new Condition(RowExistenceExpectation.EXPECT_EXIST),
                            primaryKey, attribute);
    request.Condition.ColumnCondition = new RelationalCondition("col0",
                                        CompareOperator.GREATER_THAN,
                                        new ColumnValue(24));
    otsClient.PutRow(request);

    Console.WriteLine("Put row succeeded.");
}
catch (Exception ex)
{
    Console.WriteLine("Put row failed. error:{0}", ex.Message);
}                   

try
{
    var putRowTaskList = new List<Task<PutRowResponse>>();
    for (int i = 0; i < 100; i++)
    {
        // 行のプライマリキーを指定します。プライマリキーのスキーマは、テーブルの作成時にTableMetaで指定されたスキーマと同じである必要があります。
        var primaryKey = new PrimaryKey();
        primaryKey.Add("pk0", new ColumnValue(i));
        primaryKey.Add("pk1", new ColumnValue("abc"));

        // 行の属性列を指定します。
        var attribute = new AttributeColumns();
        attribute.Add("col0", new ColumnValue(i));
        attribute.Add("col1", new ColumnValue("a"));
        attribute.Add("col2", new ColumnValue(true));

        var request = new PutRowRequest("SampleTable", new Condition(RowExistenceExpectation.IGNORE),
                                        primaryKey, attribute);

        putRowTaskList.Add(otsClient.PutRowAsync(request));
    }

    // 各非同期呼び出しが結果を返し、消費されたCUを表示するまで待機します。
    foreach (var task in putRowTaskList)
    {
        task.Wait();
        Console.WriteLine("consumed read:{0}, write:{1}", task.Result.ConsumedCapacityUnit.Read,
                            task.Result.ConsumedCapacityUnit.Write);
    }

    // 操作が成功すると、例外は返されません。
    Console.WriteLine("Put row async succeeded.");
}
catch (Exception ex)
{
    // 操作が失敗すると、例外が返されます。例外を処理します。
    Console.WriteLine("Put row async failed. exception:{0}", ex.Message);
}                   

API 操作

/// <summary>
/// 特定の行のデータを更新するためにこの操作を呼び出すことができます。行が存在しない場合は、新しい行が追加されます。行が存在する場合は、リクエストの内容に基づいて、指定された列の値が追加、変更、または削除されます。
/// </summary>
/// <param name="request">リクエストインスタンス。</param>
public UpdateRowResponse UpdateRow(UpdateRowRequest request);

/// <summary>
/// UpdateRow の非同期モード。
/// </summary>
/// <param name="request"></param>
/// <returns></returns>
public Task<UpdateRowResponse> UpdateRowAsync(UpdateRowRequest request);            

パラメーター

例

次のサンプルコードは、1 行のデータを更新する方法の例を示しています。

// 行のプライマリキーを指定します。プライマリキーのスキーマは、テーブルの作成時に TableMeta で指定されたスキーマと同じである必要があります。
PrimaryKey primaryKey = new PrimaryKey();
primaryKey.Add("pk0", new ColumnValue(0));
primaryKey.Add("pk1", new ColumnValue("abc"));

// 行の属性列を指定します。
UpdateOfAttribute attribute = new UpdateOfAttribute();
attribute.AddAttributeColumnToPut("col0", new ColumnValue(0));
attribute.AddAttributeColumnToPut("col1", new ColumnValue("b")); // 列の値を a から b に変更します。
attribute.AddAttributeColumnToPut("col2", new ColumnValue(true));

try
{
    // 行を更新するためのリクエストオブジェクトを構築します。RowExistenceExpectation.IGNORE は、指定された行が存在するかどうかに関係なくデータが更新されることを指定します。
    var request = new UpdateRowRequest("SampleTable", new Condition(RowExistenceExpectation.IGNORE),
                                primaryKey, attribute);
    // UpdateRow 操作を呼び出してデータを更新します。
    otsClient.UpdateRow(request);

    // 操作が成功した場合、例外は返されません。
    Console.WriteLine("Update row succeeded.");
}
catch (Exception ex)
{
    // 操作が失敗した場合、例外が返されます。例外を処理します。
    Console.WriteLine("Update row failed, exception:{0}", ex.Message);
}           

詳細なサンプルコードについては、UpdateRow@GitHubをご覧ください。

使用上の注意

API操作

/// <summary>
/// <para>1つ以上のテーブルの複数行のデータを挿入、変更、または削除します。</para>
/// <para>BatchWriteRow操作は、複数のPutRow、UpdateRow、およびDeleteRow操作のセットです。個々の操作の実行、結果の返却、および容量ユニット（CU）の消費は、独立して実行されます。</para>
/// <para>多数の単一行書き込み操作の実行と比較して、BatchWriteRowを使用すると、リクエストの応答時間を短縮し、データ書き込み速度を向上させることができます。</para>
/// </summary>
/// <param name="request">リクエストインスタンス。</param>
/// <returns>レスポンスインスタンス</returns>
public BatchWriteRowResponse BatchWriteRow(BatchWriteRowRequest request);

/// <summary>
/// BatchWriteRowの非同期モード。
/// </summary>
/// <param name="request"></param>
/// <returns></returns>
public Task<BatchWriteRowResponse> BatchWriteRowAsync(BatchWriteRowRequest request);            

例

次のサンプルコードは、100行のデータを同時に書き込む方法の例を示しています。

var TableName = "SampleTable";
// 100 行のデータを同時に書き込むリクエストオブジェクトを構築します。100 行のデータのプライマリキーを指定します。
var request = new BatchWriteRowRequest();
var rowChanges = new RowChanges(TableName);
for (int i = 0; i < 100; i++)
{
    PrimaryKey primaryKey = new PrimaryKey();
    primaryKey.Add("pk0", new ColumnValue(i));
    primaryKey.Add("pk1", new ColumnValue("abc"));

    // 行の属性列を指定します。
    UpdateOfAttribute attribute = new UpdateOfAttribute();
    attribute.AddAttributeColumnToPut("col0", new ColumnValue(0));
    attribute.AddAttributeColumnToPut("col1", new ColumnValue("a"));
    attribute.AddAttributeColumnToPut("col2", new ColumnValue(true));

    rowChanges.AddUpdate(new Condition(RowExistenceExpectation.IGNORE), primaryKey, attribute);
}

request.Add(TableName, rowChanges);

try
{
    // BatchWriteRow 操作を呼び出します。
    var response = otsClient.BatchWriteRow(request);
    var tableRows = response.TableRespones;
    var rows = tableRows[TableName];

    // 複数行のデータを同時に書き込む場合、一部の行の書き込みに失敗する可能性があります。戻り値を確認し、各行のステータスが成功かどうかを確認する必要があります。詳細については、サンプルコード内のGitHubのリンクを参照してください。
}
catch (Exception ex)
{
    // 操作が失敗した場合、例外が返されます。例外を処理します。
    Console.WriteLine("Batch put row failed, exception:{0}", ex.Message);
}           

詳細なサンプルコードについては、BatchWriteRow@GitHubをご覧ください。