placekey

CORE

​Placekey is a free and open universal standard identifier for any physical place, so that the data pertaining to those places can be shared across organizations easily. Since Placekey is based on H3, here we offer a way to transform to and from that index and delegate any extra functionality to H3 itself.
You can learn more about Placekey on their website or in the Spatial Indexes section of this documentation.
PLACEKEY_ASH3
PLACEKEY_ASH3(placekey)
Description
Returns the H3 index equivalent to the given placekey.
placekey: VARCHAR Placekey identifier.
Return type
VARCHAR
Example
1
SELECT carto.PLACEKEY_ASH3('@7dd-dc3-52k');
2
-- 8a390cbffffffff
PLACEKEY_FROMH3
PLACEKEY_FROMH3(h3index)
Description
Returns the Placekey equivalent to the given H3 index.
h3index: VARCHAR H3 identifier.
Return type
VARCHAR
Example
1
SELECT carto.PLACEKEY_FROMH3('84390cbffffffff');
2
-- @7dd-dc3-52k
PLACEKEY_ISVALID
PLACEKEY_ISVALID(placekey)
Description
Returns a boolean value true when the given string represents a valid Placekey, false otherwise.
placekey: VARCHAR Placekey identifier.
Return type
BOOLEAN
Examples
1
SELECT carto.PLACEKEY_ISVALID('@7dd-dc3-52k');
2
-- true
1
SELECT carto.PLACEKEY_ISVALID('7dd-dc3-52k');
2
-- true
1
SELECT carto.PLACEKEY_ISVALID('x');
2
-- false

lds

processing

Last modified 4mo ago