多元索引支持三种地理位置查询方式,分别是GeoBoundingBoxQuery、GeoDistanceQuery和GeoPolygonQuery。

GeoBoundingBoxQuery

使用GeoBoundingBoxQuery进行地理边界框查询。根据一个矩形范围的地理位置边界条件查询表中的数据,当一个地理位置点落在给出的矩形范围内时,满足查询条件。

示例
/**
 * Col_GeoPoint是GeoPoint类型,查询表中Col_GeoPoint这一列的值在:
 * 左上角为"10,0", 右下角为"0,10"的矩形范围内的数据。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只为了取行数,但不需要具体数据,可以设置limit=0,即不返回任意一行数据。
        query: { // 设置查询类型为GeoBoundingBoxQuery
            queryType: TableStore.QueryType.GEO_BOUNDING_BOX_QUERY,
            query: {
                fieldName: "Col_GeoPoint", // 设置比较哪个字段的值
                topLeft: "10,0", // 设置矩形左上角(纬度,经度)
                bottomRight: "0,10" // 设置矩形右下角(纬度,经度)
            }
        },
        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));
});

GeoDistanceQuery

使用GeoDistanceQuery进行地理距离查询。根据一个中心点和距离条件查询表中的数据,当一个地理位置点到指定的中心点的距离不超过指定的值时,满足查询条件。

示例
/**
 * 查询表中Col_GeoPoint这一列的值距离中心点不超过一定距离的数据。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只为了取行数,但不需要具体数据,可以设置limit=0,即不返回任意一行数据。
        query: { // 设置查询类型为GeoDistanceQuery
            queryType: TableStore.QueryType.GEO_DISTANCE_QUERY,
            query: {
                fieldName: "Col_GeoPoint",
                centerPoint: "1,1", // 设置中心点
                distance: 10000 // 设置到中心点的距离条件,不超过10000米
            }
        },
        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));
});

GeoPolygonQuery

使用GeoPolygonQuery进行地理多边形查询。根据一个多边形范围条件查询表中的数据,当一个地理位置点落在指定的多边形内时,满足查询条件。

示例
/**
 * 查询表中Col_GeoPoint这一列的值在一个给定多边形范围内的数据。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只为了取行数,但不需要具体数据,可以设置limit=0,即不返回任意一行数据。
        query: { // 设置查询类型为GeoPolygonQuery
            queryType: TableStore.QueryType.GEO_POLYGON_QUERY,
            query: {
                fieldName: "Col_GeoPoint",
                points: ["0,0","5,5","5,0"] // 设置多边形的顶点
            }
        },
        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));
});