h3_ispentagon

Returns True if the input H3 cell ID represents a pentagon. Supports Spark Connect.

For the corresponding Databricks SQL function, see h3_ispentagon function.

Syntax

Python

from pyspark.databricks.sql import functions as dbf

dbf.h3_ispentagon(col=<col>)

Parameters

Parameter	Type	Description
col	pyspark.sql.Column or str	An H3 cell ID, represented as int or str

Examples

Python

from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([(590112357393367039,)], ['h3l'])
df.select(dbf.h3_ispentagon('h3l').alias('result')).collect()

Output

[Row(result=True)]