Skip to content
Snippets Groups Projects
Commit 5f8ff2fc authored by Jacek Laskowski's avatar Jacek Laskowski Committed by Xiao Li
Browse files

[SPARK-16202][SQL][DOC] Follow-up to Correct The Description of...

[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 <jacek@japila.pl>

Closes #18026 from jaceklaskowski/CreatableRelationProvider-SPARK-16202.
parent c0b3e45e
No related branches found
No related tags found
No related merge requests found
...@@ -163,16 +163,13 @@ trait StreamSinkProvider { ...@@ -163,16 +163,13 @@ trait StreamSinkProvider {
@InterfaceStability.Stable @InterfaceStability.Stable
trait CreatableRelationProvider { trait CreatableRelationProvider {
/** /**
* Save the DataFrame to the destination and return a relation with the given parameters based on * Saves a DataFrame to a destination (using data source-specific parameters)
* the contents of the given DataFrame. The mode specifies the expected behavior of createRelation *
* when data already exists. * @param sqlContext SQLContext
* Right now, there are three modes, Append, Overwrite, and ErrorIfExists. * @param mode specifies what happens when the destination already exists
* Append mode means that when saving a DataFrame to a data source, if data already exists, * @param parameters data source-specific parameters
* contents of the DataFrame are expected to be appended to existing data. * @param data DataFrame to save (i.e. the rows after executing the query)
* Overwrite mode means that when saving a DataFrame to a data source, if data already exists, * @return Relation with a known schema
* existing data is expected to be overwritten by the contents of the DataFrame.
* ErrorIfExists mode means that when saving a DataFrame to a data source,
* if data already exists, an exception is expected to be thrown.
* *
* @since 1.3.0 * @since 1.3.0
*/ */
......
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