Skip to content

Commit 0f6aa8a

Browse files
mvervuurtrxin
authored andcommitted
[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` ![2016-08-17 11 12 00](https://cloud.githubusercontent.com/assets/6477701/17722764/b3f6568e-646f-11e6-8b75-4fb672f3f366.png) - `DataFrameWriter` ![2016-08-17 11 12 10](https://cloud.githubusercontent.com/assets/6477701/17722765/b58cb308-646f-11e6-841a-32f19800d139.png) Closes #14624 Author: hyukjinkwon <[email protected]> Author: mvervuurt <[email protected]> Closes #14677 from HyukjinKwon/typo-python.
1 parent f7c9ff5 commit 0f6aa8a

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

python/pyspark/sql/readwriter.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -401,8 +401,9 @@ def jdbc(self, url, table, column=None, lowerBound=None, upperBound=None, numPar
401401
:param numPartitions: the number of partitions
402402
:param predicates: a list of expressions suitable for inclusion in WHERE clauses;
403403
each one defines one partition of the :class:`DataFrame`
404-
:param properties: a dictionary of JDBC database connection arguments; normally,
405-
at least a "user" and "password" property should be included
404+
:param properties: a dictionary of JDBC database connection arguments. Normally at
405+
least properties "user" and "password" with their corresponding values.
406+
For example { 'user' : 'SYSTEM', 'password' : 'mypassword' }
406407
:return: a DataFrame
407408
"""
408409
if properties is None:
@@ -716,9 +717,9 @@ def jdbc(self, url, table, mode=None, properties=None):
716717
* ``overwrite``: Overwrite existing data.
717718
* ``ignore``: Silently ignore this operation if data already exists.
718719
* ``error`` (default case): Throw an exception if data already exists.
719-
:param properties: JDBC database connection arguments, a list of
720-
arbitrary string tag/value. Normally at least a
721-
"user" and "password" property should be included.
720+
:param properties: a dictionary of JDBC database connection arguments. Normally at
721+
least properties "user" and "password" with their corresponding values.
722+
For example { 'user' : 'SYSTEM', 'password' : 'mypassword' }
722723
"""
723724
if properties is None:
724725
properties = dict()

0 commit comments

Comments
 (0)