diff options
| author | Tommy YU <tummyyu@163.com> | 2016-02-06 17:29:09 +0000 |
|---|---|---|
| committer | Sean Owen <sowen@cloudera.com> | 2016-02-06 17:29:09 +0000 |
| commit | 81da3bee669aaeb79ec68baaf7c99bff6e5d14fe (patch) | |
| tree | 269905def89ac9cd4cf438d1b45e2d261b0531b4 /sql | |
| parent | 4f28291f851b9062da3941e63de4eabb0c77f5d0 (diff) | |
| download | spark-81da3bee669aaeb79ec68baaf7c99bff6e5d14fe.tar.gz spark-81da3bee669aaeb79ec68baaf7c99bff6e5d14fe.tar.bz2 spark-81da3bee669aaeb79ec68baaf7c99bff6e5d14fe.zip | |
[SPARK-5865][API DOC] Add doc warnings for methods that return local data structures
rxin srowen
I work out note message for rdd.take function, please help to review.
If it's fine, I can apply to all other function later.
Author: Tommy YU <tummyyu@163.com>
Closes #10874 from Wenpei/spark-5865-add-warning-for-localdatastructure.
Diffstat (limited to 'sql')
| -rw-r--r-- | sql/core/src/main/scala/org/apache/spark/sql/DataFrame.scala | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/sql/core/src/main/scala/org/apache/spark/sql/DataFrame.scala b/sql/core/src/main/scala/org/apache/spark/sql/DataFrame.scala index f15b926bd2..7aa08fb630 100644 --- a/sql/core/src/main/scala/org/apache/spark/sql/DataFrame.scala +++ b/sql/core/src/main/scala/org/apache/spark/sql/DataFrame.scala @@ -1384,6 +1384,10 @@ class DataFrame private[sql]( /** * Returns the first `n` rows. + * + * @note this method should only be used if the resulting array is expected to be small, as + * all the data is loaded into the driver's memory. + * * @group action * @since 1.3.0 */ |