aboutsummaryrefslogtreecommitdiff
path: root/sql
diff options
context:
space:
mode:
authorChet Mancini <chetmancini@gmail.com>2015-04-01 21:39:46 -0700
committerMichael Armbrust <michael@databricks.com>2015-04-01 21:39:46 -0700
commit191524e7401fcdfae46dc7e6a64c28907b1b1c20 (patch)
treef41011d46a1dd9145c1932d70ba15d354adbe4cf /sql
parent899ebcb1448126f40be784ce42e69218e9a1ead7 (diff)
downloadspark-191524e7401fcdfae46dc7e6a64c28907b1b1c20.tar.gz
spark-191524e7401fcdfae46dc7e6a64c28907b1b1c20.tar.bz2
spark-191524e7401fcdfae46dc7e6a64c28907b1b1c20.zip
[SPARK-6658][SQL] Update DataFrame documentation to fix type references.
First contribution here; would love to be getting some code contributions in soon. Let me know if there's anything about contribution process I should improve. Author: Chet Mancini <chetmancini@gmail.com> Closes #5316 from chetmancini/SPARK_6658_dataframe_doc and squashes the following commits: 53b627a [Chet Mancini] [SQL] SPARK-6658: Update DataFrame documentation to refer to correct types
Diffstat (limited to 'sql')
-rw-r--r--sql/core/src/main/scala/org/apache/spark/sql/DataFrame.scala12
1 files changed, 6 insertions, 6 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 19cfa15f27..ce0890906b 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
@@ -273,7 +273,7 @@ class DataFrame private[sql](
def printSchema(): Unit = println(schema.treeString)
/**
- * Prints the plans (logical and physical) to the console for debugging purpose.
+ * Prints the plans (logical and physical) to the console for debugging purposes.
* @group basic
*/
def explain(extended: Boolean): Unit = {
@@ -285,7 +285,7 @@ class DataFrame private[sql](
}
/**
- * Only prints the physical plan to the console for debugging purpose.
+ * Only prints the physical plan to the console for debugging purposes.
* @group basic
*/
def explain(): Unit = explain(extended = false)
@@ -976,8 +976,8 @@ class DataFrame private[sql](
def javaRDD: JavaRDD[Row] = toJavaRDD
/**
- * Registers this RDD as a temporary table using the given name. The lifetime of this temporary
- * table is tied to the [[SQLContext]] that was used to create this DataFrame.
+ * Registers this [[DataFrame]] as a temporary table using the given name. The lifetime of this
+ * temporary table is tied to the [[SQLContext]] that was used to create this DataFrame.
*
* @group basic
*/
@@ -1252,7 +1252,7 @@ class DataFrame private[sql](
////////////////////////////////////////////////////////////////////////////
/**
- * Save this RDD to a JDBC database at `url` under the table name `table`.
+ * Save this [[DataFrame]] to a JDBC database at `url` under the table name `table`.
* This will run a `CREATE TABLE` and a bunch of `INSERT INTO` statements.
* If you pass `true` for `allowExisting`, it will drop any table with the
* given name; if you pass `false`, it will throw if the table already
@@ -1276,7 +1276,7 @@ class DataFrame private[sql](
}
/**
- * Save this RDD to a JDBC database at `url` under the table name `table`.
+ * Save this [[DataFrame]] to a JDBC database at `url` under the table name `table`.
* Assumes the table already exists and has a compatible schema. If you
* pass `true` for `overwrite`, it will `TRUNCATE` the table before
* performing the `INSERT`s.