Constructor
Read ESRI Shapefile¶
Introduction: Construct a DataFrame from a Shapefile
Since: v1.0.0
SparkSQL example:
var spatialRDD = new SpatialRDD[Geometry]
spatialRDD.rawSpatialRDD = ShapefileReader.readToGeometryRDD(sparkSession.sparkContext, shapefileInputLocation)
var rawSpatialDf = Adapter.toDf(spatialRDD,sparkSession)
rawSpatialDf.createOrReplaceTempView("rawSpatialDf")
var spatialDf = sparkSession.sql("""
| ST_GeomFromWKT(rddshape), _c1, _c2
| FROM rawSpatialDf
""".stripMargin)
spatialDf.show()
spatialDf.printSchema()
Note
The path to the shapefile is the path to the folder that contains the .shp file, not the path to the .shp file itself. The file extensions of .shp, .shx, .dbf must be in lowercase. Assume you have a shape file called myShapefile, the path should be XXX/myShapefile. The file structure should be like this:
- shapefile1
- shapefile2
- myshapefile
- myshapefile.shp
- myshapefile.shx
- myshapefile.dbf
- myshapefile...
- ...
Warning
Please make sure you use ST_GeomFromWKT to create Geometry type column otherwise that column cannot be used in SedonaSQL.
If the file you are reading contains non-ASCII characters you'll need to explicitly set the encoding
via sedona.global.charset system property before the call to ShapefileReader.readToGeometryRDD.
Example:
System.setProperty("sedona.global.charset", "utf8")
ST_GeomFromGeoHash¶
Introduction: Create Geometry from geohash string and optional precision
Format: ST_GeomFromGeoHash(geohash: String, precision: Integer)
Since: v1.1.1
Spark SQL example:
SELECT ST_GeomFromGeoHash('s00twy01mt', 4)
Output:
POLYGON ((0.703125 0.87890625, 0.703125 1.0546875, 1.0546875 1.0546875, 1.0546875 0.87890625, 0.703125 0.87890625))
ST_GeomFromGeoJSON¶
Introduction: Construct a Geometry from GeoJson
Format: ST_GeomFromGeoJSON (GeoJson: String)
Since: v1.0.0
Spark SQL example:
SELECT ST_GeomFromGeoJSON('{
"type":"Feature",
"properties":{
"STATEFP":"01",
"COUNTYFP":"077",
"TRACTCE":"011501",
"BLKGRPCE":"5",
"AFFGEOID":"1500000US010770115015",
"GEOID":"010770115015",
"NAME":"5",
"LSAD":"BG",
"ALAND":6844991,
"AWATER":32636
},
"geometry":{
"type":"Polygon",
"coordinates":[
[
[-87.621765, 34.873444],
[-87.617535, 34.873369],
[-87.62119, 34.85053],
[-87.62144, 34.865379],
[-87.621765, 34.873444]
]
]
}
}')
Output:
POLYGON ((-87.621765 34.873444, -87.617535 34.873369, -87.62119 34.85053, -87.62144 34.865379, -87.621765 34.873444))
Spark SQL example:
SELECT ST_GeomFromGeoJSON('{
"type":"Polygon",
"coordinates":[
[
[-87.621765, 34.873444],
[-87.617535, 34.873369],
[-87.62119, 34.85053],
[-87.62144, 34.865379],
[-87.621765, 34.873444]
]
]
}')
Output:
POLYGON ((-87.621765 34.873444, -87.617535 34.873369, -87.62119 34.85053, -87.62144 34.865379, -87.621765 34.873444))
Warning
The way that SedonaSQL reads GeoJSON is different from that in SparkSQL
ST_GeomFromGML¶
Introduction: Construct a Geometry from GML.
Format:
ST_GeomFromGML (gml: String)
Since: v1.3.0
SQL example:
SELECT ST_GeomFromGML('
<gml:LineString srsName="EPSG:4269">
<gml:coordinates>
-71.16028,42.258729
-71.160837,42.259112
-71.161143,42.25932
</gml:coordinates>
</gml:LineString>
')
Output:
LINESTRING (-71.16028 42.258729, -71.160837 42.259112, -71.161143 42.25932)
ST_GeomFromKML¶
Introduction: Construct a Geometry from KML.
Format:
ST_GeomFromKML (kml: String)
Since: v1.3.0
SQL example:
SELECT ST_GeomFromKML('
<LineString>
<coordinates>
-71.1663,42.2614
-71.1667,42.2616
</coordinates>
</LineString>
')
Output:
LINESTRING (-71.1663 42.2614, -71.1667 42.2616)
ST_GeomFromText¶
Introduction: Construct a Geometry from WKT. If SRID is not set, it defaults to 0 (unknown). Alias of ST_GeomFromWKT
Format:
ST_GeomFromText (Wkt: String)
ST_GeomFromText (Wkt: String, srid: Integer)
Since: v1.0.0
The optional srid parameter was added in v1.3.1
Spark SQL example:
SELECT ST_GeomFromText('POINT(40.7128 -74.0060)')
Output:
POINT(40.7128 -74.006)
ST_GeomFromWKB¶
Introduction: Construct a Geometry from WKB string or Binary. This function also supports EWKB format.
Format:
ST_GeomFromWKB (Wkb: String)
ST_GeomFromWKB (Wkb: Binary)
Since: v1.0.0
Spark SQL example:
SELECT ST_GeomFromWKB([01 02 00 00 00 02 00 00 00 00 00 00 00 84 D6 00 C0 00 00 00 00 80 B5 D6 BF 00 00 00 60 E1 EF F7 BF 00 00 00 80 07 5D E5 BF])
Output:
LINESTRING (-2.1047439575195312 -0.354827880859375, -1.49606454372406 -0.6676061153411865)
Spark SQL example:
SELECT ST_asEWKT(ST_GeomFromWKB('01010000a0e6100000000000000000f03f000000000000f03f000000000000f03f'))
Output:
SRID=4326;POINT Z(1 1 1)
ST_GeomFromWKT¶
Introduction: Construct a Geometry from WKT. If SRID is not set, it defaults to 0 (unknown).
Format:
ST_GeomFromWKT (Wkt: String)
ST_GeomFromWKT (Wkt: String, srid: Integer)
Since: v1.0.0
The optional srid parameter was added in v1.3.1
Spark SQL example:
SELECT ST_GeomFromWKT('POINT(40.7128 -74.0060)')
Output:
POINT(40.7128 -74.006)
ST_GeomFromEWKT¶
Introduction: Construct a Geometry from OGC Extended WKT
Format:
ST_GeomFromEWKT (EWkt: String)
Since: v1.5.0
SQL example:
SELECT ST_AsText(ST_GeomFromEWKT('SRID=4269;POINT(40.7128 -74.0060)'))
Output:
POINT(40.7128 -74.006)
ST_LineFromText¶
Introduction: Construct a Line from Wkt text
Format:
ST_LineFromText (Wkt: String)
Since: v1.2.1
Spark SQL example:
SELECT ST_LineFromText('LINESTRING(1 2,3 4)')
Output:
LINESTRING (1 2, 3 4)
ST_LineStringFromText¶
Introduction: Construct a LineString from Text, delimited by Delimiter
Format: ST_LineStringFromText (Text: String, Delimiter: Char)
Since: v1.0.0
Spark SQL example:
SELECT ST_LineStringFromText('-74.0428197,40.6867969,-74.0421975,40.6921336,-74.0508020,40.6912794', ',')
Output:
LINESTRING (-74.0428197 40.6867969, -74.0421975 40.6921336, -74.050802 40.6912794)
ST_MakePoint¶
Introduction: Creates a 2D, 3D Z or 4D ZM Point geometry. Use ST_MakePointM to make points with XYM coordinates. Z and M values are optional.
Format: ST_MakePoint (X: Double, Y: Double, Z: Double, M: Double)
Since: v1.5.0
Example:
SELECT ST_AsText(ST_MakePoint(1.2345, 2.3456));
Output:
POINT (1.2345 2.3456)
Example:
SELECT ST_AsText(ST_MakePoint(1.2345, 2.3456, 3.4567));
Output:
POINT Z (1.2345 2.3456 3.4567)
Example:
SELECT ST_AsText(ST_MakePoint(1.2345, 2.3456, 3.4567, 4));
Output:
POINT ZM (1.2345 2.3456 3.4567 4)
ST_MLineFromText¶
Introduction: Construct a MultiLineString from Wkt. If srid is not set, it defaults to 0 (unknown).
Format:
ST_MLineFromText (Wkt: String)
ST_MLineFromText (Wkt: String, srid: Integer)
Since: v1.3.1
Spark SQL example:
SELECT ST_MLineFromText('MULTILINESTRING((1 2, 3 4), (4 5, 6 7))')
Output:
MULTILINESTRING ((1 2, 3 4), (4 5, 6 7))
ST_MPolyFromText¶
Introduction: Construct a MultiPolygon from Wkt. If srid is not set, it defaults to 0 (unknown).
Format:
ST_MPolyFromText (Wkt: String)
ST_MPolyFromText (Wkt: String, srid: Integer)
Since: v1.3.1
Spark SQL example:
SELECT ST_MPolyFromText('MULTIPOLYGON(((0 0 1,20 0 1,20 20 1,0 20 1,0 0 1),(5 5 3,5 7 3,7 7 3,7 5 3,5 5 3)))')
Output:
MULTIPOLYGON (((0 0, 20 0, 20 20, 0 20, 0 0), (5 5, 5 7, 7 7, 7 5, 5 5)))
ST_Point¶
Introduction: Construct a Point from X and Y
Format: ST_Point (X: Double, Y: Double)
Since: v1.0.0
In v1.4.0 an optional Z parameter was removed to be more consistent with other spatial SQL implementations.
If you are upgrading from an older version of Sedona - please use ST_PointZ to create 3D points.
Spark SQL example:
SELECT ST_Point(double(1.2345), 2.3456)
Output:
POINT (1.2345 2.3456)
ST_PointZ¶
Introduction: Construct a Point from X, Y and Z and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z coordinate.
Format:
ST_PointZ (X: Double, Y: Double, Z: Double)
ST_PointZ (X: Double, Y: Double, Z: Double, srid: Integer)
Since: v1.4.0
Spark SQL example:
SELECT ST_AsEWKT(ST_PointZ(1.2345, 2.3456, 3.4567))
Output:
POINT Z(1.2345 2.3456 3.4567)
ST_PointFromText¶
Introduction: Construct a Point from Text, delimited by Delimiter
Format: ST_PointFromText (Text: String, Delimiter: Char)
Since: v1.0.0
Spark SQL example:
SELECT ST_PointFromText('40.7128,-74.0060', ',')
Output:
POINT (40.7128 -74.006)
ST_PolygonFromEnvelope¶
Introduction: Construct a Polygon from MinX, MinY, MaxX, MaxY.
Format:
ST_PolygonFromEnvelope (MinX: Double, MinY: Double, MaxX: Double, MaxY: Double)
Since: v1.0.0
Spark SQL example:
SELECT ST_PolygonFromEnvelope(double(1.234),double(2.234),double(3.345),double(3.345))
Output:
POLYGON ((1.234 2.234, 1.234 3.345, 3.345 3.345, 3.345 2.234, 1.234 2.234))
ST_PolygonFromText¶
Introduction: Construct a Polygon from Text, delimited by Delimiter. Path must be closed
Format: ST_PolygonFromText (Text: String, Delimiter: Char)
Since: v1.0.0
Spark SQL example:
SELECT ST_PolygonFromText('-74.0428197,40.6867969,-74.0421975,40.6921336,-74.0508020,40.6912794,-74.0428197,40.6867969', ',')
Output:
POLYGON ((-74.0428197 40.6867969, -74.0421975 40.6921336, -74.050802 40.6912794, -74.0428197 40.6867969))