Tablestore:データの読み取り

単一行のデータの読み取り

データを読み取る際に、データバージョン、読み取る列、フィルター、正規表現フィルターを指定できます。

• 最新バージョンのデータと特定の列を読み取る

  次のサンプルコードは、データテーブルの行の指定された列から最新バージョンのデータを読み取る方法の例を示しています。

  private static void getRow(SyncClient client, String pkValue) {
      // プライマリキーを構築します。
      PrimaryKeyBuilder primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
      primaryKeyBuilder.addPrimaryKeyColumn("pk", PrimaryKeyValue.fromString(pkValue));
      PrimaryKey primaryKey = primaryKeyBuilder.build();
  
      // テーブル名とプライマリキーを指定して、1 行のデータを読み取ります。
      SingleRowQueryCriteria criteria = new SingleRowQueryCriteria("<TABLE_NAME>", primaryKey);
      // MaxVersions パラメーターを 1 に設定して、最新バージョンのデータを読み取ります。
      criteria.setMaxVersions(1);
      GetRowResponse getRowResponse = client.getRow(new GetRowRequest(criteria));
      Row row = getRowResponse.getRow();
  
      System.out.println("Read complete. Result:");
      System.out.println(row);
  
      // 読み取る列を指定します。
      criteria.addColumnsToGet("Col0");
      getRowResponse = client.getRow(new GetRowRequest(criteria));
      row = getRowResponse.getRow();
  
      System.out.println("Read complete. Result:");
      System.out.println(row);
  } 

• フィルターを使用したデータの読み取り

  次のサンプルコードは、データテーブルの行から最新バージョンのデータを読み取り、フィルターを使用して Col0 列の値に基づいてデータをフィルタリングする方法の例を示しています。

  private static void getRow(SyncClient client, String pkValue) {
      // プライマリキーを構築します。
      PrimaryKeyBuilder primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
      primaryKeyBuilder.addPrimaryKeyColumn("pk", PrimaryKeyValue.fromString(pkValue));
      PrimaryKey primaryKey = primaryKeyBuilder.build();
  
      // テーブル名とプライマリキーを指定して、1 行のデータを読み取ります。
      SingleRowQueryCriteria criteria = new SingleRowQueryCriteria("<TABLE_NAME>", primaryKey);
      // MaxVersions パラメーターを 1 に設定して、最新バージョンのデータを読み取ります。
      criteria.setMaxVersions(1);
  
      // Col0 列の値が 0 の行を返すようにフィルターを設定します。
      SingleColumnValueFilter singleColumnValueFilter = new SingleColumnValueFilter("Col0",
              SingleColumnValueFilter.CompareOperator.EQUAL, ColumnValue.fromLong(0));
      // Col0 列が存在しない場合、行は返されません。
      singleColumnValueFilter.setPassIfMissing(false);
      criteria.setFilter(singleColumnValueFilter);
  
      GetRowResponse getRowResponse = client.getRow(new GetRowRequest(criteria));
      Row row = getRowResponse.getRow();
  
      System.out.println("Read complete. Result:");
      System.out.println(row);
  }

• データ読み取り時に正規表現フィルターを使用する

  次のサンプルコードは、データテーブルの行から Col1 列のデータを読み取り、正規表現を使用して列内のデータをフィルタリングする方法の例を示しています。

  private static void getRow(SyncClient client, String pkValue) {
      // データテーブルの名前を指定します。
      SingleRowQueryCriteria criteria = new SingleRowQueryCriteria("<TABLE_NAME>");
   
      // プライマリキーを構築します。
      PrimaryKey primaryKey = PrimaryKeyBuilder.createPrimaryKeyBuilder()
          .addPrimaryKeyColumn("pk", PrimaryKeyValue.fromString(pkValue))
          .build();
      criteria.setPrimaryKey(primaryKey);
   
      // MaxVersions パラメーターを 1 に設定して、最新バージョンのデータを読み取ります。
      criteria.setMaxVersions(1);
   
      // フィルターを設定します。cast<int>(regex(Col1)) が 100 より大きい場合に、行が返されます。
      RegexRule regexRule = new RegexRule("t1:([0-9]+),", RegexRule.CastType.VT_INTEGER);
      SingleColumnValueRegexFilter filter =  new SingleColumnValueRegexFilter("Col1",
          regexRule,SingleColumnValueRegexFilter.CompareOperator.GREATER_THAN, ColumnValue.fromLong(100));
      criteria.setFilter(filter);
   
      GetRowResponse getRowResponse = client.getRow(new GetRowRequest(criteria));
      Row row = getRowResponse.getRow();
  
      System.out.println("Read complete. Result:");
      System.out.println(row);
  }

データのバッチ読み取り

次のサンプルコードは、バージョン条件、読み取る列、およびフィルターを設定して 10 行のデータを読み取る方法の例を示しています。

