Node.js SDK 實現地理位置查詢 -

地理位置查詢包括地理距離查詢（GeoDistanceQuery）、地理長方形範圍查詢（GeoBoundingBoxQuery）和地理多邊形範圍查詢（GeoPolygonQuery）三種方式。

前提條件

已初始化Client。具體操作，請參見初始化Client。
已建立資料表並寫入資料。具體操作，請參見建立資料表和寫入資料。
已在資料表上建立多元索引。具體操作，請參見建立多元索引。

地理距離查詢（GeoDistanceQuery）

GeoDistanceQuery根據一個中心點和距離條件查詢表中的資料，當一個地理位置點到指定的中心點的距離不超過指定的值時，滿足查詢條件。

參數

參數	說明
tableName	資料表名稱。
indexName	多元索引名稱。
query	多元索引的查詢語句。設定查詢類型為TableStore.QueryType.GEO_DISTANCE_QUERY。
fieldName	列名，類型為Geopoint。
centerPoint	中心地理座標點，是一個經緯度值。格式為“緯度,經度”，緯度在前，經度在後，且緯度範圍為-90～+90，經度範圍-180～+180。例如“35.8,-45.91”。
distance	距離中心點的距離，類型為Double。單位為米。

樣本

以下樣本用於查詢表中Col_GeoPoint列的值距離中心點不超過一定距離的資料。

client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只為了擷取行數，無需擷取具體資料，可以設定limit=0，即不返回任意一行資料。
        query: { //設定查詢類型為TableStore.QueryType.GEO_DISTANCE_QUERY。
            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_ALL_FROM_INDEX（返回多元索引中的所有列）、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));
});

地理長方形範圍查詢（GeoBoundingBoxQuery）

GeoBoundingBoxQuery根據一個長方形範圍的地理位置邊界條件查詢表中的資料，當一個地理位置點落在給出的長方形範圍內時滿足查詢條件。

參數

參數	說明
tableName	資料表名稱。
indexName	多元索引名稱。
query	多元索引的查詢語句。設定查詢類型為TableStore.QueryType.GEO_BOUNDING_BOX_QUERY。
fieldName	列名，類型為Geopoint。
topLeft	長方形框的左上方的座標。
bottomRight	長方形框的右下角的座標，通過左上方和右下角就可以確定一個唯一的長方形。格式為“緯度,經度”，緯度在前，經度在後，且緯度範圍為-90～+90，經度範圍-180～+180。例如“35.8,-45.91”。

樣本

以下樣本用於查詢表中Col_GeoPoint列的值在左上方為"10,0"，右下角為"0,10"的長方形範圍內的資料。

client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只為了擷取行數，無需擷取具體資料，可以設定limit=0，即不返回任意一行資料。
        query: { //設定查詢類型為TableStore.QueryType.GEO_BOUNDING_BOX_QUERY。
            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_ALL_FROM_INDEX（返回多元索引中的所有列）、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根據一個多邊形範圍條件查詢表中的資料，當一個地理位置點落在指定的多邊形範圍內時滿足查詢條件。

參數

參數	說明
tableName	資料表名稱。
indexName	多元索引名稱。
query	多元索引的查詢語句。設定查詢類型為TableStore.QueryType.GEO_POLYGON_QUERY。
fieldName	列名，類型為Geopoint。
points	組成多邊形的距離座標點。格式為“緯度,經度”，緯度在前，經度在後，且緯度範圍為-90～+90，經度範圍-180～+180。例如“35.8,-45.91”。

樣本

以下樣本用於查詢表中Col_GeoPoint列的值在一個給定多邊形範圍內的資料。

client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只為了擷取行數，無需擷取具體資料，可以設定limit=0，即不返回任意一行資料。
        query: { //設定查詢類型為TableStore.QueryType.GEO_POLYGON_QUERY。
            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_ALL_FROM_INDEX（返回多元索引中的所有列）、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）

地理長方形範圍查詢（GeoBoundingBoxQuery）

地理多邊形範圍查詢（GeoPolygonQuery）

常見問題

相關文檔