Tablestore入门手册-数据管理-GetRow

2022-02-11 21:44:12

GetRow接口概述

GetRow接口用于读取一行数据，是Tablestore最基础的API之一。官方提供了Java、Go、Node.js、Python、PHP、C#、C++ SDK。
本文以Java代码为例，对GetRow接口进行详细说明。

基本使用说明

参数说明

参数名称	是否必填	参数说明
PrimaryKey	是	主键，所有主键都需要填写
ColumnsToGet	否	需要读取的列的集合，若不设置则读取所有列
MaxVersions	MaxVersions 与 TimeRange 至少设置一个	最多读取多少个版本
TimeRange	MaxVersions 与 TimeRange 至少设置一个	要读取的版本范围
Filter	否	过滤器，在服务端对读取结果进行过滤

Java代码示例

public void getRow() {
    //构造主键，主键列必须全部指定
    PrimaryKeyBuilder primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
    primaryKeyBuilder.addPrimaryKeyColumn(PK1, PrimaryKeyValue.fromLong(1L));
    primaryKeyBuilder.addPrimaryKeyColumn(PK2, PrimaryKeyValue.fromString("string"));
    PrimaryKey primaryKey = primaryKeyBuilder.build();

    SingleRowQueryCriteria criteria = new SingleRowQueryCriteria(TABLE_NAME, primaryKey);
    //设置读取的版本数为1，即读取最新版本
    criteria.setMaxVersions(1);

    GetRowRequest getRowRequest = new GetRowRequest(criteria);
    GetRowResponse getRowResponse = syncClient.getRow(getRowRequest);
    Row row = getRowResponse.getRow();

    System.out.println("读取行完毕, 结果为: ");
    System.out.println(row);
}

多版本数据读取

表格存储支持多版本数据存储，具体参考开发指南。

1.MaxVersions

指定maxVersions，返回最新的几个版本。例如：某一行的某一列有20个历史版本，设置maxVersions为10，返回的是最新的10个版本。

SingleRowQueryCriteria criteria = new SingleRowQueryCriteria(TABLE_NAME, primaryKey);
// 设置读取最新版本
criteria.setMaxVersions(10);

2.TimeRange

每一个版本都有一个对应的版本号，这个版本号默认是一个毫秒级的时间戳，用户也可以自己指定版本号，读取出来的时候可以按时间范围取值，返回范围内的版本列。

SingleRowQueryCriteria criteria = new SingleRowQueryCriteria(TABLE_NAME, primaryKey);
TimeRange timeRange = new TimeRange(1418380771, 1418390771);
criteria.setTimeRange(timeRange);

宽行读取

有很多数据列的行，我们称为宽行。因为数据列非常多，受网络带宽、延迟等因素的影响，我们无法一次性读出来，这里介绍几种宽行的读取方法。

1.使用ColumsToGet读取指定列

ColumsToGet参数，允许用户指定需要读取的列。

SingleRowQueryCriteria criteria = new SingleRowQueryCriteria(TABLE_NAME, primaryKey);
// 设置读取某些列
criteria.addColumnsToGet(new String[] {"Col1","Col2","Col3"});

2.使用startColumn，endColumn读取一定范围的属性列

通过startColumn和endColumn指定宽行中某个范围内的列，按照字典序对列进行排序比较。

SingleRowQueryCriteria criteria = new SingleRowQueryCriteria(TABLE_NAME, primaryKey);
criteria.setStartColumn("col0");
criteria.setEndColumn("col3");

3.使用ColumnPaginationFilter配合startColumn翻页读取

ColumnPaginationFilter有两个参数，limit和offset，使用ColumnPaginationFilter读取时，会跳过offset个属性列，然后读取limit个属性列。配合startColumn使用时，会从startColumn开始，跳过offset个属性列，读取limit个属性列。这种方式适合分页读取属性列的场景。

SingleRowQueryCriteria criteria = new SingleRowQueryCriteria(TABLE_NAME, primaryKey);
// 设置从Column0开始读
criteria.setStartColumn("Column0");
// 使用ColumnPaginationFilter设置一次要读取的列数, limit=10, offset=0
criteria.setFilter(new ColumnPaginationFilter(10, 0));

使用过滤器

表格存储过滤器的过滤条件支持算术运算（=、!=、>、>=、<、<=）和逻辑运算（NOT、AND、OR），支持最多 10 个条件的组合。过滤器的具体使用说明请参考：过滤器使用说明。

1.单条件过滤器：SingleColumnValueFilter

表格存储中的数据是稀疏矩阵形式的，每一行的列可能都不一样，对于不存在某一列的行，可以使用PassIfMissing参数来设置期望的过滤形式。passIfMissing为True代表如果这一列不存在也返回，为false代表这一列不存在就不返回。

// 设置过滤器, 当 Col0 的值为 0 时返回该行。
SingleColumnValueFilter singleColumnValueFilter = new SingleColumnValueFilter("Col0",
        SingleColumnValueFilter.CompareOperator.EQUAL, ColumnValue.fromLong(0));
// 如果不存在 Col0 这一列, 也不返回。
singleColumnValueFilter.setPassIfMissing(false);

2.多条件过滤：CompositeColumnValueFilter

多条件过滤器，可以通过组合多个算术运算符号达到多条件组合过滤的效果。

// composite1 条件为 (Col0 == 0) AND (Col1 > 100)
CompositeColumnValueFilter composite1 = new CompositeColumnValueFilter(CompositeColumnValueFilter.LogicOperator.AND);
SingleColumnValueFilter single1 = new SingleColumnValueFilter("Col0",
      SingleColumnValueFilter.CompareOperator.EQUAL, ColumnValue.fromLong(0));
SingleColumnValueFilter single2 = new SingleColumnValueFilter("Col1",
      SingleColumnValueFilter.CompareOperator.GREATER_THAN, ColumnValue.fromLong(100));
composite1.addFilter(single1);
composite1.addFilter(single2);

// composite2 条件为 ( (Col0 == 0) AND (Col1 > 100) ) OR (Col2 <= 10)
CompositeColumnValueFilter composite2 = new CompositeColumnValueFilter(CompositeColumnValueFilter.LogicOperator.OR);
SingleColumnValueFilter single3 = new SingleColumnValueFilter("Col2",
      SingleColumnValueFilter.CompareOperator.LESS_EQUAL, ColumnValue.fromLong(10));
composite2.addFilter(composite1);
composite2.addFilter(single3);

码农公寓