| |
- oreplace(source_string, search_string, replace_string)
- DESCRIPTION:
Function replaces every occurrence of search_string in the source_string
with the replace_string. Use this function either to replace or remove
portions of a string.
PARAMETERS:
source_string:
Required Argument.
Specifies a ColumnExpression of a string column or a string literal.
If argument is null, then result is null.
Format of a ColumnExpression of a string column: '<dataframe>.<dataframe_column>.expression'.
Supported column types: CHAR, VARCHAR, or CLOB
search_string:
Required Argument.
Specifies a ColumnExpression of a string column or a string literal
that the function searches for in source_string.
If argument is null, then result is null.
Format of a ColumnExpression of a string column: '<dataframe>.<dataframe_column>.expression'.
Supported column types: CHAR, VARCHAR, or CLOB
replace_string:
Required Argument.
Specifies a ColumnExpression of a string column or a string literal
that replaces the characters specified by search_string.
If argument is NULL or is an empty string, or is omitted, all
occurrences of search_string are removed from the source_string.
Format of a ColumnExpression of a string column: '<dataframe>.<dataframe_column>.expression'.
Supported column types: CHAR, VARCHAR, or CLOB
NOTE:
Function accepts positional arguments only.
EXAMPLES:
# Load the data to run the example.
>>> load_example_data("dataframe", "admissions_train")
>>>
# Create a DataFrame on 'admissions_train' table.
>>> admissions_train = DataFrame("admissions_train")
>>> admissions_train
masters gpa stats programming admitted
id
22 yes 3.46 Novice Beginner 0
36 no 3.00 Advanced Novice 0
15 yes 4.00 Advanced Advanced 1
38 yes 2.65 Advanced Beginner 1
5 no 3.44 Novice Novice 0
17 no 3.83 Advanced Advanced 1
34 yes 3.85 Advanced Beginner 0
13 no 4.00 Advanced Novice 1
26 yes 3.57 Advanced Advanced 1
19 yes 1.98 Advanced Advanced 0
>>>
# Example removes occurrence of "ce" in "stats" column.
# Import func from sqlalchemy to execute oreplace function.
>>> from sqlalchemy import func
# Create a sqlalchemy Function object.
>>> oreplace_func_ = func.oreplace(admissions_train.stats.expression, "ce")
>>>
# Pass the Function object as input to DataFrame.assign().
>>> df = admissions_train.assign(oreplace_stats_=oreplace_func_)
>>> print(df)
masters gpa stats programming admitted oreplace_stats_
id
13 no 4.00 Advanced Novice 1 Advand
26 yes 3.57 Advanced Advanced 1 Advand
5 no 3.44 Novice Novice 0 Novi
19 yes 1.98 Advanced Advanced 0 Advand
15 yes 4.00 Advanced Advanced 1 Advand
40 yes 3.95 Novice Beginner 0 Novi
7 yes 2.33 Novice Novice 1 Novi
22 yes 3.46 Novice Beginner 0 Novi
36 no 3.00 Advanced Novice 0 Advand
38 yes 2.65 Advanced Beginner 1 Advand
>>>
|