diff options
| author | mvervuurt <m.a.vervuurt@gmail.com> | 2016-08-16 23:12:59 -0700 |
|---|---|---|
| committer | Reynold Xin <rxin@databricks.com> | 2016-08-16 23:12:59 -0700 |
| commit | 0f6aa8afaacdf0ceca9c2c1650ca26a5c167ae69 (patch) | |
| tree | 639297ceb9457c2ffbc54f1038c7e21030dcfccc /python | |
| parent | f7c9ff57c17a950cccdc26aadf8768c899a4d572 (diff) | |
| download | spark-0f6aa8afaacdf0ceca9c2c1650ca26a5c167ae69.tar.gz spark-0f6aa8afaacdf0ceca9c2c1650ca26a5c167ae69.tar.bz2 spark-0f6aa8afaacdf0ceca9c2c1650ca26a5c167ae69.zip | |
[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 <gurwls223@gmail.com>
Author: mvervuurt <m.a.vervuurt@gmail.com>
Closes #14677 from HyukjinKwon/typo-python.
Diffstat (limited to 'python')
| -rw-r--r-- | python/pyspark/sql/readwriter.py | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/python/pyspark/sql/readwriter.py b/python/pyspark/sql/readwriter.py index 4020bb3fa4..64de33e8ec 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() |