trait stFunctions extends AnyRef
- Annotations
- @Py4JWhitelist() @Stable()
- Alphabetic
- By Inheritance
- stFunctions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @IntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def st_addpoint(geo1: Column, geo2: Column): Column
- def st_addpoint(geo1: Column, geo2: Column, n: Int): Column
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_asbinary(geo: Column, endianness: String): Column
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_asewkb(geo: Column, endianness: String): Column
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_asewkt(geo: Column, precision: Int): Column
-
def
st_asewkt(geo: Column, precision: Column): Column
Returns the input GEOGRAPHY or GEOMETRY value in EWKT format using the specified precision.
Returns the input GEOGRAPHY or GEOMETRY value in EWKT format using the specified precision.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_asgeojson(geo: Column, precision: Int): Column
-
def
st_asgeojson(geo: Column, precision: Column): Column
Returns the input GEOGRAPHY or GEOMETRY value in GeoJSON format using the specified precision.
Returns the input GEOGRAPHY or GEOMETRY value in GeoJSON format using the specified precision.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_astext(geo: Column, precision: Int): Column
-
def
st_astext(geo: Column, precision: Column): Column
Returns the input GEOGRAPHY or GEOMETRY value in WKT format using the specified precision.
Returns the input GEOGRAPHY or GEOMETRY value in WKT format using the specified precision.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_aswkb(geo: Column, endianness: String): Column
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_aswkt(geo: Column, precision: Int): Column
-
def
st_aswkt(geo: Column, precision: Column): Column
Returns the input GEOGRAPHY or GEOMETRY value in WKT format using the specified precision.
Returns the input GEOGRAPHY or GEOMETRY value in WKT format using the specified precision.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_concavehull(geo: Column, lengthRatio: Double, allowHoles: Boolean): Column
- def st_concavehull(geo: Column, lengthRatio: Column, allowHoles: Boolean): Column
-
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.
- Since
3.5.0
- def st_concavehull(geo: Column, lengthRatio: Double): Column
-
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.
- Since
3.5.0
-
def
st_contains(geo1: Column, geo2: Column): Column
Returns
trueif the first geometry contains the second geometry.Returns
trueif the first geometry contains the second geometry.- Since
3.5.0
-
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.
- Since
3.5.0
-
def
st_covers(geo1: Column, geo2: Column): Column
Returns
trueif the first geometry covers the second geometry.Returns
trueif the first geometry covers the second geometry.- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
def
st_disjoint(geo1: Column, geo2: Column): Column
Returns
trueif the two geometries are disjoint.Returns
trueif the two geometries are disjoint.- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
def
st_equals(geo1: Column, geo2: Column): Column
Returns
trueif the two geometries are geometrically equal.Returns
trueif the two geometries are geometrically equal.- Since
3.5.0
-
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.
- Since
3.5.0
-
def
st_geogarea(e: Column): Column
Returns the 2D geodesic area of the input BINARY or STRING value representing a geography.
Returns the 2D geodesic area of the input BINARY or STRING value representing a geography. The result is in square meters.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
def
st_geoglength(e: Column): Column
Returns the geodesic length of the input BINARY or STRING value representing a geography.
Returns the geodesic length of the input BINARY or STRING value representing a geography. The result is in meters.
- Since
3.5.0
-
def
st_geogperimeter(e: Column): Column
Returns the geodesic perimeter of the input BINARY or STRING value representing a geography.
Returns the geodesic perimeter of the input BINARY or STRING value representing a geography. The result is in meters
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_geohash(geo: Column, precision: Int): Column
-
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.
- Since
3.5.0
- def st_geometryn(geo: Column, n: Int): Column
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_geomfromtext(wkt: Column, srid: Int): Column
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_geomfromwkb(wkb: Column, srid: Int): Column
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_geomfromwkt(wkt: Column, srid: Int): Column
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
def
st_intersects(geo1: Column, geo2: Column): Column
Returns
trueif the two geometries intersect.Returns
trueif the two geometries intersect.- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
def
st_numgeometries(geo: Column): Column
Returns the number of geometries in the input geometry.
Returns the number of geometries in the input geometry.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_point(x: Column, y: Column, srid: Int): Column
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_pointn(geo: Column, n: Int): Column
-
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.
- Since
3.5.0
- def st_removepoint(geo: Column, n: Int): Column
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
- def st_rotate(geo: Column, angle: Double): Column
-
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).
- Since
3.5.0
- def st_scale(geo: Column, xFactor: Double, yFactor: Double, zFactor: Double): Column
-
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.
- Since
3.5.0
- def st_scale(geo: Column, xFactor: Double, yFactor: Double): Column
-
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.
- Since
3.5.0
- def st_setpoint(geo1: Column, n: Int, geo2: Column): Column
-
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.
- Since
3.5.0
- def st_setsrid(geo: Column, newSrid: Int): Column
-
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.
- Since
3.5.0
- def st_simplify(geo: Column, threshold: Double): Column
-
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)
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
def
st_touches(geo1: Column, geo2: Column): Column
Returns
trueif the two geometries are touch each other.Returns
trueif the two geometries are touch each other.- Since
3.5.0
- def st_transform(geo: Column, srid: Int): Column
-
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.
- Since
3.5.0
- def st_translate(geo: Column, xOffset: Double, yOffset: Double, zOffset: Double): Column
-
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.
- Since
3.5.0
- def st_translate(geo: Column, xOffset: Double, yOffset: Double): Column
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
def
st_union_agg(geo: Column): Column
- Since
3.5.0
-
def
st_within(geo1: Column, geo2: Column): Column
Returns
trueif the first geometry is within the second geometry.Returns
trueif the first geometry is within the second geometry.- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
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.
- Since
3.5.0
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated