ISSUES-7566 sync zh geo function docs

This commit is contained in:
zhang2014 2019-11-01 22:17:08 +08:00
parent 21db9157f7
commit 1fbf4e827b

View File

@ -4,7 +4,7 @@
使用[great-circle distance公式](https://en.wikipedia.org/wiki/Great-circle_distance)计算地球表面两点之间的距离。 使用[great-circle distance公式](https://en.wikipedia.org/wiki/Great-circle_distance)计算地球表面两点之间的距离。
``` ```sql
greatCircleDistance(lon1Deg, lat1Deg, lon2Deg, lat2Deg) greatCircleDistance(lon1Deg, lat1Deg, lon2Deg, lat2Deg)
``` ```
@ -25,11 +25,11 @@ greatCircleDistance(lon1Deg, lat1Deg, lon2Deg, lat2Deg)
**示例** **示例**
``` sql ```sql
SELECT greatCircleDistance(55.755831, 37.617673, -55.755831, -37.617673) SELECT greatCircleDistance(55.755831, 37.617673, -55.755831, -37.617673)
``` ```
``` ```text
┌─greatCircleDistance(55.755831, 37.617673, -55.755831, -37.617673)─┐ ┌─greatCircleDistance(55.755831, 37.617673, -55.755831, -37.617673)─┐
│ 14132374.194975413 │ │ 14132374.194975413 │
└───────────────────────────────────────────────────────────────────┘ └───────────────────────────────────────────────────────────────────┘
@ -37,9 +37,10 @@ SELECT greatCircleDistance(55.755831, 37.617673, -55.755831, -37.617673)
## pointInEllipses ## pointInEllipses
检查指定的点是否至少包含在一个指定的椭圆中。 检查指定的点是否至少包含在指定的一个椭圆中。
下述中的坐标是几何图形在笛卡尔坐标系中的位置。
``` ```sql
pointInEllipses(x, y, x₀, y₀, a₀, b₀,...,xₙ, yₙ, aₙ, bₙ) pointInEllipses(x, y, x₀, y₀, a₀, b₀,...,xₙ, yₙ, aₙ, bₙ)
``` ```
@ -47,7 +48,7 @@ pointInEllipses(x, y, x₀, y₀, a₀, b₀,...,xₙ, yₙ, aₙ, bₙ)
- `x, y` — 平面上某个点的坐标。 - `x, y` — 平面上某个点的坐标。
- `xᵢ, yᵢ` — 第i个椭圆的中心坐标。 - `xᵢ, yᵢ` — 第i个椭圆的中心坐标。
- `aᵢ, bᵢ` — 第i个椭圆的轴,单位:米 - `aᵢ, bᵢ`以x, y坐标为单位的第i个椭圆的轴。
输入参数的个数必须是`2+4⋅n`,其中`n`是椭圆的数量。 输入参数的个数必须是`2+4⋅n`,其中`n`是椭圆的数量。
@ -57,11 +58,11 @@ pointInEllipses(x, y, x₀, y₀, a₀, b₀,...,xₙ, yₙ, aₙ, bₙ)
**示例** **示例**
``` sql ```sql
SELECT pointInEllipses(55.755831, 37.617673, 55.755831, 37.617673, 1.0, 2.0) SELECT pointInEllipses(55.755831, 37.617673, 55.755831, 37.617673, 1.0, 2.0)
``` ```
``` ```text
┌─pointInEllipses(55.755831, 37.617673, 55.755831, 37.617673, 1., 2.)─┐ ┌─pointInEllipses(55.755831, 37.617673, 55.755831, 37.617673, 1., 2.)─┐
│ 1 │ │ 1 │
└─────────────────────────────────────────────────────────────────────┘ └─────────────────────────────────────────────────────────────────────┘
@ -71,7 +72,7 @@ SELECT pointInEllipses(55.755831, 37.617673, 55.755831, 37.617673, 1.0, 2.0)
检查指定的点是否包含在指定的多边形中。 检查指定的点是否包含在指定的多边形中。
``` ```sql
pointInPolygon((x, y), [(a, b), (c, d) ...], ...) pointInPolygon((x, y), [(a, b), (c, d) ...], ...)
``` ```
@ -88,11 +89,11 @@ pointInPolygon((x, y), [(a, b), (c, d) ...], ...)
**示例** **示例**
``` sql ```sql
SELECT pointInPolygon((3., 3.), [(6, 0), (8, 4), (5, 8), (0, 2)]) AS res SELECT pointInPolygon((3., 3.), [(6, 0), (8, 4), (5, 8), (0, 2)]) AS res
``` ```
``` ```text
┌─res─┐ ┌─res─┐
│ 1 │ │ 1 │
└─────┘ └─────┘
@ -101,7 +102,7 @@ SELECT pointInPolygon((3., 3.), [(6, 0), (8, 4), (5, 8), (0, 2)]) AS res
## geohashEncode ## geohashEncode
将经度和纬度编码为geohash-string请参阅http://geohash.org/,https://en.wikipedia.org/wiki/Geohash 将经度和纬度编码为geohash-string请参阅http://geohash.org/,https://en.wikipedia.org/wiki/Geohash
``` ```sql
geohashEncode(longitude, latitude, [precision]) geohashEncode(longitude, latitude, [precision])
``` ```
@ -117,11 +118,11 @@ geohashEncode(longitude, latitude, [precision])
**示例** **示例**
``` sql ```sql
SELECT geohashEncode(-5.60302734375, 42.593994140625, 0) AS res SELECT geohashEncode(-5.60302734375, 42.593994140625, 0) AS res
``` ```
``` ```text
┌─res──────────┐ ┌─res──────────┐
│ ezs42d000000 │ │ ezs42d000000 │
└──────────────┘ └──────────────┘
@ -141,14 +142,79 @@ SELECT geohashEncode(-5.60302734375, 42.593994140625, 0) AS res
**示例** **示例**
``` sql ```sql
SELECT geohashDecode('ezs42') AS res SELECT geohashDecode('ezs42') AS res
``` ```
``` ```text
┌─res─────────────────────────────┐ ┌─res─────────────────────────────┐
│ (-5.60302734375,42.60498046875) │ │ (-5.60302734375,42.60498046875) │
└─────────────────────────────────┘ └─────────────────────────────────┘
``` ```
## geoToH3
计算指定的分辨率的[H3](https://uber.github.io/h3/#/documentation/overview/introduction)索引`(lon, lat)`。
```sql
geoToH3(lon, lat, resolution)
```
**输入值**
- `lon` — 经度。 [Float64](../../data_types/float.md)类型。
- `lat` — 纬度。 [Float64](../../data_types/float.md)类型。
- `resolution` — 索引的分辨率。 取值范围为: `[0, 15]`。 [UInt8](../../data_types/int_uint.md)类型。
**返回值**
- H3中六边形的索引值。
- 发生异常时返回0。
[UInt64](../../data_types/int_uint.md)类型。
**示例**
```sql
SELECT geoToH3(37.79506683, 55.71290588, 15) as h3Index
```
```text
┌────────────h3Index─┐
│ 644325524701193974 │
└────────────────────┘
```
## geohashesInBox
计算在指定精度下计算最小包含指定的经纬范围的最小图形的geohash数组。
**输入值**
- longitude_min - 最小经度。其值应在`[-180°180°]`范围内
- latitude_min - 最小纬度。其值应在`[-90°90°]`范围内
- longitude_max - 最大经度。其值应在`[-180°180°]`范围内
- latitude_max - 最大纬度。其值应在`[-90°90°]`范围内
- precision - geohash的精度。其值应在`[1, 12]`内的`UInt8`类型的数字
请注意,上述所有的坐标参数必须同为`Float32`或`Float64`中的一种类型。
**返回值**
- 包含指定范围内的指定精度的geohash字符串数组。注意您不应该依赖返回数组中geohash的顺序。
- [] - 当传入的最小经纬度大于最大经纬度时将返回一个空数组。
请注意如果生成的数组长度超过10000时则函数将抛出异常。
**示例**
```sql
SELECT geohashesInBox(24.48, 40.56, 24.785, 40.81, 4) AS thasos
```
```text
┌─thasos──────────────────────────────────────┐
│ ['sx1q','sx1r','sx32','sx1w','sx1x','sx38'] │
└─────────────────────────────────────────────┘
```
[来源文章](https://clickhouse.yandex/docs/en/query_language/functions/geo/) <!--hide--> [来源文章](https://clickhouse.yandex/docs/en/query_language/functions/geo/) <!--hide-->