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, _emit_ast: 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, _emit_ast: 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 controls the case sensitivity of the fields in the Row objects returned by the collect. Defaults to True.

See also

collect_nowait()

The default blocking call retrieves all result rows into client memory. For large results, consider to_local_iterator() instead of materializing a list. Use sort() before collecting when the order of rows matters.

Example:

>>> df = session.create_dataframe([(2, "Bob"), (1, "Alice")], schema=["id", "name"])
>>> rows = df.sort("id").collect()
>>> rows
[Row(ID=1, NAME='Alice'), Row(ID=2, NAME='Bob')]
>>> rows[0]["NAME"]
'Alice'
>>> rows[1].ID
2