表格存储的 SDK 提供了 BatchGetRow、BatchWriteRow、GetRange 和 createRangeIterator 等多行操作的接口。

批量读(BatchGetRow)

批量读接口可以一次请求读取多行数据,参数与 GetRow 接口参数一致。需要注意的是,批量读取的所有行采用相同的参数条件,比如 ColumnsToGet=[colA], 则要读取的所有行都只读取 colA 这一列。

与 BatchWriteRow 接口类似,使用 BatchGetRow 接口时也需要检查返回值。存在部分行失败,而不抛出异常的情况,此时失败行的信息在 BatchGetRowResponse 中。可以通过 BatchGetRowResponse#getFailedRows 方法获取失败的行的信息,通过 BatchGetRowResponse#isAllSucceed 方法可以判断是否所有行都获取成功。

示例

读取 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(PRIMARY_KEY_NAME, 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对应一个表的查询条件, 可以添加多个multiRowQueryCriteria.
            batchGetRowRequest.addMultiRowQueryCriteria(multiRowQueryCriteria);
    
            BatchGetRowResponse batchGetRowResponse = client.batchGetRow(batchGetRowRequest);
    
            System.out.println("是否全部成功:" + batchGetRowResponse.isAllSucceed());
            if (!batchGetRowResponse.isAllSucceed()) {
                for (BatchGetRowResponse.RowResult rowResult : batchGetRowResponse.getFailedRows()) {
                    System.out.println("失败的行:" + batchGetRowRequest.getPrimaryKey(rowResult.getTableName(), rowResult.getIndex()));
                    System.out.println("失败原因:" + rowResult.getError());
                }
    
                /**
                 * 可以通过createRequestForRetry方法再构造一个请求对失败的行进行重试.这里只给出构造重试请求的部分.
                 * 推荐的重试方法是使用SDK的自定义重试策略功能, 支持对batch操作的部分行错误进行重试. 设定重试策略后, 调用接口处即不需要增加重试代码.
                 */
                BatchGetRowRequest retryRequest = batchGetRowRequest.createRequestForRetry(batchGetRowResponse.getFailedRows());
            }
        }

批量写(BatchWriteRow)

BatchWriteRow 接口可以在一次请求中进行批量的写入操作,写入操作包括 PutRow、UpdateRow 和 DeleteRow,也支持一次对多张表进行写入。

构造单个操作的过程与使用 PutRow 接口、UpdateRow 接口和 DeleteRow 接口时相同,也支持设置更新条件。

调用 BatchWriteRow 接口时,需要特别注意的是检查返回值。因为是批量写入,可能存在部分行成功部分行失败的情况,此时失败行的 Index 及错误信息在返回的 BatchWriteRowResponse 中,而并不抛出异常。可通过 BatchWriteRowResponse 的 isAllSucceed 方法判断是否全部成功。若不检查,可能会忽略掉部分操作的失败。另一方面,BatchWriteRow 接口也是可能抛出异常的。比如,服务端检查到某些操作出现参数错误,可能会抛出参数错误的异常,在抛出异常的情况下该请求中所有的操作都未执行。

示例

一次 BatchWriteRow 请求,包含 2 个 PutRow 操作,1 个 UpdateRow 操作,1 个 DeleteRow 操作。

        private static void batchWriteRow(SyncClient client) {
            BatchWriteRowRequest batchWriteRowRequest = new BatchWriteRowRequest();

            // 构造rowPutChange1
            PrimaryKeyBuilder pk1Builder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
            pk1Builder.addPrimaryKeyColumn(PRIMARY_KEY_NAME, PrimaryKeyValue.fromString("pk1"));
            RowPutChange rowPutChange1 = new RowPutChange(TABLE_NAME, pk1Builder.build());
            // 添加一些列
            for (int i = 0; i < 10; i++) {
                rowPutChange1.addColumn(new Column("Col" + i, ColumnValue.fromLong(i)));
            }
            // 添加到batch操作中
            batchWriteRowRequest.addRowChange(rowPutChange1);

            // 构造rowPutChange2
            PrimaryKeyBuilder pk2Builder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
            pk2Builder.addPrimaryKeyColumn(PRIMARY_KEY_NAME, PrimaryKeyValue.fromString("pk2"));
            RowPutChange rowPutChange2 = new RowPutChange(TABLE_NAME, pk2Builder.build());
            // 添加一些列
            for (int i = 0; i < 10; i++) {
                rowPutChange2.addColumn(new Column("Col" + i, ColumnValue.fromLong(i)));
            }
            // 添加到batch操作中
            batchWriteRowRequest.addRowChange(rowPutChange2);

            // 构造rowUpdateChange
            PrimaryKeyBuilder pk3Builder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
            pk3Builder.addPrimaryKeyColumn(PRIMARY_KEY_NAME, PrimaryKeyValue.fromString("pk3"));
            RowUpdateChange rowUpdateChange = new RowUpdateChange(TABLE_NAME, pk3Builder.build());
            // 添加一些列
            for (int i = 0; i < 10; i++) {
                rowUpdateChange.put(new Column("Col" + i, ColumnValue.fromLong(i)));
            }
            // 删除一列
            rowUpdateChange.deleteColumns("Col10");
            // 添加到batch操作中
            batchWriteRowRequest.addRowChange(rowUpdateChange);

            // 构造rowDeleteChange
            PrimaryKeyBuilder pk4Builder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
            pk4Builder.addPrimaryKeyColumn(PRIMARY_KEY_NAME, PrimaryKeyValue.fromString("pk4"));
            RowDeleteChange rowDeleteChange = new RowDeleteChange(TABLE_NAME, pk4Builder.build());
            // 添加到batch操作中
            batchWriteRowRequest.addRowChange(rowDeleteChange);

            BatchWriteRowResponse response = client.batchWriteRow(batchWriteRowRequest);

            System.out.println("是否全部成功:" + response.isAllSucceed());
            if (!response.isAllSucceed()) {
                for (BatchWriteRowResponse.RowResult rowResult : response.getFailedRows()) {
                    System.out.println("失败的行:" + batchWriteRowRequest.getRowChange(rowResult.getTableName(), rowResult.getIndex()).getPrimaryKey());
                    System.out.println("失败原因:" + rowResult.getError());
                }
                /**
                 * 可以通过createRequestForRetry方法再构造一个请求对失败的行进行重试.这里只给出构造重试请求的部分.
                 * 推荐的重试方法是使用SDK的自定义重试策略功能, 支持对batch操作的部分行错误进行重试. 设定重试策略后, 调用接口处即不需要增加重试代码.
                 */
                BatchWriteRowRequest retryRequest = batchWriteRowRequest.createRequestForRetry(response.getFailedRows());
            }
        }

