地理位置查询包括地理距离查询(GeoDistanceQuery)、地理长方形范围查询(GeoBoundingBoxQuery)和地理多边形范围查询(GeoPolygonQuery)三种方式。

前提条件

  • 已初始化OTSClient,详情请参见初始化
  • 已创建数据表并写入数据。
  • 已在数据表上创建多元索引,详情请参见创建多元索引

地理距离查询(GeoDistanceQuery)

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

  • 参数
    参数 说明
    fieldName 列名,类型为Geopoint。
    centerPoint 中心地理坐标点,是一个经纬度值。

    格式为纬度,经度,纬度在前,经度在后,且纬度范围为[-90,+90],经度范围为[-180,+180]。例如35.8,-45.91

    distanceInMeter 距离中心点的距离。类型为Double。单位为米。
    getTotalCount 是否返回匹配的总行数,默认为false,表示不返回。

    返回匹配的总行数会影响查询性能。

    query 多元索引的查询语句。设置查询类型为GeoDistanceQuery。
    tableName 数据表名称。
    indexName 多元索引名称。
    columnsToGet 是否返回所有列,包含returnAll和columns设置。

    returnAll默认为false,表示不返回所有列,此时可以通过columns指定返回的列;如果未通过columns指定返回的列,则只返回主键列。

    当设置returnAll为true时,表示返回所有列。

  • 示例

    查询表中Col_GeoPoint列的值距离中心点不超过一定距离的数据。

    public static void geoDistanceQuery(SyncClient client) {
        SearchQuery searchQuery = new SearchQuery();
        GeoDistanceQuery geoDistanceQuery = new GeoDistanceQuery();  //设置查询类型为GeoDistanceQuery。
        geoDistanceQuery.setFieldName("Col_GeoPoint");
        geoDistanceQuery.setCenterPoint("5,5"); //设置中心点。
        geoDistanceQuery.setDistanceInMeter(10000); //设置条件为到中心点的距离不超过10000米。
        searchQuery.setQuery(geoDistanceQuery);
        //searchQuery.setGetTotalCount(true); //设置返回匹配的总行数。
    
        SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);
        //通过设置columnsToGet参数可以指定返回的列或返回所有列,如果不设置此参数,则默认只返回主键列。
        //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
        //columnsToGet.setReturnAll(true); //设置为返回所有列。
        //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //设置为返回指定列。
        //searchRequest.setColumnsToGet(columnsToGet);
    
        SearchResponse resp = client.search(searchRequest);
        //System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的总行数,非返回行数。
        System.out.println("Row: " + resp.getRows());
    }

地理长方形范围查询(GeoBoundingBoxQuery)

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

  • 参数
    参数 说明
    fieldName 列名,类型为Geopoint。
    topLeft 长方形框的左上角的坐标。
    bottomRight 长方形框的右下角的坐标,通过左上角和右下角就可以确定一个唯一的长方形。

    格式为纬度,经度,纬度在前,经度在后,且纬度范围为[-90,+90],经度范围[-180,+180]。例如35.8,-45.91

    query 多元索引的查询语句。设置查询类型为GeoBoundingBoxQuery。
    getTotalCount 是否返回匹配的总行数,默认为false,表示不返回。

    返回匹配的总行数会影响查询性能。

    tableName 数据表名称。
    indexName 多元索引名称。
    columnsToGet 是否返回所有列,包含returnAll和columns设置。

    returnAll默认为false,表示不返回所有列,此时可以通过columns指定返回的列;如果未通过columns指定返回的列,则只返回主键列。

    当设置returnAll为true时,表示返回所有列。

  • 示例

    Col_Geopoint是GeoPoint类型,查询表中Col_GeoPoint列的值在左上角为"10,0", 右下角为"0,10"的长方形范围内的数据。

    public static void geoBoundingBoxQuery(SyncClient client) {
        SearchQuery searchQuery = new SearchQuery();
        GeoBoundingBoxQuery geoBoundingBoxQuery = new GeoBoundingBoxQuery(); //设置查询类型为GeoBoundingBoxQuery。
        geoBoundingBoxQuery.setFieldName("Col_GeoPoint"); //设置列名。
        geoBoundingBoxQuery.setTopLeft("10,0"); //设置长方形左上角。
        geoBoundingBoxQuery.setBottomRight("0,10"); //设置长方形右下角。
        searchQuery.setQuery(geoBoundingBoxQuery);
        //searchQuery.setGetTotalCount(true); //设置返回匹配的总行数。
    
        SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);
        //通过设置columnsToGet参数可以指定返回的列或返回所有列,如果不设置此参数,则默认只返回主键列。
        //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
        //columnsToGet.setReturnAll(true); //设置为返回所有列。
        //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //设置为返回指定列。
        //searchRequest.setColumnsToGet(columnsToGet);
    
        SearchResponse resp = client.search(searchRequest);
        //System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的总行数,非返回行数。
        System.out.println("Row: " + resp.getRows());
    }

地理多边形范围查询(GeoPolygonQuery)

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

  • 参数
    参数 说明
    fieldName 列名,类型为Geopoint。
    points 组成多边形的距离坐标点。

    格式为纬度,经度,纬度在前,经度在后,且纬度范围为[-90,+90],经度范围为[-180,+180]。例如35.8,-45.91

    query 多元索引的查询语句。设置查询类型为GeoPolygonQuery。
    getTotalCount 是否返回匹配的总行数,默认为false,表示不返回。

    返回匹配的总行数会影响查询性能。

    tableName 数据表名称。
    indexName 多元索引名称。
    columnsToGet 是否返回所有列,包含returnAll和columns设置。

    returnAll默认为false,表示不返回所有列,此时可以通过columns指定返回的列;如果未通过columns指定返回的列,则只返回主键列。

    当设置returnAll为true时,表示返回所有列。

  • 示例

    查询表中Col_GeoPoint列的值在一个给定多边形范围内的数据。

    public static void geoPolygonQuery(SyncClient client) {
        SearchQuery searchQuery = new SearchQuery();
        GeoPolygonQuery geoPolygonQuery = new GeoPolygonQuery();  //设置查询类型为GeoPolygonQuery。
        geoPolygonQuery.setFieldName("Col_GeoPoint");
        geoPolygonQuery.setPoints(Arrays.asList("0,0","5,5","5,0")); //设置多边形的顶点。
        searchQuery.setQuery(geoPolygonQuery);
        //searchQuery.setGetTotalCount(true); //设置返回匹配的总行数。
    
        SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);
        //通过设置columnsToGet参数可以指定返回的列或返回所有列,如果不设置此参数,则默认只返回主键列。
        //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
        //columnsToGet.setReturnAll(true); //设置为返回所有列。
        //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //设置为返回指定列。
        //searchRequest.setColumnsToGet(columnsToGet);
    
        SearchResponse resp = client.search(searchRequest);
        //System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的总行数,非返回行数。
        System.out.println("Row: " + resp.getRows());
    }