排序和翻页

使用场景

使用方式

您可以使用如下语言的SDK实现排序和翻页。

• Java SDK：排序和翻页

• Go SDK：排序和翻页

• Python SDK：排序和翻页

• Node.js SDK：排序和翻页

• .NET SDK：排序和翻页

• PHP SDK：排序和翻页

索引预排序

多元索引默认按照设置的索引预排序（IndexSort）方式进行排序，使用多元索引查询数据时，IndexSort决定了数据的默认返回顺序。

在创建多元索引时，您可以自定义IndexSort，如果未自定义IndexSort，则IndexSort默认为主键排序。

查询时排序

只有enableSortAndAgg设置为true的字段才能进行排序。

在每次查询时，可以指定排序方式，多元索引支持如下四种排序方式（Sorter）。您也可以使用多个Sorter，实现先按照某种方式排序，再按照另一种方式排序的需求。

ScoreSort

SearchQuery searchQuery = new SearchQuery();
searchQuery.setSort(new Sort(Arrays.asList(new ScoreSort())));

PrimaryKeySort

按照主键进行排序。

SearchQuery searchQuery = new SearchQuery();
searchQuery.setSort(new Sort(Arrays.asList(new PrimaryKeySort()))); //正序。
//searchQuery.setSort(new Sort(Arrays.asList(new PrimaryKeySort(SortOrder.DESC)))); //逆序。

FieldSort

按照列值进行排序。

• 单列排序

  按照某列的值进行排序。

  SearchQuery searchQuery = new SearchQuery();
  searchQuery.setSort(new Sort(Arrays.asList(new FieldSort("col", SortOrder.ASC))));

• 多列排序

  先按照某列的值进行排序，再按照另一列的值进行排序。

  SearchQuery searchQuery = new SearchQuery();
  searchQuery.setSort(new Sort(Arrays.asList(
      new FieldSort("col1", SortOrder.ASC), new FieldSort("col2", SortOrder.ASC))));

• 补偿排序

  按照Long类型、Double类型或者Date类型的列值进行排序时，您可以通过设置missingField参数指定类型相同的其他列作为某行缺失该列时的补偿值来参与排序。

  /**
  * 基于Col_Long列的值逆序排序。如果某行Col_Long列（Long类型）的数据缺失，则使用Col_Long_sec列（Long类型）的数据替换Col_Long列数据用于排序。
  */
  SearchQuery searchQuery = new SearchQuery();
  FieldSort fieldSort = new FieldSort("Col_Long");
  //指定Col_Long_sec列的值作为某行缺失Col_Long列时的默认值来参与排序。
  fieldSort.setMissingField("Col_Long_sec");
  fieldSort.setOrder(SortOrder.DESC); 

• 多值排序

  对于数组类型、嵌套类型等多值字段可以通过指定mode参数来控制参与排序的元素。

  按照数组多值的指定列值进行排序。

  // 有doc1和doc2两行数据，其field1列为数组类型。doc1的field1列值为[2,3]，doc2的field1列值为[1,3,4]。
  // 您可以通过设置mode参数来指定按照数组中的哪个值进行排序。
  {
      // 当设置mode参数为SortMode.MAX时，排序结果为doc2（4参与排序）、doc1（3参与排序）。
      FieldSort fieldSort = new FieldSort("field1", SortOrder.DESC);
      fieldSort.setMode(SortMode.MAX);
  }
  {
      // 当设置mode参数为SortMode.MIN时，排序结果为doc1（2参与排序）、doc2（1参与排序）。
      FieldSort fieldSort = new FieldSort("field1", SortOrder.DESC);
      fieldSort.setMode(SortMode.MIN);
  }

  您也可以对Nested类型字段的子行进行排序。

  // 有doc1和doc2两行数据，其field1列为Nested类型。
  // doc1的field1列值为[{"name":"b", "age":1},{"name":"a", "age":7}]。
  // doc2的field1列值为[{"name":"a", "age":1},{"name":"c", "age":1},{"name":"d", "age":5}]
  
  {
      // 对所有子行进行排序，通过设置mode参数来指定按照哪个值进行排序。
      // 当设置mode参数为SortMode.MAX时，按照age列排序的排序结果为doc1（7参与排序）、doc2（5参与排序）。
      FieldSort fieldSort = new FieldSort("field1.age", SortOrder.DESC);
      fieldSort.setMode(SortMode.MAX);
      String path = "field1";
      NestedFilter nestedFilter = new NestedFilter(path, QueryBuilders.matchAll().build());
      fieldSort.setNestedFilter(nestedFilter);
  }
  {
      // 仅对age=1的子行进行排序，通过设置mode参数来指定按照哪个值进行排序。
      {
          // 当设置mode参数为SortMode.MAX时，按照name列排序的排序结果为doc2（"a"参与排序）、doc1("b"参与排序)
          FieldSort fieldSort = new FieldSort("field1.name", SortOrder.DESC);
          fieldSort.setMode(SortMode.MAX);
          String path = "field1";
          NestedFilter nestedFilter = new NestedFilter(path, QueryBuilders.term("students.age",1).build());
          fieldSort.setNestedFilter(nestedFilter);
      }
      {
          // 当设置mode参数为SortMode.MIN时，按照name列排序的排序结果为doc1（"b"参与排序）、doc2（"a"参与排序）。
          FieldSort fieldSort = new FieldSort("field1.name", SortOrder.DESC);
          fieldSort.setMode(SortMode.MIN);
          String path = "field1";
          NestedFilter nestedFilter = new NestedFilter(path, QueryBuilders.term("students.age",1).build());
          fieldSort.setNestedFilter(nestedFilter);
      }
  }

