snowflake.snowpark.DataFrame.collect¶

DataFrame.collect(*, statement_params: Optional[Dict[str, str]] = None, block: bool = True, log_on_exception: bool = False, case_sensitive: bool = True) → List[Row][source]¶

DataFrame.collect(*, statement_params: Optional[Dict[str, str]] = None, block: bool = False, log_on_exception: bool = False, case_sensitive: bool = True) → AsyncJob

Executes the query representing this DataFrame and returns the result as a list of Row objects.

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 an AsyncJob.

• case_sensitive – A bool value which is controls the case sensitivity of the fields in the Row objects returned by the collect. Defaults to True.

See also

collect_nowait()