nxcals.api.extraction.data.builders.DataFrame.take

DataFrame.take(num: int) → List[Row]

Returns the first num rows as a list of Row.

New in version 1.3.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters:

num (int) – Number of records to return. Will return this number of records or all records if the DataFrame contains less than this number of records..

Returns:

List of rows

Return type:

list

Examples

>>> df = spark.createDataFrame(
...     [(14, "Tom"), (23, "Alice"), (16, "Bob")], ["age", "name"])

Return the first 2 rows of the DataFrame.

>>> df.take(2)
[Row(age=14, name='Tom'), Row(age=23, name='Alice')]