snowflake.snowpark.DataFrame.to_pandas¶
- DataFrame.to_pandas(*, statement_params: Optional[Dict[str, str]] = None, block: bool = True, **kwargs: Dict[str, Any]) pandas.DataFrame [source] (https://github.com/snowflakedb/snowpark-python/blob/v1.16.0/src/snowflake/snowpark/dataframe.py#L773-L819)¶
- DataFrame.to_pandas(*, statement_params: Optional[Dict[str, str]] = None, block: bool = False, **kwargs: Dict[str, Any]) AsyncJob
Executes the query representing this DataFrame and returns the result as a pandas DataFrame (https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html).
When the data is too large to fit into memory, you can use
to_pandas_batches()
.- Parameters:
statement_params – Dictionary of statement level parameters to be set while executing this action.
block – A bool value indicating whether this function will wait until the result is available. When it is
False
, this function executes the underlying queries of the dataframe asynchronously and returns anAsyncJob
.
Note
This method is only available if pandas is installed and available.
2. If you use
Session.sql()
with this method, the input query ofSession.sql()
can only be a SELECT statement.