本文主要为您介绍排序和翻页相关接口。

索引预排序(IndexSort)

多元索引默认会按照索引中配置的IndexSort进行排序(含有NESTED类型的索引不支持IndexSort,没有预排序),默认的IndexSort为主键排序,用户可以在创建索引时自定义预排序方式。IndexSort决定了多元索引查询时默认的返回顺序,若用户未自定义IndexSort,即按照主键顺序返回。

查询时指定排序方式

在每次查询时,用户也可以指定排序方式,多元索引支持以下四种排序方式(Sorter)。用户也可以使用多个Sorter,实现先按照某种方式排序,再按照某种方式排序的需求。

  • ScoreSort
    按照分数进行排序,应用在全文索引等有相关性的场景下。需要注意的时,必须手动设置ScoreSort,才能按照相关性打分进行排序,否则会按照索引设置的IndexSort进行排序返回。sort字段设置:
    {
        sorters: [
            {
                scoreSort: {
                    order: TableStore.SortOrder.SORT_ORDER_ASC
                }
            }
        ]
    }
  • PrimaryKeySort
    按照主键排序。sort字段设置:
    
    {
        sorters: [
            {
                primaryKeySort: {
                    order: TableStore.SortOrder.SORT_ORDER_DESC // 逆序
                    //order: TableStore.SortOrder.SORT_ORDER_ASC // 正序
                }
            }
        ]
    }
  • FieldSort
    按照某列进行排序。sort字段设置:
    {
        sorters: [
            {
                fieldSort: {
                    fieldName: "Col_Keyword",
                    order: TableStore.SortOrder.SORT_ORDER_DESC
                }
            }
        ]
    }
    先按照某列排序,再按照另一列排序。sort字段设置:
    {
        sorters: [
            {
                fieldSort: {
                    fieldName: "Col_Keyword",
                    order: TableStore.SortOrder.SORT_ORDER_DESC
                }
            },
            {
                fieldSort: {
                    fieldName: "Col_Long",
                    order: TableStore.SortOrder.SORT_ORDER_DESC
                }
            }
        ]
    }
  • GeoDistanceSort
    根据地理点距离进行排序。sort字段设置:
    {
        sorters: [
            {
                geoDistanceSort: {
                    fieldName: "Col_Geo_Point",
                    points: ["0,0"],//设置中心点
                    order: TableStore.SortOrder.SORT_ORDER_ASC //距离中心点正序
                }
            }
        ]
    }

翻页方式

只有enableSortAndAgg设置为true的字段才能进行排序,排序方式支持多条件设置。

  • 使用limit和offset

    当需要获取的总条数小于2000行时,可以通过limit和offset进行翻页,limit+offset <= 2000.

    
    /**
     * 通过offset + limit进行翻页,直接展示第10页(第90-100条)数据
     */
    client.search({
        tableName: TABLE_NAME,
        indexName: INDEX_NAME,
        searchQuery: {
            offset: 90,
            limit: 10, 
            query: {
                queryType: TableStore.QueryType.MATCH_ALL_QUERY
            }
            getTotalCount: true // 结果中的TotalCount可以表示表中数据的总行数, 默认false不返回
        },
        columnToGet: { //返回列设置:RETURN_SPECIFIED(自定义),RETURN_ALL(所有列),RETURN_NONE(不返回)
            returnType: TableStore.ColumnReturnType.RETURN_ALL
        }
    }, function (err, data) {
        if (err) {
            console.log('error:', err);
            return;
        }
        console.log('success:', JSON.stringify(data, null, 2));
    });
  • 使用token进行翻页

    服务端在一次查询之后会返回NextToken,用户可以使用NextToken继续读取后面的数据,排序方式会跟上一次请求一致(不管是系统默认采用IndexSort排序还是用户自定义排序)。使用Token后不能设置Offset,只能一次一次往后读,即无法跳页。

    /**
     * token翻页实例(同步+异步)。
     */
    var params = {
        tableName: TABLE_NAME,
        indexName: INDEX_NAME,
        searchQuery: {
            offset: 0,
            limit: 10,
            token: null,//获取nextToken作为下一页起点(数据类型字节流)
            query: {
                queryType: TableStore.QueryType.MATCH_ALL_QUERY
            },
            getTotalCount: true
        },
        columnToGet: {
            returnType: TableStore.ColumnReturnType.RETURN_NONE,
            returnNames: ["pic_tag", "pic_description", "time_stemp", "pos"]
        }
    };
    
    /**
     * 同步示例:基于token实现的翻页
     */
    (async () => { //同步示例代码
      try {
        var data = await client.search(params);
        console.log(data);
    
        while (data.nextToken) { //如果存在nextToken,说明还有数据
          params.searchQuery.token = data.nextToken;// 翻页更新token值
          data = await client.search(params);
          console.log(data);
        }
      } catch (error) {
          console.log(error);
      }
    })()
    
    /**
     * 异步示例:基于token实现的翻页
     */
    client.search(params, function (err, data) { //异步示例代码,此处仅做1次翻页
        console.log('success:', JSON.stringify(data, null, 2));
    
        if (data.nextToken) {
            params.searchQuery.token = data.nextToken;// 翻页更新token值
            client.search(params, function (err, data) {
                console.log('token success:', JSON.stringify(data, null, 2));
            });
        }
    });
    
    /**
     * token持久化
     * 1)nextToken为buffer,转换为base64字符串后做持久化
     * 2)持久化的base64字符串,转换为buffer后作为参数重新使用
     */
    var stringToken = data.nextToken.toString("base64", data.nextToken.offset, data.nextToken.limit);
    var bufferToken = new Buffer(stringToken, "base64");