snowflake.snowpark.DataFrame.take¶
- DataFrame.take(n: int | None = None, *, statement_params: Dict[str, str] | None = None, block: bool = True) Row | None | List[Row] | AsyncJob [source]¶
Executes the query representing this DataFrame and returns the first
n
rows of the results.- Parameters:
n – The number of rows to return.
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
.
- Returns:
A list of the first
n
Row
objects ifn
is notNone
. Ifn
is negative or larger than the number of rows in the result, returns all rows in the results.n
isNone
, it returns the firstRow
of results, orNone
if it does not exist.