Type Members

1.  abstract class BinaryGeometryExpression extends Expression with ExpectsInputTypes
2.  trait DataFrameAPI extends AnyRef
3.  trait FoldableExpression extends Expression

   Make expression foldable by constant folding optimizer.

   Make expression foldable by constant folding optimizer. If all children expressions are foldable, then the expression itself is foldable.

4.  sealed class InferrableType[T] extends AnyRef
5.  abstract class InferredBinaryExpression[A1, A2, R] extends Expression with ImplicitCastInputTypes with CodegenFallback with Serializable
6.  abstract class InferredTernaryExpression[A1, A2, A3, R] extends Expression with ImplicitCastInputTypes with CodegenFallback with Serializable
7.  abstract class InferredUnaryExpression[A1, R] extends Expression with ImplicitCastInputTypes with CodegenFallback with Serializable

   The implicit TypeTag's tell Scala to maintain generic type info at runtime.

   The implicit TypeTag's tell Scala to maintain generic type info at runtime. Normally type erasure would remove any knowledge of what the passed in generic type is.

8.  case class ST_3DDistance(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Geometry, Double] with FoldableExpression with Product with Serializable
9.  case class ST_AddPoint(inputExpressions: Seq[Expression]) extends InferredTernaryExpression[Geometry, Geometry, Int, Geometry] with FoldableExpression with Product with Serializable
10.  case class ST_Area(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Double] with FoldableExpression with Product with Serializable

    Return the area measurement of a Geometry.

11.  case class ST_AsBinary(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Array[Byte]] with Product with Serializable
12.  case class ST_AsEWKB(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Array[Byte]] with Product with Serializable
13.  case class ST_AsEWKT(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, String] with FoldableExpression with Product with Serializable

    Returns the geometry in EWKT format

