Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Fix the examples in the documentation of raster writer #1611

Merged
merged 1 commit into from
Oct 7, 2024
Merged

[DOCS] Fix the examples in the documentation of raster writer #1611

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions docs/api/sql/Raster-writer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
!!!note
Sedona writers are available in Scala, Java and Python and have the same APIs.
Sedona writers are available in Scala. Java and Python have the same APIs.

## Write Raster DataFrame to raster files

Expand Down Expand Up @@ -148,7 +148,7 @@ Since: `v1.4.1`
Available options:

* rasterField:
* Default value: the `binary` type column in the DataFrame. If the input DataFrame has several binary columns, please specify which column you want to use.
* Default value: the `binary` type column in the DataFrame. If the input DataFrame has several binary columns, please specify which column you want to use. You can use one of the `RS_As*` functions mentioned above to convert the raster objects to binary raster file content to write.
* Allowed values: the name of the to-be-saved binary type column
* fileExtension
* Default value: `.tiff`
Expand All @@ -164,27 +164,36 @@ The schema of the Raster dataframe to be written can be one of the following two

```html
root
|-- rs_asgeotiff(raster): binary (nullable = true)
|-- raster_binary: binary (nullable = true)
```

or

```html
root
|-- rs_asgeotiff(raster): binary (nullable = true)
|-- raster_binary: binary (nullable = true)
|-- path: string (nullable = true)
```

Spark SQL example 1:

```scala
sparkSession.write.format("raster").mode(SaveMode.Overwrite).save("my_raster_file")
// Assume that df contains a raster column named "rast"
df.withColumn("raster_binary", expr("RS_AsGeoTiff(rast)"))\
.write.format("raster").mode("overwrite").save("my_raster_file")
```

Spark SQL example 2:

```scala
sparkSession.write.format("raster").option("rasterField", "raster").option("pathField", "path").option("fileExtension", ".tiff").mode(SaveMode.Overwrite).save("my_raster_file")
// Assume that df contains a raster column named "rast" and a string column named "path"
df.withColumn("raster_binary", expr("RS_AsGeoTiff(rast)"))\
.write.format("raster")\
.option("rasterField", "raster_binary")\
.option("pathField", "path")\
.option("fileExtension", ".tiff")\
.mode("overwrite")\
.save("my_raster_file")
```

The produced file structure will look like this:
Expand Down
Loading