范围读(GetRange)

范围读取接口用于读取一个范围内的数据。表格存储表中的行都是按照主键排序的,而主键是由全部主键列按照顺序组成的,所以不能理解为表格存储会按照某列主键排序,这是常见的误区。

GetRange 接口支持按照给定范围正序读取和反序读取,可以限定要读取的行数。如果范围较大,已经扫描的行数或者数据量超过一定限制,会停止继续扫描,返回已经获取的行和下一个主键的位置。用户可以根据返回的下一个主键位置,继续发起请求,获取范围内剩余的行。

GetRange 请求的主要参数如下:

  • Direction:枚举类型,包括 FORWARD、BACKWARD,分别代表正序、反序。

  • InclusiveStartPrimaryKey:范围的起始主键(包含)。若为反序,起始主键要大于结束主键。

  • ExclusiveEndPrimaryKey:范围的结束主键(不包含)。若为反序,起始主键要大于结束主键。

  • Limit:本次请求返回的最大行数。

  • ColumnsToGet:要读取的列的集合。若不设置,则读取所有列。

  • MaxVersions:最多读取多少个版本。MaxVersions 与 TimeRange 必须至少设置一个。

  • TimeRange: 要读取的版本号的范围。MaxVersions 与 TimeRange 必须至少设置一个。

  • Filter:过滤器。过滤器在服务端对读取的结果再进行一次过滤。

示例

正序读取,判断 NextStartPrimaryKey 是否为 null,读取完范围内的全部数据。

       private static void getRange(SyncClient client, String startPkValue, String endPkValue) {
            RangeRowQueryCriteria rangeRowQueryCriteria = new RangeRowQueryCriteria(TABLE_NAME);
    
            // 设置起始主键
            PrimaryKeyBuilder primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
            primaryKeyBuilder.addPrimaryKeyColumn(PRIMARY_KEY_NAME, PrimaryKeyValue.fromString(startPkValue));
            rangeRowQueryCriteria.setInclusiveStartPrimaryKey(primaryKeyBuilder.build());
    
            // 设置结束主键
            primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
            primaryKeyBuilder.addPrimaryKeyColumn(PRIMARY_KEY_NAME, PrimaryKeyValue.fromString(endPkValue));
            rangeRowQueryCriteria.setExclusiveEndPrimaryKey(primaryKeyBuilder.build());
    
            rangeRowQueryCriteria.setMaxVersions(1);
    
            System.out.println("GetRange的结果为:");
            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;
                }
            }
        }

迭代读(createRangeIterator)

迭代读取数据。

示例

        private static void getRangeByIterator(SyncClient client, String startPkValue, String endPkValue) {
            RangeIteratorParameter rangeIteratorParameter = new RangeIteratorParameter(TABLE_NAME);
    
            // 设置起始主键
            PrimaryKeyBuilder primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
            primaryKeyBuilder.addPrimaryKeyColumn(PRIMARY_KEY_NAME, PrimaryKeyValue.fromString(startPkValue));
            rangeIteratorParameter.setInclusiveStartPrimaryKey(primaryKeyBuilder.build());
    
            // 设置结束主键
            primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
            primaryKeyBuilder.addPrimaryKeyColumn(PRIMARY_KEY_NAME, PrimaryKeyValue.fromString(endPkValue));
            rangeIteratorParameter.setExclusiveEndPrimaryKey(primaryKeyBuilder.build());
    
            rangeIteratorParameter.setMaxVersions(1);
    
            Iterator<Row> iterator = client.createRangeIterator(rangeIteratorParameter);
    
            System.out.println("使用Iterator进行GetRange的结果为:");
            while (iterator.hasNext()) {
                Row row = iterator.next();
                System.out.println(row);
            }
        }