14.  case class ST_AsGML(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, String] with FoldableExpression with Product with Serializable
15.  case class ST_AsGeoJSON(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, String] with FoldableExpression with Product with Serializable
16.  case class ST_AsKML(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, String] with FoldableExpression with Product with Serializable
17.  case class ST_AsText(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, String] with FoldableExpression with Product with Serializable
18.  case class ST_Azimuth(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Geometry, Double] with FoldableExpression with Product with Serializable
19.  case class ST_Boundary(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable
20.  case class ST_Buffer(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Double, Geometry] with FoldableExpression with Product with Serializable

    Returns a geometry/geography that represents all points whose distance from this Geometry/geography is less than or equal to distance.

21.  case class ST_BuildArea(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable

    Returns the areal geometry formed by the constituent linework of the input geometry assuming all inner geometries represent holes

22.  case class ST_Centroid(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable

    Return mathematical centroid of a geometry.

23.  case class ST_Contains(inputExpressions: Seq[Expression]) extends ST_Predicate with CodegenFallback with Product with Serializable

    Test if leftGeometry full contains rightGeometry

24.  case class ST_ConvexHull(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable

    Return the convex hull of a Geometry.

25.  case class ST_CoveredBy(inputExpressions: Seq[Expression]) extends ST_Predicate with CodegenFallback with Product with Serializable

    Test if leftGeometry is covered by rightGeometry

26.  case class ST_Covers(inputExpressions: Seq[Expression]) extends ST_Predicate with CodegenFallback with Product with Serializable

    Test if leftGeometry covers rightGeometry

27.  case class ST_Crosses(inputExpressions: Seq[Expression]) extends ST_Predicate with CodegenFallback with Product with Serializable

    Test if leftGeometry crosses rightGeometry

28.  case class ST_Difference(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Geometry, Geometry] with FoldableExpression with Product with Serializable

    Return the difference between geometry A and B

29.  case class ST_Disjoint(inputExpressions: Seq[Expression]) extends ST_Predicate with CodegenFallback with Product with Serializable

    Test if leftGeometry is disjoint from rightGeometry

30.  case class ST_Distance(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Geometry, Double] with FoldableExpression with Product with Serializable

    Return the distance between two geometries.

    Return the distance between two geometries.

    inputExpressions

    This function takes two geometries and calculates the distance between two objects.

31.  case class ST_Dump(inputExpressions: Seq[Expression]) extends UnaryGeometryExpression with FoldableExpression with CodegenFallback with Product with Serializable
32.  case class ST_DumpPoints(inputExpressions: Seq[Expression]) extends UnaryGeometryExpression with FoldableExpression with CodegenFallback with Product with Serializable
33.  case class ST_EndPoint(inputExpressions: Seq[Expression]) extends UnaryGeometryExpression with FoldableExpression with CodegenFallback with Product with Serializable
34.  case class ST_Envelope(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable

    Return the bounding rectangle for a Geometry

35.  class ST_Envelope_Aggr extends expressions.Aggregator[Geometry, Geometry, Geometry] with TraitSTAggregateExec

    Return the envelope boundary of the entire column

36.  case class ST_Equals(inputExpressions: Seq[Expression]) extends ST_Predicate with CodegenFallback with Product with Serializable

    Test if leftGeometry is equal to rightGeometry

37.  case class ST_ExteriorRing(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable
38.  case class ST_FlipCoordinates(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable

    Returns a version of the given geometry with X and Y axis flipped.

    Returns a version of the given geometry with X and Y axis flipped.

    inputExpressions

    Geometry

39.  case class ST_Force_2D(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable
40.  case class ST_GeoHash(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Int, String] with FoldableExpression with Product with Serializable
41.  case class ST_GeomFromGML(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with Product with Serializable
42.  case class ST_GeomFromGeoHash(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with Product with Serializable
43.  case class ST_GeomFromGeoJSON(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with CodegenFallback with UserDataGeneratator with Product with Serializable

    Return a Geometry from a GeoJSON string

    Return a Geometry from a GeoJSON string

    inputExpressions

    This function takes 1 parameter which is the geometry string. The string format must be GeoJson.

44.  case class ST_GeomFromKML(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with Product with Serializable
45.  case class ST_GeomFromText(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[String, Int, Geometry] with FoldableExpression with Product with Serializable

    Return a Geometry from a WKT string

    Return a Geometry from a WKT string

    inputExpressions

    This function takes a geometry string and a srid. The string format must be WKT.

46.  case class ST_GeomFromWKB(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with UserDataGeneratator with Product with Serializable

    Return a Geometry from a WKB string

    Return a Geometry from a WKB string

    inputExpressions

    This function takes 1 parameter which is the utf-8 encoded geometry wkb string or the binary wkb array.

47.  case class ST_GeomFromWKT(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[String, Int, Geometry] with FoldableExpression with Product with Serializable

    Return a Geometry from a WKT string

    Return a Geometry from a WKT string

    inputExpressions

    This function takes a geometry string and a srid. The string format must be WKT.

48.  case class ST_GeometryN(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Int, Geometry] with FoldableExpression with Product with Serializable
49.  case class ST_GeometryType(inputExpressions: Seq[Expression]) extends UnaryGeometryExpression with FoldableExpression with CodegenFallback with Product with Serializable
50.  case class ST_InteriorRingN(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Int, Geometry] with FoldableExpression with Product with Serializable
51.  case class ST_Intersection(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Geometry, Geometry] with FoldableExpression with Product with Serializable

    Return the intersection shape of two geometries.

    Return the intersection shape of two geometries. The return type is a geometry

52.  class ST_Intersection_Aggr extends expressions.Aggregator[Geometry, Geometry, Geometry] with TraitSTAggregateExec

    Return the polygon intersection of all Polygon in the given column

53.  case class ST_Intersects(inputExpressions: Seq[Expression]) extends ST_Predicate with CodegenFallback with Product with Serializable

    Test if leftGeometry full intersects rightGeometry

54.  case class ST_IsClosed(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Boolean] with FoldableExpression with Product with Serializable
55.  case class ST_IsEmpty(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Boolean] with FoldableExpression with Product with Serializable

    Test if Geometry is empty geometry.

56.  case class ST_IsRing(inputExpressions: Seq[Expression]) extends UnaryGeometryExpression with FoldableExpression with CodegenFallback with Product with Serializable
57.  case class ST_IsSimple(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Boolean] with FoldableExpression with Product with Serializable

    Test if Geometry is simple.

58.  case class ST_IsValid(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Boolean] with FoldableExpression with Product with Serializable

    Test if Geometry is valid.

59.  case class ST_Length(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Double] with FoldableExpression with Product with Serializable

    Return the length measurement of a Geometry

60.  case class ST_LineFromMultiPoint(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable

    Returns the LineString geometry given a MultiPoint geometry

61.  case class ST_LineFromText(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with UserDataGeneratator with Product with Serializable

    Return a line from a string.

    Return a line from a string. The string must be plain string and each coordinate must be separated by a delimiter.

62.  case class ST_LineInterpolatePoint(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Double, Geometry] with FoldableExpression with Product with Serializable

    Returns a point interpolated along a line.

    Returns a point interpolated along a line. First argument must be a LINESTRING. Second argument is a Double between 0 and 1 representing fraction of total linestring length the point has to be located.

63.  case class ST_LineMerge(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable

    Returns a LineString formed by sewing together the constituent line work of a MULTILINESTRING.

    Returns a LineString formed by sewing together the constituent line work of a MULTILINESTRING. Only works for MultiLineString. Using other geometry will return GEOMETRYCOLLECTION EMPTY If the MultiLineString is can't be merged, the original multilinestring is returned

    inputExpressions

    Geometry

64.  case class ST_LineStringFromText(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with UserDataGeneratator with Product with Serializable

    Return a linestring from a string.

    Return a linestring from a string. The string must be plain string and each coordinate must be separated by a delimiter.

65.  case class ST_LineSubstring(inputExpressions: Seq[Expression]) extends InferredTernaryExpression[Geometry, Double, Double, Geometry] with FoldableExpression with Product with Serializable

    Return a linestring being a substring of the input one starting and ending at the given fractions of total 2d length.

    Return a linestring being a substring of the input one starting and ending at the given fractions of total 2d length. Second and third arguments are Double values between 0 and 1. This only works with LINESTRINGs.

66.  case class ST_MakePolygon(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with CodegenFallback with Product with Serializable
67.  case class ST_MakeValid(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Boolean, Geometry] with FoldableExpression with Product with Serializable

    Given an invalid geometry, create a valid representation of the geometry.

    Given an invalid geometry, create a valid representation of the geometry. See: http://lin-ear-th-inking.blogspot.com/2021/05/fixing-invalid-geometry-with-jts.html

68.  case class ST_MinimumBoundingCircle(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Int, Geometry] with FoldableExpression with Product with Serializable
69.  case class ST_MinimumBoundingRadius(inputExpressions: Seq[Expression]) extends UnaryGeometryExpression with FoldableExpression with CodegenFallback with Product with Serializable
70.  case class ST_Multi(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable
71.  case class ST_NPoints(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Int] with FoldableExpression with Product with Serializable

    Return the number of Points in geometry.

72.  case class ST_Normalize(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable

    Returns the input geometry in its normalized form.

73.  case class ST_NumGeometries(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Int] with FoldableExpression with Product with Serializable

    Returns the number of Geometries.

    Returns the number of Geometries. If geometry is a GEOMETRYCOLLECTION (or MULTI*) return the number of geometries, for single geometries will return 1

    This method implements the SQL/MM specification. SQL-MM 3: 9.1.4

    inputExpressions

    Geometry

74.  case class ST_NumInteriorRings(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Integer] with FoldableExpression with Product with Serializable
75.  case class ST_OrderingEquals(inputExpressions: Seq[Expression]) extends ST_Predicate with CodegenFallback with Product with Serializable

    Test if leftGeometry is order equal to rightGeometry

76.  case class ST_Overlaps(inputExpressions: Seq[Expression]) extends ST_Predicate with CodegenFallback with Product with Serializable

    Test if leftGeometry overlaps rightGeometry

77.  case class ST_Point(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with UserDataGeneratator with Product with Serializable

    Return a Point from X and Y

    Return a Point from X and Y

    inputExpressions

    This function takes 3 parameter which are point x, y and z.

78.  case class ST_PointFromText(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with UserDataGeneratator with Product with Serializable

    Return a point from a string.

    Return a point from a string. The string must be plain string and each coordinate must be separated by a delimiter.

    inputExpressions

    This function takes 2 parameters. The first parameter is the input geometry string, the second parameter is the delimiter. String format should be similar to CSV/TSV

79.  case class ST_PointN(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Int, Geometry] with FoldableExpression with Product with Serializable

    Returns the nth point in the geometry, provided it is a linestring

    Returns the nth point in the geometry, provided it is a linestring

    inputExpressions

    sequence of 2 input arguments, a geometry and a value 'n'

80.  case class ST_PointOnSurface(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable

    Returns a POINT guaranteed to lie on the surface.

    Returns a POINT guaranteed to lie on the surface.

    inputExpressions

    Geometry

81.  case class ST_PolygonFromEnvelope(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with UserDataGeneratator with Product with Serializable

    Return a polygon given minX,minY,maxX,maxY

82.  case class ST_PolygonFromText(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with UserDataGeneratator with Product with Serializable

    Return a polygon from a string.

    Return a polygon from a string. The string must be plain string and each coordinate must be separated by a delimiter.

83.  case class ST_PrecisionReduce(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Int, Geometry] with FoldableExpression with Product with Serializable

    Reduce the precision of the given geometry to the given number of decimal places

    Reduce the precision of the given geometry to the given number of decimal places

    inputExpressions

    The first arg is a geom and the second arg is an integer scale, specifying the number of decimal places of the new coordinate. The last decimal place will be rounded to the nearest number.

84.  abstract class ST_Predicate extends Expression with FoldableExpression with ExpectsInputTypes with NullIntolerant
85.  case class ST_RemovePoint(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Int, Geometry] with FoldableExpression with Product with Serializable
86.  case class ST_Reverse(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Geometry] with FoldableExpression with Product with Serializable

    Returns the geometry with vertex order reversed

87.  case class ST_SRID(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Int] with FoldableExpression with Product with Serializable
88.  case class ST_SetPoint(inputExpressions: Seq[Expression]) extends InferredTernaryExpression[Geometry, Int, Geometry, Geometry] with FoldableExpression with Product with Serializable
89.  case class ST_SetSRID(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Int, Geometry] with FoldableExpression with Product with Serializable
90.  case class ST_SimplifyPreserveTopology(inputExpressions: Seq[Expression]) extends InferredBinaryExpression[Geometry, Double, Geometry] with FoldableExpression with Product with Serializable

    Simplifies a geometry and ensures that the result is a valid geometry having the same dimension and number of components as the input, and with the components having the same topological relationship.

    Simplifies a geometry and ensures that the result is a valid geometry having the same dimension and number of components as the input, and with the components having the same topological relationship. The simplification uses a maximum-distance difference algorithm similar to the Douglas-Peucker algorithm.

    inputExpressions

    first arg is geometry second arg is distance tolerance for the simplification(all vertices in the simplified geometry will be within this distance of the original geometry)

91.  case class ST_StartPoint(inputExpressions: Seq[Expression]) extends UnaryGeometryExpression with FoldableExpression with CodegenFallback with Product with Serializable
92.  case class ST_SubDivide(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with Product with Serializable
93.  case class ST_SubDivideExplode(children: Seq[Expression]) extends Expression with Generator with CodegenFallback with Product with Serializable
94.  case class ST_SymDifference(inputExpressions: Seq[Expression]) extends BinaryGeometryExpression with FoldableExpression with CodegenFallback with Product with Serializable

    Return the symmetrical difference between geometry A and B

95.  case class ST_Touches(inputExpressions: Seq[Expression]) extends ST_Predicate with CodegenFallback with Product with Serializable

    Test if leftGeometry touches rightGeometry

96.  case class ST_Transform(inputExpressions: Seq[Expression]) extends Expression with FoldableExpression with ImplicitCastInputTypes with CodegenFallback with Product with Serializable

    Given a geometry, sourceEPSGcode, and targetEPSGcode, convert the geometry's Spatial Reference System / Coordinate Reference System.

97.  case class ST_Union(inputExpressions: Seq[Expression]) extends BinaryGeometryExpression with FoldableExpression with CodegenFallback with Product with Serializable

    Return the union of geometry A and B

98.  class ST_Union_Aggr extends expressions.Aggregator[Geometry, Geometry, Geometry] with TraitSTAggregateExec

    Return the polygon union of all Polygon in the given column

99.  case class ST_Within(inputExpressions: Seq[Expression]) extends ST_Predicate with CodegenFallback with Product with Serializable

    Test if leftGeometry is full within rightGeometry

100.  case class ST_X(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Double] with FoldableExpression with Product with Serializable
101.  case class ST_XMax(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Double] with FoldableExpression with Product with Serializable

     Test if returning Max X coordinate value.

102.  case class ST_XMin(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Double] with FoldableExpression with Product with Serializable

     Test if returning Min X coordinate value.

103.  case class ST_Y(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Double] with FoldableExpression with Product with Serializable
104.  case class ST_YMax(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Double] with FoldableExpression with Product with Serializable
105.  case class ST_YMin(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Double] with FoldableExpression with Product with Serializable
106.  case class ST_Z(inputExpressions: Seq[Expression]) extends InferredUnaryExpression[Geometry, Double] with FoldableExpression with Product with Serializable
107.  trait TraitSTAggregateExec extends AnyRef

     traits for creating Aggregate Function

108.  abstract class UnaryGeometryExpression extends Expression with ExpectsInputTypes
109.  trait UserDataGeneratator extends AnyRef