Skip to content
Snippets Groups Projects
Commit 191524e7 authored by Chet Mancini's avatar Chet Mancini Committed by Michael Armbrust
Browse files

[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
parent 899ebcb1
No related branches found
No related tags found
No related merge requests found
...@@ -273,7 +273,7 @@ class DataFrame private[sql]( ...@@ -273,7 +273,7 @@ class DataFrame private[sql](
def printSchema(): Unit = println(schema.treeString) 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 * @group basic
*/ */
def explain(extended: Boolean): Unit = { def explain(extended: Boolean): Unit = {
...@@ -285,7 +285,7 @@ class DataFrame private[sql]( ...@@ -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 * @group basic
*/ */
def explain(): Unit = explain(extended = false) def explain(): Unit = explain(extended = false)
...@@ -976,8 +976,8 @@ class DataFrame private[sql]( ...@@ -976,8 +976,8 @@ class DataFrame private[sql](
def javaRDD: JavaRDD[Row] = toJavaRDD def javaRDD: JavaRDD[Row] = toJavaRDD
/** /**
* Registers this RDD as a temporary table using the given name. The lifetime of this temporary * Registers this [[DataFrame]] as a temporary table using the given name. The lifetime of this
* table is tied to the [[SQLContext]] that was used to create this DataFrame. * temporary table is tied to the [[SQLContext]] that was used to create this DataFrame.
* *
* @group basic * @group basic
*/ */
...@@ -1252,7 +1252,7 @@ class DataFrame private[sql]( ...@@ -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. * 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 * 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 * given name; if you pass `false`, it will throw if the table already
...@@ -1276,7 +1276,7 @@ class DataFrame private[sql]( ...@@ -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 * Assumes the table already exists and has a compatible schema. If you
* pass `true` for `overwrite`, it will `TRUNCATE` the table before * pass `true` for `overwrite`, it will `TRUNCATE` the table before
* performing the `INSERT`s. * performing the `INSERT`s.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment