Packages

object functions extends DeprecatedFunctionLogging with stFunctions with h3Functions

Commonly used functions available for DataFrame operations. Using functions defined here provides a little bit more compile-time safety to make sure the function exists.

Annotations
@Py4JWhitelist() @Stable()
Linear Supertypes
h3Functions, stFunctions, DeprecatedFunctionLogging, UsageLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. functions
  2. h3Functions
  3. stFunctions
  4. DeprecatedFunctionLogging
  5. UsageLogging
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def h3_boundaryasgeojson(e: Column): Column

    Returns the boundary of an H3 cell in GeoJSON format.

    Returns the boundary of an H3 cell in GeoJSON format.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  10. def h3_boundaryaswkb(e: Column): Column

    Returns the boundary of an H3 cell in WKB format.

    Returns the boundary of an H3 cell in WKB format.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  11. def h3_boundaryaswkt(e: Column): Column

    Returns the boundary of an H3 cell in WKT format.

    Returns the boundary of an H3 cell in WKT format.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  12. def h3_centerasgeojson(e: Column): Column

    Returns the center of an H3 cell in GeoJSON format.

    Returns the center of an H3 cell in GeoJSON format.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  13. def h3_centeraswkb(e: Column): Column

    Returns the center of an H3 cell in WKB format.

    Returns the center of an H3 cell in WKB format.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  14. def h3_centeraswkt(e: Column): Column

    Returns the center of an H3 cell in WKT format.

    Returns the center of an H3 cell in WKT format.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  15. def h3_compact(e: Column): Column

    Compacts the input set of H3 cell IDs as best as possible.

    Compacts the input set of H3 cell IDs as best as possible.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  16. def h3_coverash3(e1: Column, e2: Column): Column

    Returns an array of cell IDs represented as long integers, corresponding to hexagons or pentagons of the specified resolution that minimally cover the input linear or areal geography.

    Returns an array of cell IDs represented as long integers, corresponding to hexagons or pentagons of the specified resolution that minimally cover the input linear or areal geography. The expression emits an error if the input geography type is not supported, or if an error is found when parsing the input representation of the geography. The acceptable input representations are WKT, GeoJSON, and WKB. In the first two cases the input is expected to be of type STRING, whereas in the last case the input is expected to be of type BINARY.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.4.0

  17. def h3_coverash3string(e1: Column, e2: Column): Column

    Returns an array of cell IDs represented as strings, corresponding to hexagons or pentagons of the specified resolution that minimally cover the input linear or areal geography.

    Returns an array of cell IDs represented as strings, corresponding to hexagons or pentagons of the specified resolution that minimally cover the input linear or areal geography. The expression emits an error if the input geography type is not supported, or if an error is found when parsing the input representation of the geography. The acceptable input representations are WKT, GeoJSON, and WKB. In the first two cases the input is expected to be of type STRING, whereas in the last case the input is expected to be of type BINARY.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.4.0

  18. def h3_distance(e1: Column, e2: Column): Column

    Returns the grid distance between two H3 cell IDs.

    Returns the grid distance between two H3 cell IDs.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  19. def h3_h3tostring(e: Column): Column

    Converts an H3 cell ID to a string representing the cell ID as a hexadecimal string.

    Converts an H3 cell ID to a string representing the cell ID as a hexadecimal string.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  20. def h3_hexring(e1: Column, e2: Column): Column

    Returns an array of H3 cell IDs that form a hollow hexagonal ring centered at the origin H3 cell and that are at grid distance k from the origin H3 cell.

    Returns an array of H3 cell IDs that form a hollow hexagonal ring centered at the origin H3 cell and that are at grid distance k from the origin H3 cell.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  21. def h3_ischildof(e1: Column, e2: Column): Column

    Returns true if the first H3 cell ID is a child of the second H3 cell ID.

    Returns true if the first H3 cell ID is a child of the second H3 cell ID.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  22. def h3_ispentagon(e: Column): Column

    Returns true if the input H3 cell ID represents a pentagon.

    Returns true if the input H3 cell ID represents a pentagon.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  23. def h3_isvalid(e: Column): Column

    Returns true if the input represents a valid H3 cell ID.

    Returns true if the input represents a valid H3 cell ID.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  24. def h3_kring(e1: Column, e2: Column): Column

    Returns the H3 cell IDs that are within (grid) distance k of the origin cell ID.

    Returns the H3 cell IDs that are within (grid) distance k of the origin cell ID.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  25. def h3_kringdistances(e1: Column, e2: Column): Column

    Returns all H3 cell IDs (represented as long integers or strings) within grid distance k from the origin H3 cell ID, along with their distance from the origin H3 cell ID.

    Returns all H3 cell IDs (represented as long integers or strings) within grid distance k from the origin H3 cell ID, along with their distance from the origin H3 cell ID. More precisely, the result is an array of structs, where each struct contains an H3 cell id (represented as a long integer or string) and its distance from the origin H3 cell ID. The type for the H3 cell IDs in the output is the same as the type of the input H3 cell ID (first argument of the expression).

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  26. def h3_longlatash3(e1: Column, e2: Column, e3: Column): Column

    Returns the H3 cell ID (as a BIGINT) corresponding to the provided longitude and latitude at the specified resolution.

    Returns the H3 cell ID (as a BIGINT) corresponding to the provided longitude and latitude at the specified resolution.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  27. def h3_longlatash3string(e1: Column, e2: Column, e3: Column): Column

    Returns the H3 cell ID (as a STRING) corresponding to the provided longitude and latitude at the specified resolution.

    Returns the H3 cell ID (as a STRING) corresponding to the provided longitude and latitude at the specified resolution.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  28. def h3_maxchild(e1: Column, e2: Column): Column

    Returns the child of maximum value of the input H3 cell at the specified resolution.

    Returns the child of maximum value of the input H3 cell at the specified resolution.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  29. def h3_minchild(e1: Column, e2: Column): Column

    Returns the child of minimum value of the input H3 cell at the specified resolution.

    Returns the child of minimum value of the input H3 cell at the specified resolution.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  30. def h3_pointash3(e1: Column, e2: Column): Column

    Returns the H3 cell ID (as a BIGINT) corresponding to the provided point at the specified resolution.

    Returns the H3 cell ID (as a BIGINT) corresponding to the provided point at the specified resolution. The expression emits an error if the geography is not a point or if an error is found when parsing the input representation of the geography. The acceptable input representations are WKT, GeoJSON, and WKB. In the first two cases the input is expected to be of type STRING, whereas in the last case the input is expected to be of type BINARY.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  31. def h3_pointash3string(e1: Column, e2: Column): Column

    Returns the H3 cell ID (as a STRING) corresponding to the provided point at the specified resolution.

    Returns the H3 cell ID (as a STRING) corresponding to the provided point at the specified resolution. The expression emits an error if the geography is not a point or if an error is found when parsing the input representation of the geography. The acceptable input representations are WKT, GeoJSON, and WKB. In the first two cases the input is expected to be of type STRING, whereas in the last case the input is expected to be of type BINARY.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  32. def h3_polyfillash3(e1: Column, e2: Column): Column

    Returns an array of cell IDs represented as long integers, corresponding to hexagons or pentagons of the specified resolution that are contained by the input areal geography.

    Returns an array of cell IDs represented as long integers, corresponding to hexagons or pentagons of the specified resolution that are contained by the input areal geography. Containment is determined by the cell centroids: a cell is considered to cover the geography if the cell's centroid lies inside the areal geography. The expression emits an error if the geography is not areal (polygon or multipolygon) or if an error is found when parsing the input representation of the geography. The acceptable input representations are WKT, GeoJSON, and WKB. In the first two cases the input is expected to be of type STRING, whereas in the last case the input is expected to be of type BINARY.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  33. def h3_polyfillash3string(e1: Column, e2: Column): Column

    Returns an array of cell IDs represented as strings, corresponding to hexagons or pentagons of the specified resolution that are contained by the input areal geography.

    Returns an array of cell IDs represented as strings, corresponding to hexagons or pentagons of the specified resolution that are contained by the input areal geography. Containment is determined by the cell centroids: a cell is considered to cover the geography if the cell's centroid lies inside the areal geography. The expression emits an error if the geography is not areal (polygon or multipolygon) or if an error is found when parsing the input representation of the geography. The acceptable input representations are WKT, GeoJSON, and WKB. In the first two cases the input is expected to be of type STRING, whereas in the last case the input is expected to be of type BINARY.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  34. def h3_resolution(e: Column): Column

    Returns the resolution of the H3 cell ID.

    Returns the resolution of the H3 cell ID.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  35. def h3_stringtoh3(e: Column): Column

    Converts a string representing an H3 cell ID to the corresponding big integer.

    Converts a string representing an H3 cell ID to the corresponding big integer.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  36. def h3_tessellateaswkb(geo: Column, res: Int): Column
    Definition Classes
    h3Functions
  37. def h3_tessellateaswkb(geo: Column, res: Column): Column

    Returns an array of structs representing the chips covering geography at the specified resolution.

    Returns an array of structs representing the chips covering geography at the specified resolution. More precisely, the elements of the returned array are named structs with three fields names "cellid", "core", and "chip": - The "cellid" field contains one of the H3 cells covering the input geography. - The "core" field determines if the boundary polygon of the H3 cell in the "cellid" field is contained inside the input geography (this can happen only for areal input geographies). If the cell is contained in the input geography the value is set to true, and false otherwise. - The "chip" field is the (Cartesian) intersection of the H3 cell polygon, corresponding to the H3 cell id in the "cellid" field, with the input geography, represented in WKB format. The set of the H3 cells ids returned as the "cellid" elements of the structs in the array is a minimal covering set for the input geography.

    Definition Classes
    h3Functions
    Since

    3.5.0

  38. def h3_tochildren(e1: Column, e2: Column): Column

    Returns the children H3 cell IDs of the input H3 cell ID at the specified resolution.

    Returns the children H3 cell IDs of the input H3 cell ID at the specified resolution.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  39. def h3_toparent(e1: Column, e2: Column): Column

    Returns the parent H3 cell ID of the input H3 cell ID at the specified resolution.

    Returns the parent H3 cell ID of the input H3 cell ID at the specified resolution.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  40. def h3_try_coverash3(e1: Column, e2: Column): Column

    Returns an array of cell IDs represented as long integers, corresponding to hexagons or pentagons of the specified resolution that minimally cover the input linear or areal geography.

    Returns an array of cell IDs represented as long integers, corresponding to hexagons or pentagons of the specified resolution that minimally cover the input linear or areal geography. The expressions value is NULL if the input geography type is not supported or if an error is found when parsing the input representation of the geography. The expression returns an error if the input resolution is invalid. The acceptable input representations are WKT, GeoJSON, and WKB. In the first two cases the input is expected to be of type STRING, whereas in the last case the input is expected to be of type BINARY.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.5.0

  41. def h3_try_coverash3string(e1: Column, e2: Column): Column

    Returns an array of cell IDs represented as strings, corresponding to hexagons or pentagons of the specified resolution that minimally cover the input linear or areal geography.

    Returns an array of cell IDs represented as strings, corresponding to hexagons or pentagons of the specified resolution that minimally cover the input linear or areal geography. The expression value is NULL if the input geography type is not supported or if an error is found when parsing the input representation of the geography. The expression returns an error if the input resolution is invalid. The acceptable input representations are WKT, GeoJSON, and WKB. In the first two cases the input is expected to be of type STRING, whereas in the last case the input is expected to be of type BINARY.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.5.0

  42. def h3_try_distance(e1: Column, e2: Column): Column

    Returns the grid distance between two H3 cell IDs of the same resolution, or NULL if the distance is undefined.

    Returns the grid distance between two H3 cell IDs of the same resolution, or NULL if the distance is undefined.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.5.0

  43. def h3_try_polyfillash3(e1: Column, e2: Column): Column

    Returns an array of cell IDs represented as long integers, corresponding to hexagons or pentagons of the specified resolution that are contained by the input areal geography.

    Returns an array of cell IDs represented as long integers, corresponding to hexagons or pentagons of the specified resolution that are contained by the input areal geography. Containment is determined by the cell centroids: a cell is considered to cover the geography if the cell's centroid lies inside the areal geography. The expression's value is NULL if the geography is not areal (polygon or multipolygon) or if an error is found when parsing the input representation of the geography. The acceptable input representations are WKT, GeoJSON, and WKB. In the first two cases the input is expected to be of type STRING, whereas in the last case the input is expected to be of type BINARY.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  44. def h3_try_polyfillash3string(e1: Column, e2: Column): Column

    Returns an array of cell IDs represented as strings, corresponding to hexagons or pentagons of the specified resolution that are contained by the input areal geography.

    Returns an array of cell IDs represented as strings, corresponding to hexagons or pentagons of the specified resolution that are contained by the input areal geography. Containment is determined by the cell centroids: a cell is considered to cover the geography if the cell's centroid lies inside the areal geography. The expression's value is NULL if the geography is not areal (polygon or multipolygon) or if an error is found when parsing the input representation of the geography. The acceptable input representations are WKT, GeoJSON, and WKB. In the first two cases the input is expected to be of type STRING, whereas in the last case the input is expected to be of type BINARY.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  45. def h3_try_tessellateaswkb(geo: Column, res: Int): Column
    Definition Classes
    h3Functions
  46. def h3_try_tessellateaswkb(geo: Column, res: Column): Column

    Returns an array of structs representing the chips covering geography at the specified resolution, or null if the geometry is invalid.

    Returns an array of structs representing the chips covering geography at the specified resolution, or null if the geometry is invalid. More precisely, the elements of the returned array are named structs with three fields names "cellid", "core", and "chip": - The "cellid" field contains one of the H3 cells covering the input geography. - The "core" field determines if the boundary polygon of the H3 cell in the "cellid" field is contained inside the input geography (this can happen only for areal input geographies). If the cell is contained in the input geography the value is set to true, and false otherwise. - The "chip" field is the (Cartesian) intersection of the H3 cell polygon, corresponding to the H3 cell id in the "cellid" field, with the input geography, represented in WKB format. The set of the H3 cells ids returned as the "cellid" elements of the structs in the array is a minimal covering set for the input geography.

    Definition Classes
    h3Functions
    Since

    3.5.0

  47. def h3_try_validate(e: Column): Column

    Returns the input value if it is a valid H3 cell or NULL otherwise.

    Returns the input value if it is a valid H3 cell or NULL otherwise.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  48. def h3_uncompact(e1: Column, e2: Column): Column

    Uncompacts the input set of H3 cell IDs to the specified resolution.

    Uncompacts the input set of H3 cell IDs to the specified resolution.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  49. def h3_validate(e: Column): Column

    Returns the input value if it is a valid H3 cell or emits an error otherwise.

    Returns the input value if it is a valid H3 cell or emits an error otherwise.

    Definition Classes
    h3Functions
    Annotations
    @Py4JWhitelist()
    Since

    3.3.0

  50. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  51. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  52. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  53. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  55. def recordDeprecated(functionDefinition: String, classReference: String): Unit
    Definition Classes
    DeprecatedFunctionLogging
  56. def recordEvent(metric: MetricDefinition, additionalTags: Map[TagDefinition, String], blob: String, trimBlob: Boolean): Unit
    Definition Classes
    UsageLogging
  57. def recordLineage(metric: MetricDefinition, additionalTags: Map[TagDefinition, String], blob: String, silent: Boolean): Unit
    Definition Classes
    UsageLogging
  58. def recordOperation[S](opType: OpType, extraTags: Map[TagDefinition, String], serializer: (AnyRef) => String)(thunk: => S): S
    Definition Classes
    UsageLogging
  59. def recordOperation[S](opType: OpType, opTarget: String, extraTags: Map[TagDefinition, String], isSynchronous: Boolean, alwaysRecordStats: Boolean, allowAuthTags: Boolean, killJvmIfStuck: Boolean, outputMetric: MetricDefinition, silent: Boolean)(thunk: => S): S
    Definition Classes
    UsageLogging
  60. def recordOperationWithResultTags[S](opType: OpType, opTarget: String, extraTags: Map[TagDefinition, String], isSynchronous: Boolean, alwaysRecordStats: Boolean, allowAuthTags: Boolean, killJvmIfStuck: Boolean, outputMetric: MetricDefinition)(thunk: => (S, Map[TagDefinition, String])): S
    Definition Classes
    UsageLogging
  61. def recordProductEvent(metric: MetricDefinition with CentralizableMetric, additionalTags: Map[TagDefinition, String], blob: String, trimBlob: Boolean): Unit
    Definition Classes
    UsageLogging
  62. def recordProductUsage(metric: MetricDefinition with CentralizableMetric, quantity: Double, additionalTags: Map[TagDefinition, String], blob: String, forceSample: Boolean, trimBlob: Boolean, silent: Boolean): Unit
    Definition Classes
    UsageLogging
  63. def recordUsage(metric: MetricDefinition, quantity: Double, additionalTags: Map[TagDefinition, String], blob: String, forceSample: Boolean, trimBlob: Boolean, silent: Boolean): Unit
    Definition Classes
    UsageLogging
  64. def st_addpoint(geo1: Column, geo2: Column): Column
    Definition Classes
    stFunctions
  65. def st_addpoint(geo1: Column, geo2: Column, n: Int): Column
    Definition Classes
    stFunctions
  66. def st_addpoint(geo1: Column, geo2: Column, n: Column): Column

    Adds a new point to the n-th position in the input linestring GEOGRAPHY or GEOMETRY.

    Adds a new point to the n-th position in the input linestring GEOGRAPHY or GEOMETRY.

    Definition Classes
    stFunctions
    Since

    3.5.0

  67. def st_area(geo: Column): Column

    Returns the area of the input BINARY, GEOGRAPHY, GEOMETRY, or STRING value.

    Returns the area of the input BINARY, GEOGRAPHY, GEOMETRY, or STRING value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  68. def st_asbinary(geo: Column, endianness: String): Column
    Definition Classes
    stFunctions
  69. def st_asbinary(geo: Column, endianness: Column): Column

    Returns the input GEOGRAPHY or GEOMETRY value in WKB format using the specified endianness.

    Returns the input GEOGRAPHY or GEOMETRY value in WKB format using the specified endianness.

    Definition Classes
    stFunctions
    Since

    3.5.0

  70. def st_asbinary(geo: Column): Column

    Returns the input GEOGRAPHY or GEOMETRY value in little endian WKB format.

    Returns the input GEOGRAPHY or GEOMETRY value in little endian WKB format.

    Definition Classes
    stFunctions
    Since

    3.5.0

  71. def st_asewkb(geo: Column, endianness: String): Column
    Definition Classes
    stFunctions
  72. def st_asewkb(geo: Column, endianness: Column): Column

    Returns the input GEOMETRY value in EWKB format using the specified endianness.

    Returns the input GEOMETRY value in EWKB format using the specified endianness.

    Definition Classes
    stFunctions
    Since

    3.5.0

  73. def st_asewkb(geo: Column): Column

    Returns the input GEOMETRY value in little endian EWKB format.

    Returns the input GEOMETRY value in little endian EWKB format.

    Definition Classes
    stFunctions
    Since

    3.5.0

  74. def st_asewkt(geo: Column): Column

    Returns the input GEOGRAPHY or GEOMETRY value in EWKT format using a precision equal to 15.

    Returns the input GEOGRAPHY or GEOMETRY value in EWKT format using a precision equal to 15.

    Definition Classes
    stFunctions
    Since

    3.5.0

  75. def st_asgeojson(geo: Column): Column

    Returns the input GEOGRAPHY or GEOMETRY value in GeoJSON format using a precision equal to 15.

    Returns the input GEOGRAPHY or GEOMETRY value in GeoJSON format using a precision equal to 15.

    Definition Classes
    stFunctions
    Since

    3.5.0

  76. def st_astext(geo: Column): Column

    Returns the input GEOGRAPHY or GEOMETRY value in WKT format using a precision equal to 15.

    Returns the input GEOGRAPHY or GEOMETRY value in WKT format using a precision equal to 15.

    Definition Classes
    stFunctions
    Since

    3.5.0

  77. def st_aswkb(geo: Column, endianness: String): Column
    Definition Classes
    stFunctions
  78. def st_aswkb(geo: Column, endianness: Column): Column

    Returns the input GEOGRAPHY or GEOMETRY value in WKB format using the specified endianness.

    Returns the input GEOGRAPHY or GEOMETRY value in WKB format using the specified endianness.

    Definition Classes
    stFunctions
    Since

    3.5.0

  79. def st_aswkb(geo: Column): Column

    Returns the input GEOGRAPHY or GEOMETRY value in little endian WKB format.

    Returns the input GEOGRAPHY or GEOMETRY value in little endian WKB format.

    Definition Classes
    stFunctions
    Since

    3.5.0

  80. def st_aswkt(geo: Column): Column

    Returns the input GEOGRAPHY or GEOMETRY value in WKT format using a precision equal to 15.

    Returns the input GEOGRAPHY or GEOMETRY value in WKT format using a precision equal to 15.

    Definition Classes
    stFunctions
    Since

    3.5.0

  81. def st_azimuth(geo1: Column, geo2: Column): Column

    Returns the north-based azimuth from the first point to the second in radians in [0, 2 pi).

    Returns the north-based azimuth from the first point to the second in radians in [0, 2 pi).

    Definition Classes
    stFunctions
    Since

    4.1.0

  82. def st_boundary(geo: Column): Column

    Returns the boundary of the input geometry as a geometry.

    Returns the boundary of the input geometry as a geometry.

    Definition Classes
    stFunctions
    Since

    4.1.0

  83. def st_buffer(geo: Column, radius: Column): Column

    Returns the buffer of the input geometry using the specified radius.

    Returns the buffer of the input geometry using the specified radius.

    Definition Classes
    stFunctions
    Since

    3.5.0

  84. def st_centroid(geo: Column): Column

    Returns the centroid of the input geometry as a 2D point geometry.

    Returns the centroid of the input geometry as a 2D point geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  85. def st_closestpoint(geo1: Column, geo2: Column): Column

    Returns the 2D projection of a point in the first GEOMETRY value that is closest to the second GEOMETRY value with respect to the Euclidean distance.

    Returns the 2D projection of a point in the first GEOMETRY value that is closest to the second GEOMETRY value with respect to the Euclidean distance.

    Definition Classes
    stFunctions
    Since

    4.1.0

  86. def st_concavehull(geo: Column, lengthRatio: Double, allowHoles: Boolean): Column
    Definition Classes
    stFunctions
  87. def st_concavehull(geo: Column, lengthRatio: Column, allowHoles: Boolean): Column
    Definition Classes
    stFunctions
  88. def st_concavehull(geo: Column, lengthRatio: Column, allowHoles: Column): Column

    Returns the concave hull of the input geometry, using the provided length ratio, as a geometry.

    Returns the concave hull of the input geometry, using the provided length ratio, as a geometry. The third boolean argument determines whether the output geometry, if areal, can contain holes.

    Definition Classes
    stFunctions
    Since

    3.5.0

  89. def st_concavehull(geo: Column, lengthRatio: Double): Column
    Definition Classes
    stFunctions
  90. def st_concavehull(geo: Column, lengthRatio: Column): Column

    Returns the concave hull of the input geometry, using the provided length ratio, as a geometry.

    Returns the concave hull of the input geometry, using the provided length ratio, as a geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  91. def st_contains(geo1: Column, geo2: Column): Column

    Returns true if the first geometry contains the second geometry.

    Returns true if the first geometry contains the second geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  92. def st_convexhull(geo: Column): Column

    Returns the convex hull of the input geometry as a geometry.

    Returns the convex hull of the input geometry as a geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  93. def st_covers(geo1: Column, geo2: Column): Column

    Returns true if the first geometry covers the second geometry.

    Returns true if the first geometry covers the second geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  94. def st_difference(geo1: Column, geo2: Column): Column

    Returns the point-set different of the two input geometries as a 2D geometry.

    Returns the point-set different of the two input geometries as a 2D geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  95. def st_dimension(geo: Column): Column

    Returns the topological dimension of the 2D projection of the input geometry.

    Returns the topological dimension of the 2D projection of the input geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  96. def st_disjoint(geo1: Column, geo2: Column): Column

    Returns true if the two geometries are disjoint.

    Returns true if the two geometries are disjoint.

    Definition Classes
    stFunctions
    Since

    3.5.0

  97. def st_distance(geo1: Column, geo2: Column): Column

    Returns the 2D Cartesian distance between the two input geometries.

    Returns the 2D Cartesian distance between the two input geometries. The units of the result are those of the coordinates of the input geometries.

    Definition Classes
    stFunctions
    Since

    3.5.0

  98. def st_distancesphere(geo1: Column, geo2: Column): Column

    Returns the spherical distance (in meters) between two point geometries, measured on a sphere whose radius is the mean radius of the WGS84 ellipsoid.

    Returns the spherical distance (in meters) between two point geometries, measured on a sphere whose radius is the mean radius of the WGS84 ellipsoid.

    Definition Classes
    stFunctions
    Since

    3.5.0

  99. def st_distancespheroid(geo1: Column, geo2: Column): Column

    Returns the geodesic distance (in meters) between two point geometries on the WGS84 ellipsoid.

    Returns the geodesic distance (in meters) between two point geometries on the WGS84 ellipsoid. The coordinates of the points are assumed to be in degrees.

    Definition Classes
    stFunctions
    Since

    3.5.0

  100. def st_dump(geo: Column): Column

    Returns an array containing the single geometries inside the input geometry.

    Returns an array containing the single geometries inside the input geometry.

    Definition Classes
    stFunctions
    Since

    4.0.0

  101. def st_dwithin(geo1: Column, geo2: Column, d: Double): Column
    Definition Classes
    stFunctions
  102. def st_dwithin(geo1: Column, geo2: Column, d: Column): Column

    Returns true iff the 2D Cartesian distance between the two input geometries is smaller than or equal to the input distance.

    Returns true iff the 2D Cartesian distance between the two input geometries is smaller than or equal to the input distance.

    Definition Classes
    stFunctions
    Since

    4.0.0

  103. def st_endpoint(geo: Column): Column

    Returns the last point of the input GEOGRAPHY or GEOMETRY value, if the input geospatial value is a non-empty linestring.

    Returns the last point of the input GEOGRAPHY or GEOMETRY value, if the input geospatial value is a non-empty linestring. Otherwise, returns NULL. The SRID value of the output point geography or geometry is the same as that of the input value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  104. def st_envelope(geo: Column): Column

    Returns a 2D Cartesian geometry representing the 2D axis-aligned minimum bounding box (envelope) of the input geometry, if one exists.

    Returns a 2D Cartesian geometry representing the 2D axis-aligned minimum bounding box (envelope) of the input geometry, if one exists. In the case the input geometry is empty (that is it has zero non-empty points) it is returned as is.

    Definition Classes
    stFunctions
    Since

    3.5.0

  105. def st_envelope_agg(geo: Column): Column

    Returns a 2D Cartesian geometry representing the aggregate envelope of all input geometries.

    Returns a 2D Cartesian geometry representing the aggregate envelope of all input geometries. If the column contains only empty geometries, the function returns an empty geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  106. def st_equals(geo1: Column, geo2: Column): Column

    Returns true if the two geometries are geometrically equal.

    Returns true if the two geometries are geometrically equal.

    Definition Classes
    stFunctions
    Since

    3.5.0

  107. def st_exteriorring(geo: Column): Column

    Returns the exterior ring (shell), as a linestring, of the input GEOGRAPHY or GEOMETRY value, if it represents a polygon.

    Returns the exterior ring (shell), as a linestring, of the input GEOGRAPHY or GEOMETRY value, if it represents a polygon. Otherwise, an error is returned. The SRID and dimension are preserved.

    Definition Classes
    stFunctions
    Since

    4.0.0

  108. def st_flipcoordinates(geo: Column): Column

    Swaps the X and Y coordinates of the input geometry.

    Swaps the X and Y coordinates of the input geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  109. def st_geogfromewkt(ewkt: Column): Column

    Parses the EWKT description of a geography and returns the corresponding GEOGRAPHY value.

    Parses the EWKT description of a geography and returns the corresponding GEOGRAPHY value. The function returns an error if the SRID specification is missing.

    Definition Classes
    stFunctions
    Since

    4.1.0

  110. def st_geogfromgeojson(geojson: Column): Column

    Parses the GeoJSON description of a geography and returns the corresponding GEOGRAPHY value.

    Parses the GeoJSON description of a geography and returns the corresponding GEOGRAPHY value. The SRID value of the returned GEOGRAPHY value is 4326.

    Definition Classes
    stFunctions
    Since

    3.5.0

  111. def st_geogfromtext(wkt: Column): Column

    Parses the WKT description of a geography and returns the corresponding GEOGRAPHY value.

    Parses the WKT description of a geography and returns the corresponding GEOGRAPHY value. The SRID value of the returned GEOGRAPHY value is 4326.

    Definition Classes
    stFunctions
    Since

    3.5.0

  112. def st_geogfromwkb(wkb: Column): Column

    Parses the WKB description of a geography and returns the corresponding GEOGRAPHY value.

    Parses the WKB description of a geography and returns the corresponding GEOGRAPHY value. The SRID value of the returned GEOGRAPHY value is 4326.

    Definition Classes
    stFunctions
    Since

    3.5.0

  113. def st_geogfromwkt(wkt: Column): Column

    Parses the WKT description of a geography and returns the corresponding GEOGRAPHY value.

    Parses the WKT description of a geography and returns the corresponding GEOGRAPHY value. The SRID value of the returned GEOGRAPHY value is 4326.

    Definition Classes
    stFunctions
    Since

    3.5.0

  114. def st_geohash(geo: Column): Column

    Returns the geohash corresponding to the input geometry, or NULL if the geometry is empty.

    Returns the geohash corresponding to the input geometry, or NULL if the geometry is empty. The precision of the returned geohash value is at most 12.

    Definition Classes
    stFunctions
    Since

    3.5.0

  115. def st_geohash(geo: Column, precision: Int): Column
    Definition Classes
    stFunctions
  116. def st_geohash(geo: Column, precision: Column): Column

    Returns the geohash corresponding to the input geometry and the precision, or NULL if the geometry is empty.

    Returns the geohash corresponding to the input geometry and the precision, or NULL if the geometry is empty.

    Definition Classes
    stFunctions
    Since

    3.5.0

  117. def st_geometryn(geo: Column, n: Int): Column
    Definition Classes
    stFunctions
  118. def st_geometryn(geo: Column, n: Column): Column

    Returns the 1-based n-th element of the input geometry as a GEOMETRY value, if the input is a multipoint, a multilinestring, a multipolygon, or a geometry collection, or NULL if the element does not exist.

    Returns the 1-based n-th element of the input geometry as a GEOMETRY value, if the input is a multipoint, a multilinestring, a multipolygon, or a geometry collection, or NULL if the element does not exist. Returns the input as a GEOMETRY value, if the input is a non-empty point, linestring, or polygon and the value of the index is equal to 1, otherwise returns NULL.

    Definition Classes
    stFunctions
    Since

    3.5.0

  119. def st_geometrytype(geo: Column): Column

    Returns the type of the input GEOGRAPHY or GEOMETRY value as a string.

    Returns the type of the input GEOGRAPHY or GEOMETRY value as a string.

    Definition Classes
    stFunctions
    Since

    3.5.0

  120. def st_geomfromewkb(ewkb: Column): Column

    Parses the EWKB description of a geometry and returns the corresponding GEOMETRY value.

    Parses the EWKB description of a geometry and returns the corresponding GEOMETRY value. The SRID value of the returned GEOMETRY value is the one prescribed in the EWKB description, or 0 if there is no SRID value in the EWKB description.

    Definition Classes
    stFunctions
    Since

    3.5.0

  121. def st_geomfromewkt(ewkt: Column): Column

    Parses the EWKT description of a geometry and returns the corresponding GEOMETRY value.

    Parses the EWKT description of a geometry and returns the corresponding GEOMETRY value. The SRID value of the returned GEOMETRY value is the one prescribed in the EWKT description, or 0 if there is no SRID value in the EWKT description.

    Definition Classes
    stFunctions
    Since

    4.1.0

  122. def st_geomfromgeohash(geohash: Column): Column

    Returns the geohash grid box corresponding to the input geohash value as a 2D polygon geometry.

    Returns the geohash grid box corresponding to the input geohash value as a 2D polygon geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  123. def st_geomfromgeojson(geojson: Column): Column

    Parses the GeoJSON description of a geometry and returns the corresponding GEOMETRY value.

    Parses the GeoJSON description of a geometry and returns the corresponding GEOMETRY value. The SRID value of the returned GEOMETRY value is 4326.

    Definition Classes
    stFunctions
    Since

    3.5.0

  124. def st_geomfromtext(wkt: Column, srid: Int): Column
    Definition Classes
    stFunctions
  125. def st_geomfromtext(wkt: Column, srid: Column): Column

    Parses the WKT description of a geometry and returns the corresponding GEOMETRY value.

    Parses the WKT description of a geometry and returns the corresponding GEOMETRY value. The SRID value of the returned GEOMETRY value is the provided SRID.

    Definition Classes
    stFunctions
    Since

    3.5.0

  126. def st_geomfromtext(wkt: Column): Column

    Parses the WKT description of a geometry and returns the corresponding GEOMETRY value.

    Parses the WKT description of a geometry and returns the corresponding GEOMETRY value. The SRID value of the returned GEOMETRY value is 0.

    Definition Classes
    stFunctions
    Since

    3.5.0

  127. def st_geomfromwkb(wkb: Column, srid: Int): Column
    Definition Classes
    stFunctions
  128. def st_geomfromwkb(wkb: Column, srid: Column): Column

    Parses the WKB description of a geometry and returns the corresponding GEOMETRY value.

    Parses the WKB description of a geometry and returns the corresponding GEOMETRY value. The SRID value of the returned GEOGRAPHY value is the provided SRID.

    Definition Classes
    stFunctions
    Since

    3.5.0

  129. def st_geomfromwkb(wkb: Column): Column

    Parses the WKB description of a geometry and returns the corresponding GEOMETRY value.

    Parses the WKB description of a geometry and returns the corresponding GEOMETRY value. The SRID value of the returned GEOGRAPHY value is 0.

    Definition Classes
    stFunctions
    Since

    3.5.0

  130. def st_geomfromwkt(wkt: Column, srid: Int): Column
    Definition Classes
    stFunctions
  131. def st_geomfromwkt(wkt: Column, srid: Column): Column

    Parses the WKT description of a geometry and returns the corresponding GEOMETRY value.

    Parses the WKT description of a geometry and returns the corresponding GEOMETRY value. The SRID value of the returned GEOMETRY value is the provided SRID.

    Definition Classes
    stFunctions
    Since

    3.5.0

  132. def st_geomfromwkt(wkt: Column): Column

    Parses the WKT description of a geometry and returns the corresponding GEOMETRY value.

    Parses the WKT description of a geometry and returns the corresponding GEOMETRY value. The SRID value of the returned GEOMETRY value is 0.

    Definition Classes
    stFunctions
    Since

    3.5.0

  133. def st_interiorringn(geo: Column, n: Int): Column
    Definition Classes
    stFunctions
  134. def st_interiorringn(geo: Column, n: Column): Column

    Returns the 1-based n-th interior ring of the input polygon as a (closed) linestring.

    Returns the 1-based n-th interior ring of the input polygon as a (closed) linestring. If the input geospatial value is not a polygon or if the polygon does not have the interior ring with the given index, an error is returned. The SRID and dimension are preserved.

    Definition Classes
    stFunctions
    Since

    4.0.0

  135. def st_intersection(geo1: Column, geo2: Column): Column

    Returns the point-set intersection of the two input geometries as a 2D geometry.

    Returns the point-set intersection of the two input geometries as a 2D geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  136. def st_intersects(geo1: Column, geo2: Column): Column

    Returns true if the two geometries intersect.

    Returns true if the two geometries intersect.

    Definition Classes
    stFunctions
    Since

    3.5.0

  137. def st_isempty(geo: Column): Column

    Returns true if the input geography or geometry value does not contain any non-empty points.

    Returns true if the input geography or geometry value does not contain any non-empty points.

    Definition Classes
    stFunctions
    Since

    3.5.0

  138. def st_isvalid(geo: Column): Column

    Returns true if the input geometry is a valid geometry in the OGC sense.

    Returns true if the input geometry is a valid geometry in the OGC sense. See: go/geometric-validity for details of what geometric validity means in the OGC sense.

    Definition Classes
    stFunctions
    Since

    3.5.0

  139. def st_length(e: Column): Column

    Returns the length of the input BINARY, GEOGRAPHY, GEOMETRY, or STRING value.

    Returns the length of the input BINARY, GEOGRAPHY, GEOMETRY, or STRING value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  140. def st_m(geo: Column): Column

    Returns the M coordinate of the input point geometry, or NULL if the point is empty or does not have an M coordinate.

    Returns the M coordinate of the input point geometry, or NULL if the point is empty or does not have an M coordinate.

    Definition Classes
    stFunctions
    Since

    3.5.0

  141. def st_makeline(geoArray: Column): Column

    Returns a linestring geometry whose points are the non-empty points of the geometries in the input array of geometries, which are expected to be points, linestrings, or multipoints.

    Returns a linestring geometry whose points are the non-empty points of the geometries in the input array of geometries, which are expected to be points, linestrings, or multipoints.

    Definition Classes
    stFunctions
    Since

    3.5.0

  142. def st_makepolygon(geo: Column, geoArray: Column): Column

    Constructs a polygon from the input outer boundary and array of inner boundaries, represented as closed linestrings.

    Constructs a polygon from the input outer boundary and array of inner boundaries, represented as closed linestrings.

    Definition Classes
    stFunctions
    Since

    3.5.0

  143. def st_makepolygon(geo: Column): Column

    Constructs a polygon from the input outer boundary, represented as a closed linestring.

    Constructs a polygon from the input outer boundary, represented as a closed linestring.

    Definition Classes
    stFunctions
    Since

    3.5.0

  144. def st_multi(geo: Column): Column

    Returns the geometry as a MULTI* geometry collection.

    Returns the geometry as a MULTI* geometry collection. If the geometry is already a collection, it is returned unchanged.

    Definition Classes
    stFunctions
    Since

    3.5.0

  145. def st_ndims(geo: Column): Column

    Returns the coordinate dimension (that is the number of coordinates of the points) of the input geography or geometry value.

    Returns the coordinate dimension (that is the number of coordinates of the points) of the input geography or geometry value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  146. def st_npoints(geo: Column): Column

    Returns the number of non-empty points in the input geometry or geography value.

    Returns the number of non-empty points in the input geometry or geography value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  147. def st_numgeometries(geo: Column): Column

    Returns the number of geometries in the input geometry.

    Returns the number of geometries in the input geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  148. def st_numinteriorrings(geo: Column): Column

    Returns the number of interior rings of the input polygon geography or geometry.

    Returns the number of interior rings of the input polygon geography or geometry.

    Definition Classes
    stFunctions
    Since

    4.0.0

  149. def st_perimeter(e: Column): Column

    Returns the perimeter of the input BINARY, GEOGRAPHY, GEOMETRY, or STRING value.

    Returns the perimeter of the input BINARY, GEOGRAPHY, GEOMETRY, or STRING value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  150. def st_point(x: Column, y: Column, srid: Int): Column
    Definition Classes
    stFunctions
  151. def st_point(x: Column, y: Column, srid: Column): Column

    Returns a 2D point GEOMETRY with the given x and y coordinates and SRID value.

    Returns a 2D point GEOMETRY with the given x and y coordinates and SRID value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  152. def st_point(x: Column, y: Column): Column

    Returns a 2D point GEOMETRY with the given x and y coordinates and SRID value.

    Returns a 2D point GEOMETRY with the given x and y coordinates and SRID value. The SRID value of the returned point geometry is set to 0.

    Definition Classes
    stFunctions
    Since

    3.5.0

  153. def st_pointfromgeohash(geohash: Column): Column

    Returns the center of the geohash grid box corresponding to the input geohash value as a 2D point geometry.

    Returns the center of the geohash grid box corresponding to the input geohash value as a 2D point geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  154. def st_pointn(geo: Column, n: Int): Column
    Definition Classes
    stFunctions
  155. def st_pointn(geo: Column, n: Column): Column

    Returns the 1-based indexed n-th point of the input GEOGRAPHY or GEOMETRY value, if the index is valid and the input geospatial value is a non-empty linestring.

    Returns the 1-based indexed n-th point of the input GEOGRAPHY or GEOMETRY value, if the index is valid and the input geospatial value is a non-empty linestring. Otherwise, returns NULL. The SRID value of the output point geography or geometry is the same as that of the input value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  156. def st_removepoint(geo: Column, n: Int): Column
    Definition Classes
    stFunctions
  157. def st_removepoint(geo: Column, n: Column): Column

    Removes the n-th point from the input linestring GEOGRAPHY or GEOMETRY.

    Removes the n-th point from the input linestring GEOGRAPHY or GEOMETRY.

    Definition Classes
    stFunctions
    Since

    3.5.0

  158. def st_reverse(geo: Column): Column

    Reverses the order of vertices in the input GEOGRAPHY or GEOMETRY value.

    Reverses the order of vertices in the input GEOGRAPHY or GEOMETRY value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  159. def st_rotate(geo: Column, angle: Double): Column
    Definition Classes
    stFunctions
  160. def st_rotate(geo: Column, angle: Column): Column

    Rotates the input geometry around the Z axis by the given rotation angle (in radians).

    Rotates the input geometry around the Z axis by the given rotation angle (in radians).

    Definition Classes
    stFunctions
    Since

    3.5.0

  161. def st_scale(geo: Column, xFactor: Double, yFactor: Double, zFactor: Double): Column
    Definition Classes
    stFunctions
  162. def st_scale(geo: Column, xFactor: Column, yFactor: Column, zFactor: Column): Column

    Scales the input geometry using in the X, Y, and Z directions using the provided scaling factors.

    Scales the input geometry using in the X, Y, and Z directions using the provided scaling factors.

    Definition Classes
    stFunctions
    Since

    3.5.0

  163. def st_scale(geo: Column, xFactor: Double, yFactor: Double): Column
    Definition Classes
    stFunctions
  164. def st_scale(geo: Column, xFactor: Column, yFactor: Column): Column

    Scales the input geometry using in the X and Y directions using the provided scaling factors.

    Scales the input geometry using in the X and Y directions using the provided scaling factors.

    Definition Classes
    stFunctions
    Since

    3.5.0

  165. def st_setpoint(geo1: Column, n: Int, geo2: Column): Column
    Definition Classes
    stFunctions
  166. def st_setpoint(geo1: Column, n: Column, geo2: Column): Column

    Sets the n-th point in the input linestring GEOGRAPHY or GEOMETRY.

    Sets the n-th point in the input linestring GEOGRAPHY or GEOMETRY.

    Definition Classes
    stFunctions
    Since

    3.5.0

  167. def st_setsrid(geo: Column, newSrid: Int): Column
    Definition Classes
    stFunctions
  168. def st_setsrid(geo: Column, newSrid: Column): Column

    Returns a new GEOMETRY value whose SRID is the specified SRID value.

    Returns a new GEOMETRY value whose SRID is the specified SRID value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  169. def st_simplify(geo: Column, threshold: Double): Column
    Definition Classes
    stFunctions
  170. def st_simplify(geo: Column, threshold: Column): Column

    Simplifies the input geometry using the Douglas-Peucker algorithm (see: https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm)

    Simplifies the input geometry using the Douglas-Peucker algorithm (see: https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm)

    Definition Classes
    stFunctions
    Since

    3.5.0

  171. def st_srid(geo: Column): Column

    Returns the SRID of the input GEOGRAPHY or GEOMETRY value.

    Returns the SRID of the input GEOGRAPHY or GEOMETRY value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  172. def st_startpoint(geo: Column): Column

    Returns the first point of the input GEOGRAPHY or GEOMETRY value, if the input geospatial value is a non-empty linestring.

    Returns the first point of the input GEOGRAPHY or GEOMETRY value, if the input geospatial value is a non-empty linestring. Otherwise, returns NULL. The SRID value of the output point geography or geometry is the same as that of the input value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  173. def st_touches(geo1: Column, geo2: Column): Column

    Returns true if the two geometries are touch each other.

    Returns true if the two geometries are touch each other.

    Definition Classes
    stFunctions
    Since

    3.5.0

  174. def st_transform(geo: Column, srid: Int): Column
    Definition Classes
    stFunctions
  175. def st_transform(geo: Column, srid: Column): Column

    Transforms the X and Y coordinates of the input geometry from the current coordinate reference system (CRS) to the coordinate reference system described by the provided SRID value.

    Transforms the X and Y coordinates of the input geometry from the current coordinate reference system (CRS) to the coordinate reference system described by the provided SRID value.

    Definition Classes
    stFunctions
    Since

    3.5.0

  176. def st_translate(geo: Column, xOffset: Double, yOffset: Double, zOffset: Double): Column
    Definition Classes
    stFunctions
  177. def st_translate(geo: Column, xOffset: Column, yOffset: Column, zOffset: Column): Column

    Translates the input geometry using in the X, Y, and Z directions using the provided offsets.

    Translates the input geometry using in the X, Y, and Z directions using the provided offsets.

    Definition Classes
    stFunctions
    Since

    3.5.0

  178. def st_translate(geo: Column, xOffset: Double, yOffset: Double): Column
    Definition Classes
    stFunctions
  179. def st_translate(geo: Column, xOffset: Column, yOffset: Column): Column

    Translates the input geometry using in the X and Y directions using the provided offsets.

    Translates the input geometry using in the X and Y directions using the provided offsets.

    Definition Classes
    stFunctions
    Since

    3.5.0

  180. def st_union(geo1: Column, geo2: Column): Column

    Returns the point-set union of the two input geometries as a 2D geometry.

    Returns the point-set union of the two input geometries as a 2D geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  181. def st_union_agg(geo: Column): Column

    Definition Classes
    stFunctions
    Since

    3.5.0

  182. def st_within(geo1: Column, geo2: Column): Column

    Returns true if the first geometry is within the second geometry.

    Returns true if the first geometry is within the second geometry.

    Definition Classes
    stFunctions
    Since

    3.5.0

  183. def st_x(geo: Column): Column

    Returns the X coordinate of the input point geometry, or NULL if the point is empty.

    Returns the X coordinate of the input point geometry, or NULL if the point is empty.

    Definition Classes
    stFunctions
    Since

    3.5.0

  184. def st_xmax(geo: Column): Column

    Returns the maximum X coordinate of the input geometry, or NULL if the geometry is empty.

    Returns the maximum X coordinate of the input geometry, or NULL if the geometry is empty.

    Definition Classes
    stFunctions
    Since

    3.5.0

  185. def st_xmin(geo: Column): Column

    Returns the minimum X coordinate of the input geometry, or NULL if the geometry is empty.

    Returns the minimum X coordinate of the input geometry, or NULL if the geometry is empty.

    Definition Classes
    stFunctions
    Since

    3.5.0

  186. def st_y(geo: Column): Column

    Returns the Y coordinate of the input point geometry, or NULL if the point is empty.

    Returns the Y coordinate of the input point geometry, or NULL if the point is empty.

    Definition Classes
    stFunctions
    Since

    3.5.0

  187. def st_ymax(geo: Column): Column

    Returns the maximum Y coordinate of the input geometry, or NULL if the geometry is empty.

    Returns the maximum Y coordinate of the input geometry, or NULL if the geometry is empty.

    Definition Classes
    stFunctions
    Since

    3.5.0

  188. def st_ymin(geo: Column): Column

    Returns the minimum Y coordinate of the input geometry, or NULL if the geometry is empty.

    Returns the minimum Y coordinate of the input geometry, or NULL if the geometry is empty.

    Definition Classes
    stFunctions
    Since

    3.5.0

  189. def st_z(geo: Column): Column

    Returns the Z coordinate of the input point geometry, or NULL if the point is empty or does not have a Z coordinate.

    Returns the Z coordinate of the input point geometry, or NULL if the point is empty or does not have a Z coordinate.

    Definition Classes
    stFunctions
    Since

    3.5.0

  190. def st_zmax(geo: Column): Column

    Returns the maximum Z coordinate of the input geometry, or NULL if the geometry is empty or does not have a Z coordinate.

    Returns the maximum Z coordinate of the input geometry, or NULL if the geometry is empty or does not have a Z coordinate.

    Definition Classes
    stFunctions
    Since

    3.5.0

  191. def st_zmin(geo: Column): Column

    Returns the minimum Z coordinate of the input geometry, or NULL if the geometry is empty or does not have a Z coordinate.

    Returns the minimum Z coordinate of the input geometry, or NULL if the geometry is empty or does not have a Z coordinate.

    Definition Classes
    stFunctions
    Since

    3.5.0

  192. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  193. def toString(): String
    Definition Classes
    AnyRef → Any
  194. def to_geography(geoRep: Column): Column

    Parses the input BINARY or STRING value and returns the corresponding GEOGRAPHY value.

    Parses the input BINARY or STRING value and returns the corresponding GEOGRAPHY value. The input expected to be one of the standard geospatial formats: GeoJSON (STRING input value), WKB (BINARY input value), or WKT(STRING input value). The SRID value of the returned GEOGRAPHY value is 4326.

    Definition Classes
    stFunctions
    Since

    3.5.0

  195. def to_geometry(geoRep: Column): Column

    Parses the input BINARY or STRING value and returns the corresponding GEOMETRY value.

    Parses the input BINARY or STRING value and returns the corresponding GEOMETRY value. The input expected to be one of the standard geospatial formats: GeoJSON (STRING input value), WKB (BINARY input value), or WKT(STRING input value). The SRID value of the returned GEOMETRY value is 4326 if the input is GeoJSON, and 0 otherwise.

    Definition Classes
    stFunctions
    Since

    3.5.0

  196. def try_to_geography(geoRep: Column): Column

    Parses the input BINARY or STRING value and returns the corresponding GEOGRAPHY value.

    Parses the input BINARY or STRING value and returns the corresponding GEOGRAPHY value. The input expected to be one of the standard geospatial formats: GeoJSON (STRING input value), WKB (BINARY input value), or WKT(STRING input value). The SRID value of the returned GEOGRAPHY value is 4326. NULL is returned if the input is invalid.

    Definition Classes
    stFunctions
    Since

    3.5.0

  197. def try_to_geometry(geoRep: Column): Column

    Parses the input BINARY or STRING value and returns the corresponding GEOMETRY value.

    Parses the input BINARY or STRING value and returns the corresponding GEOMETRY value. The input expected to be one of the standard geospatial formats: GeoJSON (STRING input value), WKB (BINARY input value), or WKT(STRING input value). The SRID value of the returned GEOMETRY value is 4326 if the input is GeoJSON, and 0 otherwise. NULL is returned if the input is invalid.

    Definition Classes
    stFunctions
    Since

    3.5.0

  198. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  199. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  200. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  201. def withAttributionTags[S](tags: (TagDefinition, String)*)(thunk: => S): S
    Definition Classes
    UsageLogging

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from h3Functions

Inherited from stFunctions

Inherited from DeprecatedFunctionLogging

Inherited from UsageLogging

Inherited from AnyRef

Inherited from Any

H3 geometry/geography functions

st_func

ST geometry/geography fuctions

Ungrouped