> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
> Документация по H3
# Функции для работы с индексами H3
## индекс H3
[H3](https://h3geo.org/) — это система географической индексации, в которой поверхность Земли разбита на сетку из одинаковых шестиугольных ячеек. Эта система иерархична, то есть каждый шестиугольник верхнего уровня (`parent`) может быть разделён на семь таких же, но меньших (`children`), и так далее.
Уровень иерархии называется `resolution` и может принимать значения от `0` до `15`, где `0` — это уровень `base` с самыми большими и самыми грубыми ячейками.
Пару широты и долготы можно преобразовать в 64-битный индекс H3, который идентифицирует ячейку сетки.
Индекс H3 в основном используется для группировки местоположений по бакетам и других геопространственных преобразований.
Полное описание системы H3 доступно на [сайте Uber Engineering](https://www.uber.com/blog/h3/).
## h3IsValid
Проверяет, является ли число корректным индексом [H3](#h3-index).
**Синтаксис**
```sql theme={null}
h3IsValid(h3index)
```
**Параметр**
* `h3index` — Номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемые значения**
* 1 — Число является корректным индексом H3. [UInt8](/ru/reference/data-types/int-uint).
* 0 — Число не является корректным индексом H3. [UInt8](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3IsValid(630814730351855103) AS h3IsValid;
```
```text title="Response" theme={null}
┌─h3IsValid─┐
│ 1 │
└───────────┘
```
## h3GetResolution
Определяет разрешение для указанного [H3](#h3-index)-индекса.
**Синтаксис**
```sql theme={null}
h3GetResolution(h3index)
```
**Параметр**
* `h3index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемые значения**
* Разрешение индекса. Диапазон: `[0, 15]`. [UInt8](/ru/reference/data-types/int-uint).
* Если индекс некорректен, функция возвращает случайное значение. Используйте [h3IsValid](#h3isvalid), чтобы проверить индекс. [UInt8](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3GetResolution(639821929606596015) AS resolution;
```
```text title="Response" theme={null}
┌─resolution─┐
│ 14 │
└────────────┘
```
## h3EdgeAngle
Вычисляет среднюю длину ребра [H3](#h3-index)-шестиугольника в градах.
**Синтаксис**
```sql theme={null}
h3EdgeAngle(resolution)
```
**Параметр**
* `resolution` — разрешение индекса. [UInt8](/ru/reference/data-types/int-uint). Диапазон: `[0, 15]`.
**Возвращаемые значения**
* Средняя длина ребра шестиугольника [H3](#h3-index) в градах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3EdgeAngle(10) AS edgeAngle;
```
```text title="Response" theme={null}
┌───────h3EdgeAngle(10)─┐
│ 0.0005927224846720883 │
└───────────────────────┘
```
## h3EdgeLengthM
Вычисляет среднюю длину ребра шестиугольника [H3](#h3-index) в метрах.
**Синтаксис**
```sql theme={null}
h3EdgeLengthM(resolution)
```
**Параметр**
* `resolution` — разрешение индекса. [UInt8](/ru/reference/data-types/int-uint). Диапазон: `[0, 15]`.
**Возвращаемые значения**
* Средняя длина ребра [H3](#h3-index)-шестиугольника в метрах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3EdgeLengthM(15) AS edgeLengthM;
```
```text title="Response" theme={null}
┌─edgeLengthM─┐
│ 0.509713273 │
└─────────────┘
```
## h3EdgeLengthKm
Вычисляет среднюю длину ребра [шестиугольника H3](#h3-index) в километрах.
**Синтаксис**
```sql theme={null}
h3EdgeLengthKm(resolution)
```
**Параметр**
* `resolution` — разрешение индекса. [UInt8](/ru/reference/data-types/int-uint). Диапазон: `[0, 15]`.
**Возвращаемые значения**
* Средняя длина ребра шестиугольника [H3](#h3-index) в километрах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3EdgeLengthKm(15) AS edgeLengthKm;
```
```text title="Response" theme={null}
┌─edgeLengthKm─┐
│ 0.000509713 │
└──────────────┘
```
## geoToH3
Возвращает индекс точки [H3](#h3-index) `(lat, lon)` с указанным разрешением.
**Синтаксис**
```sql theme={null}
geoToH3(lat, lon, resolution)
```
**Аргументы**
* `lat` — Широта. [Float64](/ru/reference/data-types/float).
* `lon` — Долгота. [Float64](/ru/reference/data-types/float).
* `resolution` — Разрешение индекса. Диапазон: `[0, 15]`. [UInt8](/ru/reference/data-types/int-uint).
**Возвращаемые значения**
* Номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
* 0 в случае ошибки. [UInt64](/ru/reference/data-types/int-uint).
Примечание: в ClickHouse v25.4 и более ранних версиях `geoToH3()` принимает значения в порядке `(lon, lat)`. Начиная с ClickHouse v25.5, входные значения принимаются в порядке `(lat, lon)`. Предыдущее поведение можно восстановить с помощью настройки `geotoh3_argument_order = 'lon_lat'`.
**Пример**
```sql title="Query" theme={null}
SELECT geoToH3(55.71290588, 37.79506683, 15) AS h3Index;
```
```text title="Response" theme={null}
┌────────────h3Index─┐
│ 644325524701193974 │
└────────────────────┘
```
## h3ToGeo
Возвращает широту и долготу центра, соответствующие указанному индексу [H3](#h3-index).
**Синтаксис**
```sql theme={null}
h3ToGeo(h3Index)
```
**Аргументы**
* `h3Index` — индекс H3. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемые значения**
* Кортеж из двух значений: `tuple(lat,lon)`. `lat` — широта. [Float64](/ru/reference/data-types/float). `lon` — долгота. [Float64](/ru/reference/data-types/float).
Примечание: в ClickHouse v24.12 и более ранних версиях `h3ToGeo()` возвращает значения в порядке `(lon, lat)`. Начиная с ClickHouse v25.1, возвращаемые значения идут в порядке `(lat, lon)`. Предыдущее поведение можно восстановить с помощью настройки `h3togeo_lon_lat_result_order = true`.
**Пример**
```sql title="Query" theme={null}
SELECT h3ToGeo(644325524701193974) AS coordinates;
```
```text title="Response" theme={null}
┌─coordinates───────────────────────────┐
│ (55.71290243145668,37.79506616830252) │
└───────────────────────────────────────┘
```
## h3ToGeoBoundary
Возвращает массив пар `(lat, lon)`, соответствующий границе указанного индекса H3.
**Синтаксис**
```sql theme={null}
h3ToGeoBoundary(h3Index)
```
**Аргументы**
* `h3Index` — индекс H3. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемые значения**
* Массив пар '(lat, lon)'. [Array](/ru/reference/data-types/array)([Float64](/ru/reference/data-types/float), [Float64](/ru/reference/data-types/float)).
**Пример**
```sql title="Query" theme={null}
SELECT h3ToGeoBoundary(644325524701193974) AS coordinates;
```
```text title="Response" theme={null}
┌─h3ToGeoBoundary(599686042433355775)────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ [(37.2713558667319,-121.91508032705622),(37.353926450852256,-121.8622232890249),(37.42834118609435,-121.92354999630156),(37.42012867767779,-122.03773496427027),(37.33755608435299,-122.090428929044),(37.26319797461824,-122.02910130919001)] │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
```
## h3kRing
Перечисляет все [H3](#h3-index) шестиугольники, расположенные в радиусе `k` от заданного шестиугольника, в случайном порядке.
**Синтаксис**
```sql theme={null}
h3kRing(h3index, k)
```
**Аргументы**
* `h3index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
* `k` — радиус. [integer](/ru/reference/data-types/int-uint)
**Возвращаемые значения**
* Массив индексов H3. [Array](/ru/reference/data-types/array)([UInt64](/ru/reference/data-types/int-uint)).
**Пример**
```sql title="Query" theme={null}
SELECT arrayJoin(h3kRing(644325529233966508, 1)) AS h3index;
```
```text title="Response" theme={null}
┌────────────h3index─┐
│ 644325529233966508 │
│ 644325529233966497 │
│ 644325529233966510 │
│ 644325529233966504 │
│ 644325529233966509 │
│ 644325529233966355 │
│ 644325529233966354 │
└────────────────────┘
```
## h3PolygonToCells
Возвращает шестиугольники (с указанным разрешением), содержащиеся в заданной геометрии: ring или (multi-)polygon.
**Синтаксис**
```sql theme={null}
h3PolygonToCells(geometry, resolution)
```
**Аргументы**
* `geometry` может быть одним из следующих [гео-типов данных](/ru/reference/data-types/geo) или соответствующих примитивных типов:
* [Ring](/ru/reference/data-types/geo#ring)
* [Polygon](/ru/reference/data-types/geo#polygon)
* [MultiPolygon](/ru/reference/data-types/geo#multipolygon)
* `resolution` — разрешение индекса. Диапазон: `[0, 15]`. [UInt8](/ru/reference/data-types/int-uint).
**Возвращаемые значения**
* Массив содержащихся индексов H3. [Array](/ru/reference/data-types/array)([UInt64](/ru/reference/data-types/int-uint)).
**Пример**
```sql title="Query" theme={null}
SELECT h3PolygonToCells([(-122.4089866999972145,37.813318999983238),(-122.3544736999993603,37.7198061999978478),(-122.4798767000009008,37.8151571999998453)], 7) AS h3index;
```
```text title="Response" theme={null}
┌────────────h3index─┐
│ 608692970769612799 │
│ 608692971927240703 │
│ 608692970585063423 │
│ 608692970819944447 │
│ 608692970719281151 │
│ 608692970752835583 │
│ 608692972027903999 │
└────────────────────┘
```
## h3GetBaseCell
Возвращает номер базовой ячейки индекса [H3](#h3-index).
**Синтаксис**
```sql theme={null}
h3GetBaseCell(index)
```
**Параметр**
* `index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Номер базовой ячейки шестиугольника. [UInt8](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3GetBaseCell(612916788725809151) AS basecell;
```
```text title="Response" theme={null}
┌─basecell─┐
│ 12 │
└──────────┘
```
## h3HexAreaM2
Возвращает среднюю площадь шестиугольника в квадратных метрах для заданного разрешения.
**Синтаксис**
```sql theme={null}
h3HexAreaM2(resolution)
```
**Параметр**
* `resolution` — Разрешение индекса. Диапазон: `[0, 15]`. [UInt8](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Площадь в квадратных метрах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3HexAreaM2(13) AS area;
```
```text title="Response" theme={null}
┌─area─┐
│ 43.9 │
└──────┘
```
## h3HexAreaKm2
Возвращает среднюю площадь шестиугольника в квадратных километрах для заданного разрешения.
**Синтаксис**
```sql theme={null}
h3HexAreaKm2(resolution)
```
**Параметр**
* `resolution` — разрешение индекса. Диапазон: `[0, 15]`. [UInt8](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Площадь в квадратных километрах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3HexAreaKm2(13) AS area;
```
```text title="Response" theme={null}
┌──────area─┐
│ 0.0000439 │
└───────────┘
```
## h3IndexesAreNeighbors
Возвращает, являются ли указанные индексы [H3](#h3-index) соседними.
**Синтаксис**
```sql theme={null}
h3IndexesAreNeighbors(index1, index2)
```
**Аргументы**
* `index1` — Номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
* `index2` — Номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* `1` — Индексы являются соседями. [UInt8](/ru/reference/data-types/int-uint).
* `0` — Индексы не являются соседями. [UInt8](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3IndexesAreNeighbors(617420388351344639, 617420388352655359) AS n;
```
```text title="Response" theme={null}
┌─n─┐
│ 1 │
└───┘
```
## h3ToChildren
Возвращает массив дочерних индексов для заданного индекса [H3](#h3-index).
**Синтаксис**
```sql theme={null}
h3ToChildren(index, resolution)
```
**Аргументы**
* `index` — Номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
* `resolution` — Разрешение индекса. Диапазон: `[0, 15]`. [UInt8](/ru/reference/data-types/int-uint).
**Возвращаемые значения**
* Массив дочерних H3-индексов. [Array](/ru/reference/data-types/array)([UInt64](/ru/reference/data-types/int-uint)).
**Пример**
```sql title="Query" theme={null}
SELECT h3ToChildren(599405990164561919, 6) AS children;
```
```text title="Response" theme={null}
┌─children───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ [603909588852408319,603909588986626047,603909589120843775,603909589255061503,603909589389279231,603909589523496959,603909589657714687] │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
```
## h3ToParent
Возвращает родительский индекс более общего уровня, содержащий указанный индекс [H3](#h3-index).
**Синтаксис**
```sql theme={null}
h3ToParent(index, resolution)
```
**Аргументы**
* `index` — Номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
* `resolution` — Разрешение индекса. Диапазон: `[0, 15]`. [UInt8](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Родительский индекс H3. [UInt64](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3ToParent(599405990164561919, 3) AS parent;
```
```text title="Response" theme={null}
┌─────────────parent─┐
│ 590398848891879423 │
└────────────────────┘
```
## h3ToString
Преобразует представление индекса `H3Index` в строковое представление.
```sql theme={null}
h3ToString(index)
```
**Параметр**
* `index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Строковое представление индекса H3. [String](/ru/reference/data-types/string).
**Пример**
```sql title="Query" theme={null}
SELECT h3ToString(617420388352917503) AS h3_string;
```
```text title="Response" theme={null}
┌─h3_string───────┐
│ 89184926cdbffff │
└─────────────────┘
```
## stringToH3
Преобразует строковое представление в формат `H3Index` (UInt64).
**Синтаксис**
```sql theme={null}
stringToH3(index_str)
```
**Параметр**
* `index_str` — Строковое представление индекса H3. [String](/ru/reference/data-types/string).
**Возвращаемое значение**
* Номер шестиугольного индекса. При ошибке возвращает 0. [UInt64](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT stringToH3('89184926cc3ffff') AS index;
```
```text title="Response" theme={null}
┌──────────────index─┐
│ 617420388351344639 │
└────────────────────┘
```
## h3GetResolution
Возвращает разрешение индекса [H3](#h3-index).
**Синтаксис**
```sql theme={null}
h3GetResolution(index)
```
**Параметр**
* `index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Разрешение индекса. Диапазон: `[0, 15]`. [UInt8](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3GetResolution(617420388352917503) AS res;
```
```text title="Response" theme={null}
┌─res─┐
│ 9 │
└─────┘
```
## h3IsResClassIII
Возвращает, имеет ли [H3](#h3-index) индекс разрешение с ориентацией класса III.
**Синтаксис**
```sql theme={null}
h3IsResClassIII(index)
```
**Параметр**
* `index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* `1` — индекс относится к разрешению с ориентацией Class III. [UInt8](/ru/reference/data-types/int-uint).
* `0` — индекс не относится к разрешению с ориентацией Class III. [UInt8](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3IsResClassIII(617420388352917503) AS res;
```
```text title="Response" theme={null}
┌─res─┐
│ 1 │
└─────┘
```
## h3IsPentagon
Возвращает, является ли этот индекс [H3](#h3-index) пятиугольной ячейкой.
**Синтаксис**
```sql theme={null}
h3IsPentagon(index)
```
**Параметр**
* `index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* `1` — индекс соответствует пятиугольной ячейке. [UInt8](/ru/reference/data-types/int-uint).
* `0` — индекс не соответствует пятиугольной ячейке. [UInt8](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3IsPentagon(644721767722457330) AS pentagon;
```
```text title="Response" theme={null}
┌─pentagon─┐
│ 0 │
└──────────┘
```
## h3GetFaces
Возвращает грани икосаэдра, с которыми пересекается указанный индекс [H3](#h3-index).
**Синтаксис**
```sql theme={null}
h3GetFaces(index)
```
**Параметр**
* `index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемые значения**
* [Array](/ru/reference/data-types/array)([UInt64](/ru/reference/data-types/int-uint])) — массив граней икосаэдра, с которыми пересекается указанный индекс H3.
**Пример**
```sql title="Query" theme={null}
SELECT h3GetFaces(599686042433355775) AS faces;
```
```text title="Response" theme={null}
┌─faces─┐
│ [7] │
└───────┘
```
## h3CellAreaM2
Возвращает точную площадь конкретной ячейки в квадратных метрах для указанного индекса H3.
**Синтаксис**
```sql theme={null}
h3CellAreaM2(index)
```
**Параметр**
* `index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Площадь ячейки в квадратных метрах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3CellAreaM2(579205133326352383) AS area;
```
```text title="Response" theme={null}
┌───────────────area─┐
│ 4106166334463.9233 │
└────────────────────┘
```
## h3CellAreaRads2
Возвращает точную площадь заданной ячейки в квадратных радианах для указанного индекса H3.
**Синтаксис**
```sql theme={null}
h3CellAreaRads2(index)
```
**Параметр**
* `index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Площадь ячейки в квадратных радианах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3CellAreaRads2(579205133326352383) AS area;
```
```text title="Response" theme={null}
┌────────────────area─┐
│ 0.10116268528089567 │
└─────────────────────┘
```
## h3ToCenterChild
Возвращает центральный дочерний (более детализированный) [H3](#h3-index) индекс, входящий в заданный [H3](#h3-index), на указанном разрешении.
**Синтаксис**
```sql theme={null}
h3ToCenterChild(index, resolution)
```
**Параметры**
* `index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
* `resolution` — разрешение индекса. Диапазон: `[0, 15]`. [UInt8](/ru/reference/data-types/int-uint).
**Возвращаемые значения**
* Индекс [H3](#h3-index) центральной дочерней ячейки, содержащейся в указанном индексе [H3](#h3-index) при заданном разрешении. [UInt64](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3ToCenterChild(577023702256844799,1) AS centerToChild;
```
```text title="Response" theme={null}
┌──────centerToChild─┐
│ 581496515558637567 │
└────────────────────┘
```
## h3ExactEdgeLengthM
Возвращает точную длину однонаправленного ребра, представленного входным индексом H3, в метрах.
**Синтаксис**
```sql theme={null}
h3ExactEdgeLengthM(index)
```
**Параметр**
* `index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Точная длина ребра в метрах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3ExactEdgeLengthM(1310277011704381439) AS exactEdgeLengthM;;
```
```text title="Response" theme={null}
┌───exactEdgeLengthM─┐
│ 195449.63163407316 │
└────────────────────┘
```
## h3ExactEdgeLengthKm
Возвращает точную длину однонаправленного ребра, представленного переданным индексом H3, в километрах.
**Синтаксис**
```sql theme={null}
h3ExactEdgeLengthKm(index)
```
**Параметр**
* `index` — Номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Точная длина ребра в километрах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3ExactEdgeLengthKm(1310277011704381439) AS exactEdgeLengthKm;;
```
```text title="Response" theme={null}
┌──exactEdgeLengthKm─┐
│ 195.44963163407317 │
└────────────────────┘
```
## h3ExactEdgeLengthRads
Возвращает точную длину однонаправленного ребра, представленного входным индексом H3, в радианах.
**Синтаксис**
```sql theme={null}
h3ExactEdgeLengthRads(index)
```
**Параметр**
* `index` — номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Точная длина ребра в радианах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3ExactEdgeLengthRads(1310277011704381439) AS exactEdgeLengthRads;;
```
```text title="Response" theme={null}
┌──exactEdgeLengthRads─┐
│ 0.030677980118976447 │
└──────────────────────┘
```
## h3NumHexagons
Возвращает количество уникальных индексов H3 для заданного разрешения.
**Синтаксис**
```sql theme={null}
h3NumHexagons(resolution)
```
**Параметр**
* `resolution` — разрешение индекса. Диапазон: `[0, 15]`. [UInt8](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Количество индексов H3. [Int64](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3NumHexagons(3) AS numHexagons;
```
```text title="Response" theme={null}
┌─numHexagons─┐
│ 41162 │
└─────────────┘
```
## h3PointDistM
Возвращает расстояние в метрах по "дуге большого круга" или по формуле "гаверсинуса" между парами точек GeoCoord (широта/долгота).
**Синтаксис**
```sql theme={null}
h3PointDistM(lat1, lon1, lat2, lon2)
```
**Аргументы**
* `lat1`, `lon1` — широта и долгота точки 1 в градусах. [Float64](/ru/reference/data-types/float).
* `lat2`, `lon2` — широта и долгота точки 2 в градусах. [Float64](/ru/reference/data-types/float).
**Возвращаемые значения**
* Расстояние по гаверсинусу или расстояние по дуге большого круга в метрах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3PointDistM(-10.0 ,0.0, 10.0, 0.0) AS h3PointDistM;
```
```text title="Response" theme={null}
┌──────h3PointDistM─┐
│ 2223901.039504589 │
└───────────────────┘
```
## h3PointDistKm
Возвращает расстояние в километрах между парами точек GeoCoord (широта/долгота), вычисленное по "дуге большого круга" или по формуле "гаверсинуса".
**Синтаксис**
```sql theme={null}
h3PointDistKm(lat1, lon1, lat2, lon2)
```
**Аргументы**
* `lat1`, `lon1` — широта и долгота точки 1 в градусах. [Float64](/ru/reference/data-types/float).
* `lat2`, `lon2` — широта и долгота точки 2 в градусах. [Float64](/ru/reference/data-types/float).
**Возвращаемые значения**
* Расстояние, вычисленное по гаверсинусу или по дуге большого круга, в километрах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3PointDistKm(-10.0 ,0.0, 10.0, 0.0) AS h3PointDistKm;
```
```text title="Response" theme={null}
┌─────h3PointDistKm─┐
│ 2223.901039504589 │
└───────────────────┘
```
## h3PointDistRads
Возвращает расстояние между парами точек GeoCoord (широта/долгота), вычисленное по дуге большого круга или по формуле гаверсинуса, в радианах.
**Синтаксис**
```sql theme={null}
h3PointDistRads(lat1, lon1, lat2, lon2)
```
**Аргументы**
* `lat1`, `lon1` — широта и долгота точки 1 в градусах. [Float64](/ru/reference/data-types/float).
* `lat2`, `lon2` — широта и долгота точки 2 в градусах. [Float64](/ru/reference/data-types/float).
**Возвращаемые значения**
* Расстояние по формуле гаверсинуса или длина дуги большого круга в радианах. [Float64](/ru/reference/data-types/float).
**Пример**
```sql title="Query" theme={null}
SELECT h3PointDistRads(-10.0 ,0.0, 10.0, 0.0) AS h3PointDistRads;
```
```text title="Response" theme={null}
┌────h3PointDistRads─┐
│ 0.3490658503988659 │
└────────────────────┘
```
## h3GetRes0Indexes
Возвращает массив всех индексов H3 нулевого разрешения.
**Синтаксис**
```sql theme={null}
h3GetRes0Indexes()
```
**Возвращаемые значения**
* Массив всех индексов H3 с разрешением 0. [Array](/ru/reference/data-types/array)([UInt64](/ru/reference/data-types/int-uint)).
**Пример**
```sql title="Query" theme={null}
SELECT h3GetRes0Indexes AS indexes ;
```
```text title="Response" theme={null}
┌─indexes─────────────────────────────────────┐
│ [576495936675512319,576531121047601151,....]│
└─────────────────────────────────────────────┘
```
## h3GetPentagonIndexes
Возвращает все пятиугольные индексы H3 при указанном разрешении.
**Синтаксис**
```sql theme={null}
h3GetPentagonIndexes(resolution)
```
**Параметр**
* `resolution` — разрешение индекса. Диапазон: `[0, 15]`. [UInt8](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Массив всех пятиугольных индексов H3. [Array](/ru/reference/data-types/array)([UInt64](/ru/reference/data-types/int-uint)).
**Пример**
```sql title="Query" theme={null}
SELECT h3GetPentagonIndexes(3) AS indexes;
```
```text title="Response" theme={null}
┌─indexes────────────────────────────────────────────────────────┐
│ [590112357393367039,590464201114255359,590816044835143679,...] │
└────────────────────────────────────────────────────────────────┘
```
## h3Line
Возвращает линию, соединяющую два указанных индекса.
**Синтаксис**
```sql theme={null}
h3Line(start,end)
```
**Параметры**
* `start` — Номер шестиугольного индекса, представляющий начальную точку. [UInt64](/ru/reference/data-types/int-uint).
* `end` — Номер шестиугольного индекса, представляющий конечную точку. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
Массив индексов H3, представляющих линию между двумя указанными индексами. [Array](/ru/reference/data-types/array)([UInt64](/ru/reference/data-types/int-uint)).
**Пример**
```sql title="Query" theme={null}
SELECT h3Line(590080540275638271,590103561300344831) AS indexes;
```
```text title="Response" theme={null}
┌─indexes────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ [590080540275638271,590080471556161535,590080883873021951,590106516237844479,590104385934065663,590103630019821567,590103561300344831] │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
```
## h3Distance
Возвращает расстояние между двумя указанными индексами в ячейках сетки.
**Синтаксис**
```sql theme={null}
h3Distance(start,end)
```
**Параметр**
* `start` — номер шестиугольного индекса, обозначающий начальную точку. [UInt64](/ru/reference/data-types/int-uint).
* `end` — номер шестиугольного индекса, обозначающий конечную точку. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Количество ячеек сетки. [Int64](/ru/reference/data-types/int-uint).
Возвращает отрицательное число, если определить расстояние не удаётся.
**Пример**
```sql title="Query" theme={null}
SELECT h3Distance(590080540275638271,590103561300344831) AS distance;
```
```text title="Response" theme={null}
┌─distance─┐
│ 7 │
└──────────┘
```
## h3HexRing
Возвращает индексы шестиугольного кольца длины k с центром в указанном исходном h3Index.
Возвращает 0, если пентагональных искажений не обнаружено.
**Синтаксис**
```sql theme={null}
h3HexRing(index, k)
```
**Параметр**
* `index` — Номер шестиугольного индекса, представляющий исходную ячейку. [UInt64](/ru/reference/data-types/int-uint).
* `k` — Расстояние. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемые значения**
* Массив индексов H3. [Array](/ru/reference/data-types/array)([UInt64](/ru/reference/data-types/int-uint)).
**Пример**
```sql title="Query" theme={null}
SELECT h3HexRing(590080540275638271, toUInt16(1)) AS hexRing;
```
```text title="Response" theme={null}
┌─hexRing─────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ [590080815153545215,590080471556161535,590080677714591743,590077585338138623,590077447899185151,590079509483487231] │
└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
```
## h3GetUnidirectionalEdge
Возвращает индекс H3 для однонаправленного ребра на основе указанных исходной ячейки и пункта назначения; в случае ошибки возвращает 0.
**Синтаксис**
```sql theme={null}
h3GetUnidirectionalEdge(originIndex, destinationIndex)
```
**Параметр**
* `originIndex` — Номер шестиугольного индекса исходной ячейки. [UInt64](/ru/reference/data-types/int-uint).
* `destinationIndex` — Номер шестиугольного индекса целевой ячейки. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Номер шестиугольного индекса однонаправленного ребра. [UInt64](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3GetUnidirectionalEdge(599686042433355775, 599686043507097599) AS edge;
```
```text title="Response" theme={null}
┌────────────────edge─┐
│ 1248204388774707199 │
└─────────────────────┘
```
## h3UnidirectionalEdgeIsValid
Проверяет, является ли указанный H3Index корректным индексом однонаправленного ребра. Возвращает 1, если это однонаправленное ребро, и 0 в противном случае.
**Синтаксис**
```sql theme={null}
h3UnidirectionalEdgeisValid(index)
```
**Параметр**
* `index` — Номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* 1 — Индекс H3 является валидным однонаправленным ребром. [UInt8](/ru/reference/data-types/int-uint).
* 0 — Индекс H3 не является валидным однонаправленным ребром. [UInt8](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3UnidirectionalEdgeIsValid(1248204388774707199) AS validOrNot;
```
```text title="Response" theme={null}
┌─validOrNot─┐
│ 1 │
└────────────┘
```
## h3GetOriginIndexFromUnidirectionalEdge
Возвращает индекс исходного шестиугольника по H3Index однонаправленного ребра.
**Синтаксис**
```sql theme={null}
h3GetOriginIndexFromUnidirectionalEdge(edge)
```
**Параметр**
* `edge` — номер шестиугольного индекса, представляющего однонаправленное ребро. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Номер исходного шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3GetOriginIndexFromUnidirectionalEdge(1248204388774707197) AS origin;
```
```text title="Response" theme={null}
┌─────────────origin─┐
│ 599686042433355773 │
└────────────────────┘
```
## h3GetDestinationIndexFromUnidirectionalEdge
Возвращает индекс шестиугольника пункта назначения по однонаправленному ребру H3Index.
**Синтаксис**
```sql theme={null}
h3GetDestinationIndexFromUnidirectionalEdge(edge)
```
**Параметр**
* `edge` — номер шестиугольного индекса, представляющего однонаправленное ребро. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Номер шестиугольного индекса пункта назначения. [UInt64](/ru/reference/data-types/int-uint).
**Пример**
```sql title="Query" theme={null}
SELECT h3GetDestinationIndexFromUnidirectionalEdge(1248204388774707197) AS destination;
```
```text title="Response" theme={null}
┌────────destination─┐
│ 599686043507097597 │
└────────────────────┘
```
## h3GetIndexesFromUnidirectionalEdge
Возвращает индексы исходного шестиугольника и шестиугольника в пункте назначения для указанного H3Index однонаправленного ребра.
**Синтаксис**
```sql theme={null}
h3GetIndexesFromUnidirectionalEdge(edge)
```
**Параметр**
* `edge` — номер шестиугольного индекса, который представляет однонаправленное ребро. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
Кортеж, состоящий из двух значений `tuple(origin,destination)`:
* `origin` — исходный номер шестиугольного индекса. [UInt64](/ru/reference/data-types/int-uint).
* `destination` — номер шестиугольного индекса пункта назначения. [UInt64](/ru/reference/data-types/int-uint).
Возвращает `(0,0)`, если переданное значение недопустимо.
**Пример**
```sql title="Query" theme={null}
SELECT h3GetIndexesFromUnidirectionalEdge(1248204388774707199) AS indexes;
```
```text title="Response" theme={null}
┌─indexes─────────────────────────────────┐
│ (599686042433355775,599686043507097599) │
└─────────────────────────────────────────┘
```
## h3GetUnidirectionalEdgesFromHexagon
Возвращает все однонаправленные рёбра для указанного H3Index.
**Синтаксис**
```sql theme={null}
h3GetUnidirectionalEdgesFromHexagon(index)
```
**Параметр**
* `index` — номер шестиугольного индекса, соответствующий однонаправленному ребру. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
Массив индексов H3, представляющих каждое однонаправленное ребро. [Array](/ru/reference/data-types/array)([UInt64](/ru/reference/data-types/int-uint)).
**Пример**
```sql title="Query" theme={null}
SELECT h3GetUnidirectionalEdgesFromHexagon(1248204388774707199) AS edges;
```
```text title="Response" theme={null}
┌─edges─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ [1248204388774707199,1320261982812635135,1392319576850563071,1464377170888491007,1536434764926418943,1608492358964346879] │
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
```
## h3GetUnidirectionalEdgeBoundary
Возвращает координаты, задающие однонаправленное ребро.
**Синтаксис**
```sql theme={null}
h3GetUnidirectionalEdgeBoundary(index)
```
**Параметр**
* `index` — номер шестиугольного индекса, представляющий однонаправленное ребро. [UInt64](/ru/reference/data-types/int-uint).
**Возвращаемое значение**
* Массив пар '(lon, lat)'. [Array](/ru/reference/data-types/array)([Float64](/ru/reference/data-types/float), [Float64](/ru/reference/data-types/float)).
**Пример**
```sql title="Query" theme={null}
SELECT h3GetUnidirectionalEdgeBoundary(1248204388774707199) AS boundary;
```
```text title="Response" theme={null}
┌─boundary────────────────────────────────────────────────────────────────────────┐
│ [(37.42012867767779,-122.03773496427027),(37.33755608435299,-122.090428929044)] │
└─────────────────────────────────────────────────────────────────────────────────┘
```