private static void batchGetRow(SyncClient client) {
    // データテーブルの名前を指定します。
    MultiRowQueryCriteria multiRowQueryCriteria = new MultiRowQueryCriteria("<TABLE_NAME>");
    // 読み取る 10 行を指定します。
    for (int i = 0; i < 10; i++) {
        PrimaryKeyBuilder primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
        primaryKeyBuilder.addPrimaryKeyColumn("pk", PrimaryKeyValue.fromString("pk" + i));
        PrimaryKey primaryKey = primaryKeyBuilder.build();
        multiRowQueryCriteria.addRow(primaryKey);
    }
    // 条件を追加します。
    multiRowQueryCriteria.setMaxVersions(1);
    multiRowQueryCriteria.addColumnsToGet("Col0");
    multiRowQueryCriteria.addColumnsToGet("Col1");
    SingleColumnValueFilter singleColumnValueFilter = new SingleColumnValueFilter("Col0",
            SingleColumnValueFilter.CompareOperator.EQUAL, ColumnValue.fromLong(0));
    singleColumnValueFilter.setPassIfMissing(false);
    multiRowQueryCriteria.setFilter(singleColumnValueFilter);

    BatchGetRowRequest batchGetRowRequest = new BatchGetRowRequest();
    // BatchGetRow 操作では、複数のテーブルからデータを読み取ることができます。各 multiRowQueryCriteria パラメーターは、1 つのテーブルのクエリ条件を指定します。複数の multiRowQueryCriteria パラメーターを追加して、複数のテーブルからデータを読み取ることができます。
    batchGetRowRequest.addMultiRowQueryCriteria(multiRowQueryCriteria);

    BatchGetRowResponse batchGetRowResponse = client.batchGetRow(batchGetRowRequest);

    System.out.println("Whether all operations are successful:" + batchGetRowResponse.isAllSucceed());
    System.out.println("Read complete. Result:");
    for (BatchGetRowResponse.RowResult rowResult : batchGetRowResponse.getSucceedRows()) {
        System.out.println(rowResult.getRow());
    }
    if (!batchGetRowResponse.isAllSucceed()) {
        for (BatchGetRowResponse.RowResult rowResult : batchGetRowResponse.getFailedRows()) {
            System.out.println("Failed rows:" + batchGetRowRequest.getPrimaryKey(rowResult.getTableName(), rowResult.getIndex()));
            System.out.println("Cause of failures:" + rowResult.getError());
        }

        /**
         * createRequestForRetry メソッドを使用して、別のリクエストを構築し、失敗した行の操作をリトライできます。この例では、リトライリクエストのみが構築されます。
         * Tablestore SDK のカスタムリトライポリシーをリトライメソッドとして使用することを推奨します。これにより、バッチ操作が実行された後に失敗した行をリトライできます。リトライポリシーを指定すると、操作を呼び出すためのリトライコードを追加する必要がありません。
         */
        BatchGetRowRequest retryRequest = batchGetRowRequest.createRequestForRetry(batchGetRowResponse.getFailedRows());
    }
}

範囲内のデータの読み取り

• 定義された範囲内のデータを読み取る

  次のサンプルコードは、プライマリキー値が指定された範囲内にあるデータを順方向に読み取る方法の例を示しています。応答の nextStartPrimaryKey パラメーターの値が空の場合、指定された範囲内のプライマリキー値を持つすべてのデータが読み取られます。それ以外の場合は、指定された範囲内のプライマリキー値を持つすべてのデータが返されるまで、別のリクエストを開始する必要があります。

  private static void getRange(SyncClient client, String startPkValue, String endPkValue) {
      // データテーブルの名前を指定します。
      RangeRowQueryCriteria rangeRowQueryCriteria = new RangeRowQueryCriteria("<TABLE_NAME>");
  
      // 開始プライマリキーを指定します。
      PrimaryKeyBuilder primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
      primaryKeyBuilder.addPrimaryKeyColumn("pk", PrimaryKeyValue.fromString(startPkValue));
      rangeRowQueryCriteria.setInclusiveStartPrimaryKey(primaryKeyBuilder.build());
  
      // 終了プライマリキーを指定します。
      primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
      primaryKeyBuilder.addPrimaryKeyColumn("pk", PrimaryKeyValue.fromString(endPkValue));
      rangeRowQueryCriteria.setExclusiveEndPrimaryKey(primaryKeyBuilder.build());
  
      rangeRowQueryCriteria.setMaxVersions(1);
  
      System.out.println("GetRange result:");
      while (true) {
          GetRangeResponse getRangeResponse = client.getRange(new GetRangeRequest(rangeRowQueryCriteria));
          for (Row row : getRangeResponse.getRows()) {
              System.out.println(row);
          }
  
          // nextStartPrimaryKey パラメーターの値が null でない場合、読み取り操作を続行します。
          if (getRangeResponse.getNextStartPrimaryKey() != null) {
              rangeRowQueryCriteria.setInclusiveStartPrimaryKey(getRangeResponse.getNextStartPrimaryKey());
          } else {
              break;
          }
      }
  }         

