Skip to content

[SPARK-22110][SQL][Documentation] Add usage and improve documentation with arguments and examples for trim function #19329

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

Closed
kevinyu98 wants to merge 3 commits into from
Closed

[SPARK-22110][SQL][Documentation] Add usage and improve documentation with arguments and examples for trim function #19329

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7ecbe4c
adding examples for stringTrim string function
kevinyu98 Sep 20, 2017
4f77d95
adjust comments
kevinyu98 Sep 21, 2017
0f3307d
rebase
kevinyu98 Sep 22, 2017
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
30 changes: 23 additions & 7 deletions ...catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,20 +535,36 @@ object StringTrim {
@ExpressionDescription(
usage = """
_FUNC_(str) - Removes the leading and trailing space characters from `str`.
_FUNC_(BOTH trimStr FROM str) - Remove the leading and trailing trimString from `str`

_FUNC_(BOTH trimStr FROM str) - Remove the leading and trailing `trimStr` characters from `str`

_FUNC_(LEADING trimStr FROM str) - Remove the leading `trimStr` characters from `str`

_FUNC_(TRAILING trimStr FROM str) - Remove the trailing `trimStr` characters from `str`
""",
arguments = """
Arguments:
* str - a string expression
* trimString - the trim string
* BOTH, FROM - these are keyword to specify for trim string from both ends of the string
* trimStr - the trim string characters to trim, the default value is a single space
* BOTH, FROM - these are keywords to specify trimming string characters from both ends of
the string
* LEADING, FROM - these are keywords to specify trimming string characters from the left
end of the string
* TRAILING, FROM - these are keywords to specify trimming string characters from the right
end of the string
""",
examples = """
Examples:
> SELECT _FUNC_(' SparkSQL ');
SparkSQL
> SELECT _FUNC_('SL', 'SSparkSQLS');
parkSQ
> SELECT _FUNC_(BOTH 'SL' FROM 'SSparkSQLS');
parkSQ
> SELECT _FUNC_(LEADING 'SL' FROM 'SSparkSQLS');
parkSQLS
> SELECT _FUNC_(TRAILING 'SL' FROM 'SSparkSQLS');
SSparkSQ
""")
case class StringTrim(
srcStr: Expression,
Expand Down Expand Up @@ -634,13 +650,13 @@ object StringTrimLeft {
@ExpressionDescription(
usage = """
_FUNC_(str) - Removes the leading space characters from `str`.

_FUNC_(trimStr, str) - Removes the leading string contains the characters from the trim string
""",
arguments = """
Arguments:
* str - a string expression
* trimString - the trim string
* BOTH, FROM - these are keyword to specify for trim string from both ends of the string
* trimStr - the trim string characters to trim, the default value is a single space
""",
examples = """
Examples:
Expand Down Expand Up @@ -735,13 +751,13 @@ object StringTrimRight {
@ExpressionDescription(
usage = """
_FUNC_(str) - Removes the trailing space characters from `str`.

_FUNC_(trimStr, str) - Removes the trailing string which contains the characters from the trim string from the `str`
""",
arguments = """
Arguments:
* str - a string expression
* trimString - the trim string
* BOTH, FROM - these are keyword to specify for trim string from both ends of the string
* trimStr - the trim string characters to trim, the default value is a single space
""",
examples = """
Examples:
Expand Down