> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-fbfa8bee.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
> Documentation sur H3
# Fonctions pour manipuler les indexes H3
## H3 Index
[H3](https://h3geo.org/) est un système d’indexation géographique dans lequel la surface de la Terre est divisée en une grille régulière de cellules hexagonales. Ce système est hiérarchique, c’est-à-dire que chaque hexagone du niveau supérieur (« parent ») peut être subdivisé en sept hexagones réguliers plus petits (« enfants »), et ainsi de suite.
Le niveau de la hiérarchie est appelé `resolution` et peut prendre une valeur de `0` à `15`, où `0` correspond au niveau `base`, avec les cellules les plus grandes et les moins fines.
Une paire latitude/longitude peut être convertie en un index H3 de 64 bits, qui identifie une cellule de la grille.
L’index H3 est principalement utilisé pour regrouper des lieux et pour d’autres manipulations géospatiales.
Une description complète du système H3 est disponible sur [le site d’Uber Engineering](https://www.uber.com/blog/h3/).
## h3IsValid
Vérifie si le nombre correspond à un index [H3](#h3-index) valide.
**Syntaxe**
```sql theme={null}
h3IsValid(h3index)
```
**Paramètre**
* `h3index` — Numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
**Valeurs de retour**
* 1 — Le nombre correspond à un index H3 valide. [UInt8](/fr/reference/data-types/int-uint).
* 0 — Le nombre ne correspond pas à un index H3 valide. [UInt8](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3IsValid(630814730351855103) AS h3IsValid;
```
```text title="Response" theme={null}
┌─h3IsValid─┐
│ 1 │
└───────────┘
```
## h3GetResolution
Définit la résolution de l’index [H3](#h3-index) donné.
**Syntaxe**
```sql theme={null}
h3GetResolution(h3index)
```
**Paramètre**
* `h3index` — Numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
**Valeurs renvoyées**
* Résolution de l’index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
* Si l’index n’est pas valide, la fonction renvoie une valeur aléatoire. Utilisez [h3IsValid](#h3isvalid) pour vérifier l’index. [UInt8](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetResolution(639821929606596015) AS resolution;
```
```text title="Response" theme={null}
┌─resolution─┐
│ 14 │
└────────────┘
```
## h3EdgeAngle
Calcule la longueur moyenne d’un arête d’un hexagone [H3](#h3-index) en grades.
**Syntaxe**
```sql theme={null}
h3EdgeAngle(resolution)
```
**Paramètre**
* `resolution` — Résolution de l’index. [UInt8](/fr/reference/data-types/int-uint). Plage : `[0, 15]`.
**Valeurs renvoyées**
* La longueur moyenne de l’arête d’un hexagone [H3](#h3-index), exprimée en grades. [Float64](/fr/reference/data-types/float).
**Exemple**
```sql title="Query" theme={null}
SELECT h3EdgeAngle(10) AS edgeAngle;
```
```text title="Response" theme={null}
┌───────h3EdgeAngle(10)─┐
│ 0.0005927224846720883 │
└───────────────────────┘
```
## h3EdgeLengthM
Calcule la longueur moyenne d’une arête d’un hexagone [H3](#h3-index), en mètres.
**Syntaxe**
```sql theme={null}
h3EdgeLengthM(resolution)
```
**Paramètre**
* `resolution` — Résolution de l’index. [UInt8](/fr/reference/data-types/int-uint). Plage : `[0, 15]`.
**Valeurs renvoyées**
* La longueur moyenne d’une arête d’un hexagone [H3](#h3-index), en mètres. [Float64](/fr/reference/data-types/float).
**Exemple**
```sql title="Query" theme={null}
SELECT h3EdgeLengthM(15) AS edgeLengthM;
```
```text title="Response" theme={null}
┌─edgeLengthM─┐
│ 0.509713273 │
└─────────────┘
```
## h3EdgeLengthKm
Calcule la longueur moyenne d’une arête d’un hexagone [H3](#h3-index), en kilomètres.
**Syntaxe**
```sql theme={null}
h3EdgeLengthKm(resolution)
```
**Paramètre**
* `resolution` — Résolution de l’index. [UInt8](/fr/reference/data-types/int-uint). Valeurs possibles : `[0, 15]`.
**Valeurs renvoyées**
* La longueur moyenne d’une arête d’un hexagone [H3](#h3-index), en kilomètres. [Float64](/fr/reference/data-types/float).
**Exemple**
```sql title="Query" theme={null}
SELECT h3EdgeLengthKm(15) AS edgeLengthKm;
```
```text title="Response" theme={null}
┌─edgeLengthKm─┐
│ 0.000509713 │
└──────────────┘
```
## geoToH3
Renvoie l’index [H3](#h3-index) du point `(lat, lon)` à la résolution spécifiée.
**Syntaxe**
```sql theme={null}
geoToH3(lat, lon, resolution)
```
**Arguments**
* `lat` — Latitude. [Float64](/fr/reference/data-types/float).
* `lon` — Longitude. [Float64](/fr/reference/data-types/float).
* `resolution` — Résolution de l’index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
**Valeurs renvoyées**
* Numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
* 0 en cas d’erreur. [UInt64](/fr/reference/data-types/int-uint).
Remarque : dans ClickHouse v25.4 ou une version antérieure, `geoToH3()` attend les valeurs dans l’ordre `(lon, lat)`. À partir de ClickHouse v25.5, les valeurs d’entrée sont dans l’ordre `(lat, lon)`. Le comportement précédent peut être rétabli à l’aide du paramètre `geotoh3_argument_order = 'lon_lat'`.
**Exemple**
```sql title="Query" theme={null}
SELECT geoToH3(55.71290588, 37.79506683, 15) AS h3Index;
```
```text title="Response" theme={null}
┌────────────h3Index─┐
│ 644325524701193974 │
└────────────────────┘
```
## h3ToGeo
Renvoie la latitude et la longitude du centroïde correspondant à l’index [H3](#h3-index) indiqué.
**Syntaxe**
```sql theme={null}
h3ToGeo(h3Index)
```
**Arguments**
* `h3Index` — index H3. [UInt64](/fr/reference/data-types/int-uint).
**Valeurs renvoyées**
* Un tuple composé de deux valeurs : `tuple(lat,lon)`. `lat` — Latitude. [Float64](/fr/reference/data-types/float). `lon` — Longitude. [Float64](/fr/reference/data-types/float).
Remarque : dans ClickHouse v24.12 et les versions antérieures, `h3ToGeo()` renvoie les valeurs dans l’ordre `(lon, lat)`. À partir de ClickHouse v25.1, les valeurs renvoyées sont dans l’ordre `(lat, lon)`. Le comportement précédent peut être restauré à l’aide du paramètre `h3togeo_lon_lat_result_order = true`.
**Exemple**
```sql title="Query" theme={null}
SELECT h3ToGeo(644325524701193974) AS coordinates;
```
```text title="Response" theme={null}
┌─coordinates───────────────────────────┐
│ (55.71290243145668,37.79506616830252) │
└───────────────────────────────────────┘
```
## h3ToGeoBoundary
Renvoie un Array de paires `(lat, lon)` représentant le contour de l’index H3 fourni.
**Syntaxe**
```sql theme={null}
h3ToGeoBoundary(h3Index)
```
**Arguments**
* `h3Index` — index H3. [UInt64](/fr/reference/data-types/int-uint).
**Valeurs renvoyées**
* Tableau de paires '(lat, lon)'. [Array](/fr/reference/data-types/array)([Float64](/fr/reference/data-types/float), [Float64](/fr/reference/data-types/float)).
**Exemple**
```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
Liste tous les hexagones [H3](#h3-index) situés dans un rayon de `k` autour de l’hexagone donné, dans un ordre aléatoire.
**Syntaxe**
```sql theme={null}
h3kRing(h3index, k)
```
**Arguments**
* `h3index` — Numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
* `k` — Rayon. [entier](/fr/reference/data-types/int-uint)
**Valeurs renvoyées**
* Tableau d’index H3. [Array](/fr/reference/data-types/array)([UInt64](/fr/reference/data-types/int-uint)).
**Exemple**
```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
Renvoie les hexagones (à la résolution spécifiée) compris dans la géométrie fournie, qu’il s’agisse d’un Ring ou d’un (multi-)Polygon.
**Syntaxe**
```sql theme={null}
h3PolygonToCells(geometry, resolution)
```
**Arguments**
* `geometry` peut être l’un des [Geo Data Types](/fr/reference/data-types/geo) suivants ou l’un de leurs types primitifs sous-jacents :
* [Ring](/fr/reference/data-types/geo#ring)
* [Polygon](/fr/reference/data-types/geo#polygon)
* [MultiPolygon](/fr/reference/data-types/geo#multipolygon)
* `resolution` — Résolution de l’index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
**Valeurs renvoyées**
* Tableau des index H3 contenus. [Array](/fr/reference/data-types/array)([UInt64](/fr/reference/data-types/int-uint)).
**Exemple**
```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 │
└────────────────────┘
```
## h3PolygonToCellsWithContainment
Renvoie les hexagones (à la résolution spécifiée) qui recouvrent la géométrie fournie — un `ring` ou un `(multi-)polygon` — en utilisant les modes de containment expérimentaux de H3.
Cette fonction associe les `flags` aux modes de containment H3 :
* `0` — `CONTAINMENT_CENTER`
* `1` — `CONTAINMENT_FULL`
* `2` — `CONTAINMENT_OVERLAPPING`
* `3` — `CONTAINMENT_OVERLAPPING_BBOX`
**Syntaxe**
```sql theme={null}
h3PolygonToCellsWithContainment(geometry, resolution, flags)
```
**Arguments**
* `geometry` peut être l’un des [types de données Geo](/fr/reference/data-types/geo) suivants, ou l’un de leurs types primitifs sous-jacents :
* [Ring](/fr/reference/data-types/geo#ring)
* [Polygon](/fr/reference/data-types/geo#polygon)
* [MultiPolygon](/fr/reference/data-types/geo#multipolygon)
* `resolution` — Résolution de l’index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
* `flags` — Mode de containment. Plage : `[0, 3]`. Utilisez des littéraux entiers tels que `0`, `1`, `2` et `3`, ou des valeurs [UInt32](/fr/reference/data-types/int-uint) (par exemple, `toUInt32(2)`). Les valeurs sont transmises à l’API H3 sous forme de `UInt32`. Les autres types entiers natifs sont convertis avec exactitude.
**Valeurs renvoyées**
* Tableau d’index H3 selon le mode de containment sélectionné. [Array](/fr/reference/data-types/array)([UInt64](/fr/reference/data-types/int-uint)).
**Exemple**
```sql title="Query" theme={null}
SELECT
h3PolygonToCellsWithContainment([(-122.4089866999972145, 37.813318999983238), (-122.3544736999993603, 37.7198061999978478), (-122.4798767000009008, 37.8151571999998453)], 7, 0) AS center_cells,
h3PolygonToCellsWithContainment([(-122.4089866999972145, 37.813318999983238), (-122.3544736999993603, 37.7198061999978478), (-122.4798767000009008, 37.8151571999998453)], 7, 2) AS overlap_cells;
```
```text title="Response" theme={null}
┌─center_cells───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┬─overlap_cells──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
1. │ [608692970585063423,608692970719281151,608692970752835583,608692970769612799,608692970819944447,608692971927240703,608692972027903999] │ [608692970249519103,608692970266296319,608692970585063423,608692970601840639,608692970635395071,608692970685726719,608692970719281151,608692970736058367,608692970752835583,608692970769612799,608692970786390015,608692970819944447,608692971927240703,608692971994349567,608692972027903999] │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
```
## h3GetBaseCell
Renvoie le numéro de la cellule de base de l’index [H3](#h3-index).
**Syntaxe**
```sql theme={null}
h3GetBaseCell(index)
```
**Paramètre**
* `index` — Numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Numéro de cellule de base de l’hexagone. [UInt8](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetBaseCell(612916788725809151) AS basecell;
```
```text title="Response" theme={null}
┌─basecell─┐
│ 12 │
└──────────┘
```
## h3HexAreaM2
Renvoie la surface moyenne d’un hexagone en mètres carrés pour la résolution donnée.
**Syntaxe**
```sql theme={null}
h3HexAreaM2(resolution)
```
**Paramètre**
* `resolution` — Résolution de l’index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Superficie en mètres carrés. [Float64](/fr/reference/data-types/float).
**Exemple**
```sql title="Query" theme={null}
SELECT h3HexAreaM2(13) AS area;
```
```text title="Response" theme={null}
┌─area─┐
│ 43.9 │
└──────┘
```
## h3HexAreaKm2
Renvoie la superficie moyenne d’un hexagone, en kilomètres carrés, pour la résolution donnée.
**Syntaxe**
```sql theme={null}
h3HexAreaKm2(resolution)
```
**Paramètre**
* `resolution` — Résolution de l’index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Surface en kilomètres carrés. [Float64](/fr/reference/data-types/float).
**Exemple**
```sql title="Query" theme={null}
SELECT h3HexAreaKm2(13) AS area;
```
```text title="Response" theme={null}
┌──────area─┐
│ 0.0000439 │
└───────────┘
```
## h3IndexesAreNeighbors
Indique si les index [H3](#h3-index) spécifiés sont voisins.
**Syntaxe**
```sql theme={null}
h3IndexesAreNeighbors(index1, index2)
```
**Arguments**
* `index1` — Numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
* `index2` — Numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* `1` — Les indices sont voisins. [UInt8](/fr/reference/data-types/int-uint).
* `0` — Les indices ne sont pas voisins. [UInt8](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3IndexesAreNeighbors(617420388351344639, 617420388352655359) AS n;
```
```text title="Response" theme={null}
┌─n─┐
│ 1 │
└───┘
```
## h3ToChildren
Renvoie un tableau des index enfants pour l’index [H3](#h3-index) donné.
**Syntaxe**
```sql theme={null}
h3ToChildren(index, resolution)
```
**Arguments**
* `index` — numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
* `resolution` — Résolution de l'index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
**Valeurs renvoyées**
* Tableau des H3-indexes enfants. [Array](/fr/reference/data-types/array)([UInt64](/fr/reference/data-types/int-uint)).
**Exemple**
```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
Renvoie l’index parent (de résolution inférieure) qui contient l’index [H3](#h3-index) donné.
**Syntaxe**
```sql theme={null}
h3ToParent(index, resolution)
```
**Arguments**
* `index` — numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
* `resolution` — Résolution de l’index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Index H3 du parent. [UInt64](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3ToParent(599405990164561919, 3) AS parent;
```
```text title="Response" theme={null}
┌─────────────parent─┐
│ 590398848891879423 │
└────────────────────┘
```
## h3ToString
Convertit la représentation `H3Index` de l’index en représentation textuelle.
```sql theme={null}
h3ToString(index)
```
**Paramètre**
* `index` — numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Représentation sous forme de chaîne de l’index H3. [String](/fr/reference/data-types/string).
**Exemple**
```sql title="Query" theme={null}
SELECT h3ToString(617420388352917503) AS h3_string;
```
```text title="Response" theme={null}
┌─h3_string───────┐
│ 89184926cdbffff │
└─────────────────┘
```
## stringToH3
Convertit la représentation textuelle en représentation `H3Index` (UInt64).
**Syntaxe**
```sql theme={null}
stringToH3(index_str)
```
**Paramètre**
* `index_str` — Représentation textuelle de l’index H3. [String](/fr/reference/data-types/string).
**Valeur renvoyée**
* numéro d’index hexagonal. Renvoie 0 en cas d’erreur. [UInt64](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT stringToH3('89184926cc3ffff') AS index;
```
```text title="Response" theme={null}
┌──────────────index─┐
│ 617420388351344639 │
└────────────────────┘
```
## h3GetResolution
Renvoie la résolution de l’index [H3](#h3-index).
**Syntaxe**
```sql theme={null}
h3GetResolution(index)
```
**Paramètre**
* `index` — Numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
**Valeur de retour**
* Résolution de l’index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetResolution(617420388352917503) AS res;
```
```text title="Response" theme={null}
┌─res─┐
│ 9 │
└─────┘
```
## h3IsResClassIII
Indique si l’[index H3](#h3-index) a une résolution d’orientation de classe III.
**Syntaxe**
```sql theme={null}
h3IsResClassIII(index)
```
**Paramètre**
* `index` — numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* `1` — L’index correspond à une résolution d’orientation de classe III. [UInt8](/fr/reference/data-types/int-uint).
* `0` — L’index ne correspond pas à une résolution d’orientation de classe III. [UInt8](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3IsResClassIII(617420388352917503) AS res;
```
```text title="Response" theme={null}
┌─res─┐
│ 1 │
└─────┘
```
## h3IsPentagon
Indique si cet index [H3](#h3-index) représente une cellule pentagonale.
**Syntaxe**
```sql theme={null}
h3IsPentagon(index)
```
**Paramètre**
* `index` — Numéro d’index hexagonal. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* `1` — L’index représente une cellule pentagonale. [UInt8](/fr/reference/data-types/int-uint).
* `0` — L’index ne représente pas une cellule pentagonale. [UInt8](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3IsPentagon(644721767722457330) AS pentagon;
```
```text title="Response" theme={null}
┌─pentagon─┐
│ 0 │
└──────────┘
```
## h3GetFaces
Renvoie les faces de l’icosaèdre qu’un index [H3](#h3-index) donné intersecte.
**Syntaxe**
```sql theme={null}
h3GetFaces(index)
```
**Paramètre**
* `index` — Numéro d’index de l’hexagone. [UInt64](/fr/reference/data-types/int-uint).
**valeur renvoyée**
* Array contenant les faces de l’icosaèdre que recoupe l’index H3 donné. [Array](/fr/reference/data-types/array)([UInt64](/fr/reference/data-types/int-uint)).
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetFaces(599686042433355775) AS faces;
```
```text title="Response" theme={null}
┌─faces─┐
│ [7] │
└───────┘
```
## h3CellAreaM2
Renvoie la superficie exacte, en mètres carrés, d’une cellule spécifique pour l’index H3 fourni en entrée.
**Syntaxe**
```sql theme={null}
h3CellAreaM2(index)
```
**Paramètre**
* `index` — Numéro d’index de l’hexagone. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Aire de la cellule en mètres carrés. [Float64](/fr/reference/data-types/float).
**Exemple**
```sql title="Query" theme={null}
SELECT h3CellAreaM2(579205133326352383) AS area;
```
```text title="Response" theme={null}
┌───────────────area─┐
│ 4106166334463.9233 │
└────────────────────┘
```
## h3CellAreaRads2
Renvoie l’aire exacte, en radians carrés, d’une cellule spécifique correspondant à l’index H3 fourni en entrée.
**Syntaxe**
```sql theme={null}
h3CellAreaRads2(index)
```
**Paramètre**
* `index` — Numéro d’index de l’hexagone. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Aire de la cellule en radians carrés. [Float64](/fr/reference/data-types/float).
**Exemple**
```sql title="Query" theme={null}
SELECT h3CellAreaRads2(579205133326352383) AS area;
```
```text title="Response" theme={null}
┌────────────────area─┐
│ 0.10116268528089567 │
└─────────────────────┘
```
## h3ToCenterChild
Renvoie l’index [H3](#h3-index) enfant central (plus fin) contenu dans l’index [H3](#h3-index) donné, à la résolution spécifiée.
**Syntaxe**
```sql theme={null}
h3ToCenterChild(index, resolution)
```
**Paramètre**
* `index` — Numéro d’index de l’hexagone. [UInt64](/fr/reference/data-types/int-uint).
* `resolution` — Résolution de l’index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
**Valeurs renvoyées**
* Index [H3](#h3-index) de la cellule enfant centrale contenue dans l’[H3](#h3-index) donné, à la résolution indiquée. [UInt64](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3ToCenterChild(577023702256844799,1) AS centerToChild;
```
```text title="Response" theme={null}
┌──────centerToChild─┐
│ 581496515558637567 │
└────────────────────┘
```
## h3ExactEdgeLengthM
Renvoie la longueur exacte, en mètres, de l’arête unidirectionnelle représentée par l’index H3 d’entrée.
**Syntaxe**
```sql theme={null}
h3ExactEdgeLengthM(index)
```
**Paramètre**
* `index` — Numéro d’index de l’hexagone. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Longueur exacte de l’arête, en mètres. [Float64](/fr/reference/data-types/float).
**Exemple**
```sql title="Query" theme={null}
SELECT h3ExactEdgeLengthM(1310277011704381439) AS exactEdgeLengthM;;
```
```text title="Response" theme={null}
┌───exactEdgeLengthM─┐
│ 195449.63163407316 │
└────────────────────┘
```
## h3ExactEdgeLengthKm
Renvoie la longueur exacte, en kilomètres, de l’arête unidirectionnelle représentée par l’index H3 fourni en entrée.
**Syntaxe**
```sql theme={null}
h3ExactEdgeLengthKm(index)
```
**Paramètre**
* `index` — Numéro d’index de l’hexagone. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Longueur exacte de l’arête en kilomètres. [Float64](/fr/reference/data-types/float).
**Exemple**
```sql title="Query" theme={null}
SELECT h3ExactEdgeLengthKm(1310277011704381439) AS exactEdgeLengthKm;;
```
```text title="Response" theme={null}
┌──exactEdgeLengthKm─┐
│ 195.44963163407317 │
└────────────────────┘
```
## h3ExactEdgeLengthRads
Renvoie la longueur exacte de l’arête unidirectionnelle représentée par l’index H3 d’entrée, en radians.
**Syntaxe**
```sql theme={null}
h3ExactEdgeLengthRads(index)
```
**Paramètre**
* `index` — Numéro d’index de l’hexagone. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Longueur exacte de l’arête, en radians. [Float64](/fr/reference/data-types/float).
**Exemple**
```sql title="Query" theme={null}
SELECT h3ExactEdgeLengthRads(1310277011704381439) AS exactEdgeLengthRads;;
```
```text title="Response" theme={null}
┌──exactEdgeLengthRads─┐
│ 0.030677980118976447 │
└──────────────────────┘
```
## h3NumHexagons
Renvoie le nombre d’indices H3 uniques pour la résolution donnée.
**Syntaxe**
```sql theme={null}
h3NumHexagons(resolution)
```
**Paramètre**
* `resolution` — Résolution de l’index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Nombre d’indices H3. [Int64](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3NumHexagons(3) AS numHexagons;
```
```text title="Response" theme={null}
┌─numHexagons─┐
│ 41162 │
└─────────────┘
```
## h3PointDistM
Renvoie la distance en mètres selon le « grand cercle » ou la formule « haversine » entre des paires de points GeoCoord (latitude/longitude).
**Syntaxe**
```sql theme={null}
h3PointDistM(lat1, lon1, lat2, lon2)
```
**Arguments**
* `lat1`, `lon1` — Latitude et longitude du point 1 en degrés. [Float64](/fr/reference/data-types/float).
* `lat2`, `lon2` — Latitude et longitude du point 2 en degrés. [Float64](/fr/reference/data-types/float).
**Valeurs renvoyées**
* Distance de Haversine, ou distance orthodromique, en mètres.[Float64](/fr/reference/data-types/float).
**Exemple**
```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
Renvoie la distance « grand cercle » ou « haversine » entre des paires de points GeoCoord (latitude/longitude), exprimée en kilomètres.
**Syntaxe**
```sql theme={null}
h3PointDistKm(lat1, lon1, lat2, lon2)
```
**Arguments**
* `lat1`, `lon1` — Latitude et longitude du point1, en degrés. [Float64](/fr/reference/data-types/float).
* `lat2`, `lon2` — Latitude et longitude du point2, en degrés. [Float64](/fr/reference/data-types/float).
**Valeurs renvoyées**
* Distance de Haversine ou orthodromique, en kilomètres. [Float64](/fr/reference/data-types/float).
**Exemple**
```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
Renvoie la distance « grand cercle » ou « haversine », en radians, entre des paires de points GeoCoord (latitude/longitude).
**Syntaxe**
```sql theme={null}
h3PointDistRads(lat1, lon1, lat2, lon2)
```
**Arguments**
* `lat1`, `lon1` — Latitude et longitude du point 1 en degrés. [Float64](/fr/reference/data-types/float).
* `lat2`, `lon2` — Latitude et longitude du point 2 en degrés. [Float64](/fr/reference/data-types/float).
**Valeurs renvoyées**
* Distance de Haversine ou distance orthodromique, en radians. [Float64](/fr/reference/data-types/float).
**Exemple**
```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
Renvoie un tableau de tous les index H3 de résolution 0.
**Syntaxe**
```sql theme={null}
h3GetRes0Indexes()
```
**Valeurs renvoyées**
* Tableau de tous les index H3 de résolution 0. [Array](/fr/reference/data-types/array)([UInt64](/fr/reference/data-types/int-uint)).
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetRes0Indexes AS indexes ;
```
```text title="Response" theme={null}
┌─indexes─────────────────────────────────────┐
│ [576495936675512319,576531121047601151,....]│
└─────────────────────────────────────────────┘
```
## h3GetPentagonIndexes
Renvoie tous les index H3 en forme de pentagone à la résolution spécifiée.
**Syntaxe**
```sql theme={null}
h3GetPentagonIndexes(resolution)
```
**Paramètre**
* `resolution` — Résolution de l’index. Plage : `[0, 15]`. [UInt8](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Tableau de tous les index H3 pentagonaux. [Array](/fr/reference/data-types/array)([UInt64](/fr/reference/data-types/int-uint)).
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetPentagonIndexes(3) AS indexes;
```
```text title="Response" theme={null}
┌─indexes────────────────────────────────────────────────────────┐
│ [590112357393367039,590464201114255359,590816044835143679,...] │
└────────────────────────────────────────────────────────────────┘
```
## h3Line
Renvoie la ligne d’indices reliant les deux indices fournis.
**Syntaxe**
```sql theme={null}
h3Line(start,end)
```
**Paramètre**
* `start` — Numéro d'index de l’hexagone représentant un point de départ. [UInt64](/fr/reference/data-types/int-uint).
* `end` — Numéro d'index de l’hexagone représentant un point d'arrivée. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
Array d'index H3 représentant la suite d'index entre les deux index fournis. [Array](/fr/reference/data-types/array)([UInt64](/fr/reference/data-types/int-uint)).
**Exemple**
```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
Renvoie la distance, en cellules de grille, entre les deux indices fournis.
**Syntaxe**
```sql theme={null}
h3Distance(start,end)
```
**Paramètre**
* `start` — Numéro d’index de l’hexagone représentant un point de départ. [UInt64](/fr/reference/data-types/int-uint).
* `end` — Numéro d’index de l’hexagone représentant un point d’arrivée. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Nombre de cellules de la grille. [Int64](/fr/reference/data-types/int-uint).
Renvoie un nombre négatif si le calcul de la distance échoue.
**Exemple**
```sql title="Query" theme={null}
SELECT h3Distance(590080540275638271,590103561300344831) AS distance;
```
```text title="Response" theme={null}
┌─distance─┐
│ 7 │
└──────────┘
```
## h3HexRing
Renvoie les indices de l’anneau hexagonal centré sur l’h3Index d’origine fourni, de longueur k.
Renvoie 0 si aucune distorsion pentagonale n’a été détectée.
**Syntaxe**
```sql theme={null}
h3HexRing(index, k)
```
**Paramètre**
* `index` — Numéro d’index de l’hexagone représentant l’origine. [UInt64](/fr/reference/data-types/int-uint).
* `k` — Distance. [UInt64](/fr/reference/data-types/int-uint).
**Valeurs renvoyées**
* Array d’index H3. [Array](/fr/reference/data-types/array)([UInt64](/fr/reference/data-types/int-uint)).
**Exemple**
```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
Renvoie l’index H3 d’une arête unidirectionnelle à partir de l’origine et de la destination fournies, ou 0 en cas d’erreur.
**Syntaxe**
```sql theme={null}
h3GetUnidirectionalEdge(originIndex, destinationIndex)
```
**Paramètres**
* `originIndex` — Numéro d’index de l’hexagone d’origine. [UInt64](/fr/reference/data-types/int-uint).
* `destinationIndex` — Numéro d’index de l’hexagone de destination. [UInt64](/fr/reference/data-types/int-uint).
**valeur renvoyée**
* Numéro d’index d’arête hexagonale unidirectionnelle. [UInt64](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetUnidirectionalEdge(599686042433355775, 599686043507097599) AS edge;
```
```text title="Response" theme={null}
┌────────────────edge─┐
│ 1248204388774707199 │
└─────────────────────┘
```
## h3UnidirectionalEdgeIsValid
Détermine si le H3Index fourni correspond à une arête unidirectionnelle valide. Renvoie 1 s’il s’agit d’une arête unidirectionnelle, et 0 sinon.
**Syntaxe**
```sql theme={null}
h3UnidirectionalEdgeisValid(index)
```
**Paramètre**
* `index` — Numéro d’index de l’hexagone. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* 1 — L’index H3 est une arête unidirectionnelle valide. [UInt8](/fr/reference/data-types/int-uint).
* 0 — L’index H3 n’est pas une arête unidirectionnelle valide. [UInt8](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3UnidirectionalEdgeIsValid(1248204388774707199) AS validOrNot;
```
```text title="Response" theme={null}
┌─validOrNot─┐
│ 1 │
└────────────┘
```
## h3GetOriginIndexFromUnidirectionalEdge
Renvoie l’index de l’hexagone d’origine à partir de l’arête unidirectionnelle H3Index.
**Syntaxe**
```sql theme={null}
h3GetOriginIndexFromUnidirectionalEdge(edge)
```
**Paramètre**
* `edge` — Numéro d’index de l’hexagone représentant une arête unidirectionnelle. [UInt64](/fr/reference/data-types/int-uint).
**valeur renvoyée**
* Numéro d’index de l’hexagone d’origine. [UInt64](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetOriginIndexFromUnidirectionalEdge(1248204388774707197) AS origin;
```
```text title="Response" theme={null}
┌─────────────origin─┐
│ 599686042433355773 │
└────────────────────┘
```
## h3GetDestinationIndexFromUnidirectionalEdge
Renvoie l’index du hexagone de destination à partir de l’arête unidirectionnelle H3Index.
**Syntaxe**
```sql theme={null}
h3GetDestinationIndexFromUnidirectionalEdge(edge)
```
**Paramètre**
* `edge` — Numéro d’index d’hexagone représentant une arête unidirectionnelle. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Numéro d’index de l’hexagone de destination. [UInt64](/fr/reference/data-types/int-uint).
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetDestinationIndexFromUnidirectionalEdge(1248204388774707197) AS destination;
```
```text title="Response" theme={null}
┌────────destination─┐
│ 599686043507097597 │
└────────────────────┘
```
## h3GetIndexesFromUnidirectionalEdge
Renvoie les index H3 des hexagones d’origine et de destination à partir de l’arête unidirectionnelle H3Index donnée.
**Syntaxe**
```sql theme={null}
h3GetIndexesFromUnidirectionalEdge(edge)
```
**Paramètre**
* `edge` — Numéro d’index d’hexagone représentant une arête unidirectionnelle. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
Un tuple composé de deux valeurs `tuple(origin,destination)` :
* `origin` — numéro d’index de l’hexagone d’origine. [UInt64](/fr/reference/data-types/int-uint).
* `destination` — numéro d’index de l’hexagone de destination. [UInt64](/fr/reference/data-types/int-uint).
Renvoyer `(0,0)` si l’entrée fournie n’est pas valide.
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetIndexesFromUnidirectionalEdge(1248204388774707199) AS indexes;
```
```text title="Response" theme={null}
┌─indexes─────────────────────────────────┐
│ (599686042433355775,599686043507097599) │
└─────────────────────────────────────────┘
```
## h3GetUnidirectionalEdgesFromHexagon
Renvoie toutes les arêtes unidirectionnelles de l’H3Index fourni.
**Syntaxe**
```sql theme={null}
h3GetUnidirectionalEdgesFromHexagon(index)
```
**Paramètre**
* `index` — Numéro d'index de l’hexagone représentant une arête unidirectionnelle. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
Array d'index H3 représentant chaque arête unidirectionnelle. [Array](/fr/reference/data-types/array)([UInt64](/fr/reference/data-types/int-uint)).
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetUnidirectionalEdgesFromHexagon(1248204388774707199) AS edges;
```
```text title="Response" theme={null}
┌─edges─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ [1248204388774707199,1320261982812635135,1392319576850563071,1464377170888491007,1536434764926418943,1608492358964346879] │
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
```
## h3GetUnidirectionalEdgeBoundary
Renvoie les coordonnées qui définissent l’arête unidirectionnelle.
**Syntaxe**
```sql theme={null}
h3GetUnidirectionalEdgeBoundary(index)
```
**Paramètre**
* `index` — Numéro d’index de l’hexagone représentant une arête unidirectionnelle. [UInt64](/fr/reference/data-types/int-uint).
**Valeur renvoyée**
* Tableau de couples '(lon, lat)'. [Array](/fr/reference/data-types/array)([Float64](/fr/reference/data-types/float), [Float64](/fr/reference/data-types/float)).
**Exemple**
```sql title="Query" theme={null}
SELECT h3GetUnidirectionalEdgeBoundary(1248204388774707199) AS boundary;
```
```text title="Response" theme={null}
┌─boundary────────────────────────────────────────────────────────────────────────┐
│ [(37.42012867767779,-122.03773496427027),(37.33755608435299,-122.090428929044)] │
└─────────────────────────────────────────────────────────────────────────────────┘
```