FunctionsGeospatial
Geospatial
60 Geospatial functions in the NYXDB native function registry, with signatures, briefs, and measured medians where available.
60 functions in the geospatial family. Each name links to its page; … marks the variadic argument list (the engine declares no named parameters). A Measured value appears only where a benchmark corpus case joins by name (server-class hardware, median).
| Function | Type | Description | Measured |
|---|---|---|---|
geo_distance(…) → Float64 | scalar | Distance between two geographic points. | — |
geohash_decode(…) → String | scalar | Decode a geohash to coordinates. | — |
geohash_encode(…) → String | scalar | Encode coordinates as a geohash. | — |
geohashes_in_box(…) → String | scalar | Geohashes covering a bounding box. | — |
great_circle_angle(…) → Float64 | scalar | Great-circle angle. | — |
great_circle_distance(…) → Float64 | scalar | Great-circle distance. | — |
h3_cell_area_m2(…) → Float64 | scalar | H3 cell area (m2). | — |
h3_cell_area_rads2(…) → Float64 | scalar | H3 cell area (rads2). | — |
h3_distance(…) → Int64 | scalar | H3 grid distance. | — |
h3_edge_angle(…) → Float64 | scalar | H3 edge angle. | — |
h3_edge_length_km(…) → Float64 | scalar | H3 edge length (km). | — |
h3_edge_length_m(…) → Float64 | scalar | H3 edge length (m). | — |
h3_exact_edge_length_km(…) → Float64 | scalar | H3 edge length (km) (exact). | — |
h3_exact_edge_length_m(…) → Float64 | scalar | H3 edge length (m) (exact). | — |
h3_exact_edge_length_rads(…) → Float64 | scalar | H3 edge length (rads) (exact). | — |
h3_get_base_cell(…) → Int64 | scalar | Base cell number. | — |
h3_get_destination_index_from_unidirectional_edge(…) → UInt64 | scalar | H3 unidirectional edge operation. | — |
h3_get_faces(…) → String | scalar | Icosahedron faces for a cell. | — |
h3_get_indexes_from_unidirectional_edge(…) → String | scalar | H3 unidirectional edge operation. | — |
h3_get_origin_index_from_unidirectional_edge(…) → UInt64 | scalar | H3 unidirectional edge operation. | — |
h3_get_pentagon_indexes(…) → String | scalar | All pentagon cells at a resolution. | — |
h3_get_res0_indexes(…) → String | scalar | All resolution-0 cells. | — |
h3_get_resolution(…) → Int64 | scalar | H3 resolution. | — |
h3_get_unidirectional_edge(…) → UInt64 | scalar | H3 unidirectional edge operation. | — |
h3_get_unidirectional_edge_boundary(…) → String | scalar | H3 unidirectional edge operation. | — |
h3_get_unidirectional_edges_from_hexagon(…) → String | scalar | H3 unidirectional edge operation. | — |
h3_hex_area_km2(…) → Float64 | scalar | Average H3 hexagon area (km²). | — |
h3_hex_area_m2(…) → Float64 | scalar | Average H3 hexagon area (m²). | — |
h3_hex_ring(…) → String | scalar | H3 ring around a cell. | — |
h3_indexes_are_neighbors(…) → Bool | scalar | Test whether two cells are neighbors. | — |
h3_is_pentagon(…) → Bool | scalar | Test whether a cell is a pentagon. | — |
h3_is_res_class_iii(…) → Bool | scalar | Test whether a cell is Class III. | — |
h3_is_valid(…) → Bool | scalar | Validate H3 index/edge. | — |
h3_line(…) → String | scalar | H3 grid path. | — |
h3_num_hexagons(…) → UInt64 | scalar | Number of cells at a resolution. | — |
h3_point_dist_km(…) → Float64 | scalar | Distance between two points (km). | — |
h3_point_dist_m(…) → Float64 | scalar | Distance between two points (m). | — |
h3_point_dist_rads(…) → Float64 | scalar | Distance between two points (rads). | — |
h3_polygon_to_cells(…) → String | scalar | Cover a polygon with H3 cells. | — |
h3_to_center_child(…) → UInt64 | scalar | H3 center child. | — |
h3_to_children(…) → String | scalar | H3 child cells. | — |
h3_to_geo(…) → String | scalar | H3 cell center coordinates. | — |
h3_to_geo_boundary(…) → String | scalar | H3 cell boundary. | — |
h3_to_parent(…) → UInt64 | scalar | H3 parent cell. | — |
h3_to_string(…) → String | scalar | Render H3 index as a string. | — |
h3_unidirectional_edge_is_valid(…) → Bool | scalar | Validate H3 index/edge. | — |
s2_cap_contains(…) → Bool | scalar | S2 spherical cap contains. | — |
s2_cap_union(…) → String | scalar | S2 spherical cap union. | — |
s2_cells_intersect(…) → Bool | scalar | Test S2 cell intersection. | — |
s2_get_neighbors(…) → String | scalar | S2 cell neighbors. | — |
s2_rect_add(…) → String | scalar | S2 rectangle add. | — |
s2_rect_contains(…) → Bool | scalar | S2 rectangle contains. | — |
s2_rect_intersection(…) → String | scalar | S2 rectangle intersection. | — |
s2_rect_union(…) → String | scalar | S2 rectangle union. | — |
s2_to_geo(…) → String | scalar | S2 cell center coordinates. | — |
st_line_from_wkb(…) → String | scalar | Parse line from WKB. | — |
st_m_line_from_wkb(…) → String | scalar | Parse m line from WKB. | — |
st_m_poly_from_wkb(…) → String | scalar | Parse m poly from WKB. | — |
st_point_from_wkb(…) → String | scalar | Parse point from WKB. | — |
st_poly_from_wkb(…) → String | scalar | Parse poly from WKB. | — |
financial_net_present_value_extended
Computes net present value (NPV) like financial_net_present_value, with support for explicit period inputs. V1 supports period arrays `[cashflows], [periods]` and scalar `(cashflow, period)` argume…
geo_distance
Computes the great-circle distance between two points on Earth using latitude/longitude coordinates. An optional unit argument supports `m` (default), `km`, `mi`, `ft`, and `nm`.