Skip to content

Commit ae65d30

Browse files
jaceklaskowskigatorsmile
authored andcommitted
[SPARK-16202][SQL][DOC] Follow-up to Correct The Description of CreatableRelationProvider's createRelation
## What changes were proposed in this pull request? Follow-up to SPARK-16202: 1. Remove the duplication of the meaning of `SaveMode` (as one was in fact missing that had proven that the duplication may be incomplete in the future again) 2. Use standard scaladoc tags /cc gatorsmile rxin yhuai (as they were involved previously) ## How was this patch tested? local build Author: Jacek Laskowski <[email protected]> Closes #18026 from jaceklaskowski/CreatableRelationProvider-SPARK-16202. (cherry picked from commit 5f8ff2f) Signed-off-by: Xiao Li <[email protected]>
1 parent 2405afc commit ae65d30

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

sql/core/src/main/scala/org/apache/spark/sql/sources/interfaces.scala

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -163,16 +163,13 @@ trait StreamSinkProvider {
163163
@InterfaceStability.Stable
164164
trait CreatableRelationProvider {
165165
/**
166-
* Save the DataFrame to the destination and return a relation with the given parameters based on
167-
* the contents of the given DataFrame. The mode specifies the expected behavior of createRelation
168-
* when data already exists.
169-
* Right now, there are three modes, Append, Overwrite, and ErrorIfExists.
170-
* Append mode means that when saving a DataFrame to a data source, if data already exists,
171-
* contents of the DataFrame are expected to be appended to existing data.
172-
* Overwrite mode means that when saving a DataFrame to a data source, if data already exists,
173-
* existing data is expected to be overwritten by the contents of the DataFrame.
174-
* ErrorIfExists mode means that when saving a DataFrame to a data source,
175-
* if data already exists, an exception is expected to be thrown.
166+
* Saves a DataFrame to a destination (using data source-specific parameters)
167+
*
168+
* @param sqlContext SQLContext
169+
* @param mode specifies what happens when the destination already exists
170+
* @param parameters data source-specific parameters
171+
* @param data DataFrame to save (i.e. the rows after executing the query)
172+
* @return Relation with a known schema
176173
*
177174
* @since 1.3.0
178175
*/

0 commit comments

Comments
 (0)