[DOCS] Mention behavior of string returning functions #1039
Conversation
|
Please let me know if there are more functions that return strings with special characters. |
docs/api/sql/Raster-operators.md
Outdated
| If you are using `show()` to display the output, it will show special characters as escape sequences. To get the expected behavior use the following code: | ||
|
|
||
| ```sql | ||
| print(df.selectExpr("RS_GeoReference(rast)").sample(0.5).collect().mkString("")) |
There was a problem hiding this comment.
This is not a SQL example. This should be a language-specific example. You need to provide examples for (Scala/Java) and (Python). Please also say sample() here is to reduce data to be collected. Other functions such as filter() will work as well.
There was a problem hiding this comment.
I don't think the filter function makes much sense here. As there's nothing to filter, the function returns one row, that's a string with special characters for formatting.
There was a problem hiding this comment.
@furqaankhan sample and filter are operations that can reduce the number of resulting rows. Without this kind of commands, a direct collect() on a DataFrame that has millions of row will crash the driver program.
docs/api/sql/Raster-visualizer.md
Outdated
| If you are using `show()` to display the output, it will show special characters as escape sequences. To get the expected behavior use the following code: | ||
|
|
||
| ```sql | ||
| print(df.selectExpr("RS_AsMatrix(rast)").sample(0.5).collect().mkString("")) |
There was a problem hiding this comment.
This is not a SQL example. This should be a language-specific example. You need to provide examples for (Scala/Java) and (Python). Please also say sample() here is to reduce data to be collected. Other functions such as filter() will work as well.
Did you read the Contributor Guide?
Is this PR related to a JIRA ticket?
[DOCS] my subject.What changes were proposed in this PR?
showfunction escapes special characters, this messes up with functions that return string with special characters.How was this patch tested?
Did this PR include necessary documentation updates?