GeoDistanceSort

根据地理点距离进行排序。

SearchQuery searchQuery = new SearchQuery();
//geo列为Geopoint类型，按照此列的值距离"0,0"点的距离进行排序。
Sort.Sorter sorter = new GeoDistanceSort("geo", Arrays.asList("0, 0"));
searchQuery.setSort(new Sort(Arrays.asList(sorter)));

翻页方式

在获取返回结果时，可以使用limit和offset或者使用token进行翻页。

使用limit和offset翻页

如果使用此方式进行翻页时未设置limit和offset，则limit的默认值为10，offset的默认值为0。

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(new MatchAllQuery());
searchQuery.setLimit(100);
searchQuery.setOffset(100);

使用token翻页

由于使用token进行翻页时翻页深度无限制，当需要进行深度翻页时，推荐使用token进行翻页。

当符合查询条件的数据未读取完时，服务端会返回nextToken，此时可以使用nextToken继续读取后面的数据。

使用token进行翻页时默认只能向后翻页。由于在一次查询的翻页过程中token长期有效，您可以通过缓存并使用之前的token实现向前翻页。

使用token翻页后的排序方式和上一次请求的一致，无论是系统默认使用IndexSort还是自定义排序，因此设置了token不能再设置Sort。另外使用token后不能设置offset，只能依次往后读取，即无法跳页。

private static void readMoreRowsWithToken(SyncClient client) {
    SearchQuery searchQuery = new SearchQuery();
    searchQuery.setQuery(new MatchAllQuery());
    searchQuery.setGetTotalCount(true);//设置返回匹配的总行数。
    // 依次配置数据表名称（例如sampleTable）和多元索引名称（例如sampleSearchIndex）。您可以在表格存储控制台的数据表的“索引管理”页签或者通过SDK列出多元索引列表获取所需多元索引名称。
    SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);

    SearchResponse resp = client.search(searchRequest);
    if (!resp.isAllSuccess()) {
        throw new RuntimeException("not all success");
    }
    List<Row> rows = resp.getRows();
    while (resp.getNextToken()!=null) { // 当读取到nextToken为null时，表示读出全部数据。
        // 获取nextToken。
        byte[] nextToken = resp.getNextToken();

        {
            // 如果需要持久化nextToken或者传输nextToken给前端页面，您可以使用Base64编码将nextToken编码为String进行保存和传输。
            // token本身不是字符串，直接使用new String(nextToken)将token编码为String会造成token信息丢失。
            String tokenAsString = Base64.toBase64String(nextToken);
            // 将String解码为byte。
            byte[] tokenAsByte = Base64.fromBase64String(tokenAsString);
        }

        // 将token设置到下一次请求中。
        searchRequest.getSearchQuery().setToken(nextToken);
        resp = client.search(searchRequest);
        if (!resp.isAllSuccess()) {
            throw new RuntimeException("not all success");
        }
        rows.addAll(resp.getRows());
    }
    System.out.println("RowSize: " + rows.size());
    System.out.println("TotalCount: " + resp.getTotalCount());// 打印匹配到的总行数，非返回行数。
}