排序和翻页

使用场景

索引预排序

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

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

查询时排序

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

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

ScoreSort

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 //距离中心点正序返回。
            }
        }
    ]
}

关于代码的更多信息，请参见Search。

翻页方式

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

使用limit和offset翻页

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

/**
 * 通过limit+offset进行翻页，直接展示第10页（第90~99条）数据。
 */
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翻页

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

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

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

使用token翻页后的排序方式和上一次请求的一致，无论是系统默认使用IndexSort还是自定义排序，因此设置了token不能再设置Sort。另外使用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_SPECIFIED,
        returnNames: ["pic_tag", "pic_description", "time_stemp", "pos"]
    }
};

/**
 * 使用token翻页示例（同步）。
 */
(async () => { //同步示例代码。
  try {
    var data = await client.search(params);
    console.log('success:', JSON.stringify(data, null, 2));

    while (data.nextToken && data.nextToken.length) { //当存在nextToken时，表示还有未读取的数据。

      //token持久化。
      //1）nextToken为buffer，需转换为base64字符串后做持久化。
      //2）持久化的base64字符串，可转换为buffer作为参数重新使用。
      var nextToken = data.nextToken.toString("base64");
      var token =  Buffer.from(nextToken, "base64");

      params.searchQuery.token = token;//翻页更新token值。
      data = await client.search(params);
      console.log('token success:', JSON.stringify(data, null, 2));
    }
  } catch (error) {
      console.log(error);
  }
})()

/**
 * 使用token翻页示例（异步）。
 */
client.search(params, function (err, data) { 
    console.log('success:', JSON.stringify(data, null, 2));

    if (data.nextToken && data.nextToken.length) {

        //token持久化。
        //1）nextToken为buffer，需转换为base64字符串后做持久化。
        //2）持久化的base64字符串，可转换为buffer作为参数重新使用。
        var nextToken = data.nextToken.toString("base64");
        var token =  Buffer.from(nextToken, "base64");

        params.searchQuery.token = token;//翻页更新token值。
        client.search(params, function (err, data) {
            console.log('token success:', JSON.stringify(data, null, 2));
        });
    }
});