[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.
This commit is contained in:
parent
c0b3e45e3b
commit
5f8ff2fc9a
|
@ -163,16 +163,13 @@ trait StreamSinkProvider {
|
|||
@InterfaceStability.Stable
|
||||
trait CreatableRelationProvider {
|
||||
/**
|
||||
* Save the DataFrame to the destination and return a relation with the given parameters based on
|
||||
* the contents of the given DataFrame. The mode specifies the expected behavior of createRelation
|
||||
* when data already exists.
|
||||
* Right now, there are three modes, Append, Overwrite, and ErrorIfExists.
|
||||
* Append mode means that when saving a DataFrame to a data source, if data already exists,
|
||||
* contents of the DataFrame are expected to be appended to existing data.
|
||||
* Overwrite mode means that when saving a DataFrame to a data source, if data already exists,
|
||||
* 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.
|
||||
* Saves a DataFrame to a destination (using data source-specific parameters)
|
||||
*
|
||||
* @param sqlContext SQLContext
|
||||
* @param mode specifies what happens when the destination already exists
|
||||
* @param parameters data source-specific parameters
|
||||
* @param data DataFrame to save (i.e. the rows after executing the query)
|
||||
* @return Relation with a known schema
|
||||
*
|
||||
* @since 1.3.0
|
||||
*/
|
||||
|
|
Loading…
Reference in a new issue