Repository: spark Updated Branches: refs/heads/branch-2.0 3e0163bee -> 68a24d3e7
[MINOR][DOC] Fix the descriptions for `properties` argument in the documenation for jdbc APIs ## What changes were proposed in this pull request? This should be credited to mvervuurt. The main purpose of this PR is - simply to include the change for the same instance in `DataFrameReader` just to match up. - just avoid duplicately verifying the PR (as I already did). The documentation for both should be the same because both assume the `properties` should be the same `dict` for the same option. ## How was this patch tested? Manually building Python documentation. This will produce the output as below: - `DataFrameReader`  - `DataFrameWriter`  Closes #14624 Author: hyukjinkwon <gurwls...@gmail.com> Author: mvervuurt <m.a.vervu...@gmail.com> Closes #14677 from HyukjinKwon/typo-python. (cherry picked from commit 0f6aa8afaacdf0ceca9c2c1650ca26a5c167ae69) Signed-off-by: Reynold Xin <r...@databricks.com> Project: http://git-wip-us.apache.org/repos/asf/spark/repo Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/68a24d3e Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/68a24d3e Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/68a24d3e Branch: refs/heads/branch-2.0 Commit: 68a24d3e7aa9b40d4557652d3179b0ccb0f8624e Parents: 3e0163b Author: mvervuurt <m.a.vervu...@gmail.com> Authored: Tue Aug 16 23:12:59 2016 -0700 Committer: Reynold Xin <r...@databricks.com> Committed: Tue Aug 16 23:13:06 2016 -0700 ---------------------------------------------------------------------- python/pyspark/sql/readwriter.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/spark/blob/68a24d3e/python/pyspark/sql/readwriter.py ---------------------------------------------------------------------- diff --git a/python/pyspark/sql/readwriter.py b/python/pyspark/sql/readwriter.py index 4020bb3..64de33e 100644 --- a/python/pyspark/sql/readwriter.py +++ b/python/pyspark/sql/readwriter.py @@ -401,8 +401,9 @@ class DataFrameReader(OptionUtils): :param numPartitions: the number of partitions :param predicates: a list of expressions suitable for inclusion in WHERE clauses; each one defines one partition of the :class:`DataFrame` - :param properties: a dictionary of JDBC database connection arguments; normally, - at least a "user" and "password" property should be included + :param properties: a dictionary of JDBC database connection arguments. Normally at + least properties "user" and "password" with their corresponding values. + For example { 'user' : 'SYSTEM', 'password' : 'mypassword' } :return: a DataFrame """ if properties is None: @@ -716,9 +717,9 @@ class DataFrameWriter(OptionUtils): * ``overwrite``: Overwrite existing data. * ``ignore``: Silently ignore this operation if data already exists. * ``error`` (default case): Throw an exception if data already exists. - :param properties: JDBC database connection arguments, a list of - arbitrary string tag/value. Normally at least a - "user" and "password" property should be included. + :param properties: a dictionary of JDBC database connection arguments. Normally at + least properties "user" and "password" with their corresponding values. + For example { 'user' : 'SYSTEM', 'password' : 'mypassword' } """ if properties is None: properties = dict() --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org
