Skip to content

[WIP][SPARK-41666][PYTHON] Support parameterized SQL by PySpark sql() #39159

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
MaxGekk wants to merge 2 commits into from
Closed

[WIP][SPARK-41666][PYTHON] Support parameterized SQL by PySpark sql() #39159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0038258
Support parameterized SQL by PySpark sql
MaxGekk Dec 7, 2022
368de7b
Fix coding style of sql_formatter.py
MaxGekk Dec 21, 2022
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
3 changes: 2 additions & 1 deletion python/pyspark/sql/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1376,7 +1376,8 @@ def sql(self, sqlQuery: str, **kwargs: Any) -> DataFrame:
if len(kwargs) > 0:

@HyukjinKwon HyukjinKwon Dec 22, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another way is to keep the signature same as Scala's. e.g.)

def sql(self, sqlQuery: str, args: Dict[str, str] = {}, **kwargs: Any) -> DataFrame:
    # Use args for SQL mapping

sqlQuery = formatter.format(sqlQuery, **kwargs)
try:
return DataFrame(self._jsparkSession.sql(sqlQuery), self)
args = formatter.unused_args
return DataFrame(self._jsparkSession.sql(sqlQuery, args), self)
finally:
if len(kwargs) > 0:
formatter.clear()
Expand Down
10 changes: 10 additions & 0 deletions python/pyspark/sql/sql_formatter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ class SQLStringFormatter(string.Formatter):
def __init__(self, session: "SparkSession") -> None:
self._session: "SparkSession" = session
self._temp_views: List[Tuple[DataFrame, str]] = []
self.unused_args: Mapping[str, str] = {}

def get_field(self, field_name: str, args: Sequence[Any], kwargs: Mapping[str, Any]) -> Any:
obj, first = super(SQLStringFormatter, self).get_field(field_name, args, kwargs)
Expand Down Expand Up @@ -78,7 +79,16 @@ def _convert_value(self, val: Any, field_name: str) -> Optional[str]:
else:
return val

def check_unused_args(
self, used_args: Sequence[Any], args: Sequence[Any], kwargs: Mapping[str, Any]
) -> None:
for k in kwargs:
if isinstance(kwargs[k], str) and not used_args.__contains__(k):
self.unused_args[k] = kwargs[k]
return super().check_unused_args(used_args, args, kwargs)

def clear(self) -> None:
for _, n in self._temp_views:
self._session.catalog.dropTempView(n)
self._temp_views = []
self.unused_args = []