snowflake.snowpark.Session.sqlΒΆ
- Session.sql(query: str, params: Optional[Sequence[Any]] = None) DataFrame [source]ΒΆ
Returns a new DataFrame representing the results of a SQL query.
Note
You can use this method to execute a SQL query lazily, which means the SQL is not executed until methods like
DataFrame.collect()
orDataFrame.to_pandas()
evaluate the DataFrame. For immediate execution, chain the call with the collect method: session.sql(query).collect().- Parameters:
query β The SQL statement to execute.
params β binding parameters. We only support qmark bind variables. For more information, check https://docs.snowflake.com/en/developer-guide/python-connector/python-connector-example#qmark-or-numeric-binding
Example:
>>> # create a dataframe from a SQL query >>> df = session.sql("select 1/2") >>> # execute the query >>> df.collect() [Row(1/2=Decimal('0.500000'))] >>> # Use params to bind variables >>> session.sql("select * from values (?, ?), (?, ?)", params=[1, "a", 2, "b"]).sort("column1").collect() [Row(COLUMN1=1, COLUMN2='a'), Row(COLUMN1=2, COLUMN2='b')]