h3_kringdistances函數

適用於:檢查標記是的磚的SQL檢查標記是的磚運行時11.2及以上

返回所有H3細胞內(表示為長整數或字符串)網格的距離k從原點H3細胞,連同他們的距離原點H3細胞。

語法

h3_kringdistances(h3CellIdExpr,kExpr)

參數

  • h3CellIdExpr:一個長整型數字表達式,或十六進製字符串表達式代表一個H3細胞ID。

  • kExpr:一個整數表達式代表網格距離。kExpr必須是非負數。

返回

數組與兩個字段命名結構,命名cellid和距離分別在第一個字段的結構是一個H3細胞ID(表示為一個長整數或字符串)和第二個字段的結構是其距離原點H3細胞(表示為一個整數)。H3細胞的類型id的輸出是一樣的類型h3CellIdExpr。

返回數組中的元素排序對他們距離原點H3細胞。相對應的元素返回數組中相同的距離可能會以任何順序返回。函數返回NULL如果任何一個輸入的表達式是NULL。函數部分驗證關於輸入參數是否有效的H3細胞ID,必要但不充分條件之間的有效的H3 ID,它的價值是0 x08001fffffffffff和0 x08ff3b6db6db6db6。函數定義的行為如果輸入細胞ID不是一個有效的細胞ID。如果網格距離的值是零,返回的數組包含一個值等於輸入H3細胞ID。

錯誤條件

  • 如果h3CellIdExpr是一個字符串,不能轉換為長整型數字或對應於一個長整型數字值小於0 x08001fffffffffff或比0 x08ff3b6db6db6db6,該函數返回H3_INVALID_CELL_ID

  • 如果kExpr是負的,函數返回H3_INVALID_GRID_DISTANCE_VALUE

例子

——簡單的例子,第一個參數是一個長整型數字。>選擇h3_kringdistances (599686042433355775 1) [{“cellid”: 599686042433355775,“距離”:0},{“cellid”: 599686030622195711,“距離”:1},{“cellid”: 599686044580839423,“距離”:1},{“cellid”: 599686038138388479,“距離”:1},{“cellid”: 599686043507097599,“距離”:1},{“cellid”: 599686015589810175,“距離”:1},{“cellid”: 599686014516068351,“距離”:1}]——簡單的例子,第一個參數是一個字符串。>選擇h3_kringdistances (' 85283473 fffffff ', 1) [{“cellid”:“85283473 fffffff”,“距離”:0},{“cellid”:“85283447 fffffff”,“距離”:1},{“cellid”:“8528347 bfffffff”,“距離”:1},{“cellid”:“85283463 fffffff”,“距離”:1},{“cellid”:“85283477 fffffff”,“距離”:1},{“cellid”:“8528340 ffffffff”,“距離”:1},{“cellid”:“8528340 bfffffff”,“距離”:1}]——首先輸入一個無效的H3細胞ID。>選擇h3_kringdistances (0,0) [H3_INVALID_CELL_ID] 0不是有效的H3細胞ID——第二次輸入是一個無效的網格距離值。>選擇h3_kringdistances (' 85283473 fffffff ', 1) [H3_INVALID_GRID_DISTANCE_VALUE] H3網格距離1必須是非負數