Skip to content

Commit

Permalink
update h3_polyfill_table docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vdelacruzb committed Dec 18, 2024
1 parent e604e83 commit d1f77a8
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions clouds/snowflake/modules/doc/h3/H3_POLYFILL_TABLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,14 @@ H3_POLYFILL_TABLE(input_query, resolution, mode, output_table)

**Description**

Returns a table with the H3 cell indexes contained in the given geography at a requested resolution. Containment is determined by the mode: center, intersects, contains. All the attributes except the geography will be included in the output table, clustered by the h3 column.
Returns a table with the H3 cell indexes contained in the given polygon at a requested resolution. Containment is determined by the mode: center, intersects, contains. All the attributes except the polygon will be included in the output table, clustered by the h3 column.

* `input_query`: `STRING` input data to polyfill. It must contain a column `geom` with the shape to cover. Additionally, other columns can be included.
* `resolution`: `INT` level of detail. The value must be between 0 and 15 ([H3 resolution table](https://h3geo.org/docs/core-library/restable)).
* `mode`: `STRING`
* `center` returns the indexes of the H3 cells which centers intersect the input geography (polygon). The resulting H3 set does not fully cover the input geography, however, this is **significantly faster** that the other modes. This mode is not compatible with points or lines. Equivalent to [`H3_POLYFILL`](h3#h3_polyfill).
* `intersects` returns the indexes of the H3 cells that intersect the input geography. The resulting H3 set will completely cover the input geography (point, line, polygon).
* `contains` returns the indexes of the H3 cells that are entirely contained inside the input geography (polygon). This mode is not compatible with points or lines.
* `output_table`: `STRING` name of the output table to store the results of the polyfill.
* `resolution`: `INT` number between 0 and 15 with the [H3 resolution](https://h3geo.org/docs/core-library/restable).
* `mode`: `STRING` `<center|contains|intersects>`. Optional. Defaults to 'center' mode.
* `center` The center point of the H3 cell must be within the polygon
* `contains` The H3 cell must be fully contained within the polygon (least inclusive)
* `intersects` The H3 cell intersects in any way with the polygon (most inclusive)

Mode `center`:

Expand Down

0 comments on commit d1f77a8

Please sign in to comment.