• 最初のプライマリキー列で定義された範囲に基づいてデータを読み取る

  次のサンプルコードは、最初のプライマリキー列の値によって決定される範囲内のデータを順方向に読み取る方法の例を示しています。この例では、2 番目のプライマリキー列の開始値は INF_MIN に設定され、2 番目のプライマリキー列の終了値は INF_MAX に設定されています。応答の nextStartPrimaryKey パラメーターの値が null の場合、指定された範囲内のすべてのデータが読み取られます。それ以外の場合は、最初のプライマリキー列の値によって決定される範囲内のすべてのデータが返されるまで、別のリクエストを開始する必要があります。

  private static void getRange(SyncClient client, String startPkValue, String endPkValue) {
      // データテーブルの名前を指定します。
      RangeRowQueryCriteria rangeRowQueryCriteria = new RangeRowQueryCriteria("<TABLE_NAME>");
      // 開始プライマリキーを指定します。この例では、2 つのプライマリキー列が使用されます。
      PrimaryKeyBuilder primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
      primaryKeyBuilder.addPrimaryKeyColumn("pk1", PrimaryKeyValue.fromString(startPkValue));// 最初のプライマリキー列の値を特定の値に設定します。
      primaryKeyBuilder.addPrimaryKeyColumn("pk2", PrimaryKeyValue.INF_MIN);// 2 番目のプライマリキー列の値を無限小の値に設定します。
      rangeRowQueryCriteria.setInclusiveStartPrimaryKey(primaryKeyBuilder.build());
  
      // 終了プライマリキーを指定します。
      primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
      primaryKeyBuilder.addPrimaryKeyColumn("pk1", PrimaryKeyValue.fromString(endPkValue));// 最初のプライマリキー列の値を特定の値に設定します。
      primaryKeyBuilder.addPrimaryKeyColumn("pk2", PrimaryKeyValue.INF_MAX);// 2 番目のプライマリキー列の値を無限大の値に設定します。
      rangeRowQueryCriteria.setExclusiveEndPrimaryKey(primaryKeyBuilder.build());
  
      rangeRowQueryCriteria.setMaxVersions(1);
  
      System.out.println("GetRange result:");
      while (true) {
          GetRangeResponse getRangeResponse = client.getRange(new GetRangeRequest(rangeRowQueryCriteria));
          for (Row row : getRangeResponse.getRows()) {
              System.out.println(row);
          }
  
          // nextStartPrimaryKey パラメーターの値が null でない場合、読み取り操作を続行します。
          if (getRangeResponse.getNextStartPrimaryKey() != null) {
              rangeRowQueryCriteria.setInclusiveStartPrimaryKey(getRangeResponse.getNextStartPrimaryKey());
          } else {
              break;
          }
      }
  }    

• 定義された範囲内のデータを読み取り、特定の列に正規表現フィルターを適用する

  次のサンプルコードは、プライマリキー値が ["pk:2020-01-01.log", "pk:2021-01-01.log") の範囲にあるデータを Col1 列から読み取り、正規表現を使用して Col1 列のデータをフィルタリングする方法の例を示しています。

  private static void getRange(SyncClient client) {
      // データテーブルの名前を指定します。
      RangeRowQueryCriteria criteria = new RangeRowQueryCriteria("<TABLE_NAME>");
   
      // 読み取るデータのプライマリキーの範囲として ["pk:2020-01-01.log", "pk:2021-01-01.log") を指定します。範囲は左閉右開区間です。
      PrimaryKey pk0 = PrimaryKeyBuilder.createPrimaryKeyBuilder()
          .addPrimaryKeyColumn("pk", PrimaryKeyValue.fromString("2020-01-01.log"))
          .build();
      PrimaryKey pk1 = PrimaryKeyBuilder.createPrimaryKeyBuilder()
          .addPrimaryKeyColumn("pk", PrimaryKeyValue.fromString("2021-01-01.log"))
          .build();
      criteria.setInclusiveStartPrimaryKey(pk0);
      criteria.setExclusiveEndPrimaryKey(pk1);
   
      // MaxVersions パラメーターを 1 に設定して、最新バージョンのデータを読み取ります。
      criteria.setMaxVersions(1);
   
      // フィルターを設定します。cast<int>(regex(Col1)) が 100 より大きい場合に、行が返されます。
      RegexRule regexRule = new RegexRule("t1:([0-9]+),", RegexRule.CastType.VT_INTEGER);
      SingleColumnValueRegexFilter filter =  new SingleColumnValueRegexFilter("Col1",
          regexRule,SingleColumnValueRegexFilter.CompareOperator.GREATER_THAN,ColumnValue.fromLong(100));
      criteria.setFilter(filter);
  
      while (true) {
          GetRangeResponse resp = client.getRange(new GetRangeRequest(criteria));
          for (Row row : resp.getRows()) {
              // 何らかの処理を行う
              System.out.println(row);
          }
          if (resp.getNextStartPrimaryKey() != null) {
              criteria.setInclusiveStartPrimaryKey(resp.getNextStartPrimaryKey());
          } else {
              break;
          }
     }
  }