-
Notifications
You must be signed in to change notification settings - Fork 29k
[MINOR][DOCS] JSON APIs related documentation fixes #17602
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -173,8 +173,8 @@ def json(self, path, schema=None, primitivesAsString=None, prefersDecimal=None, | |
| """ | ||
| Loads JSON files and returns the results as a :class:`DataFrame`. | ||
|
|
||
| `JSON Lines <http://jsonlines.org/>`_(newline-delimited JSON) is supported by default. | ||
| For JSON (one record per file), set the `wholeFile` parameter to ``true``. | ||
| `JSON Lines <http://jsonlines.org/>`_ (newline-delimited JSON) is supported by default. | ||
| For JSON (one record per file), set the ``wholeFile`` parameter to ``true``. | ||
|
|
||
| If the ``schema`` parameter is not specified, this function goes | ||
| through the input once to determine the input schema. | ||
|
|
@@ -634,7 +634,9 @@ def saveAsTable(self, name, format=None, mode=None, partitionBy=None, **options) | |
|
|
||
| @since(1.4) | ||
| def json(self, path, mode=None, compression=None, dateFormat=None, timestampFormat=None): | ||
| """Saves the content of the :class:`DataFrame` in JSON format at the specified path. | ||
| """Saves the content of the :class:`DataFrame` in JSON format | ||
| (`JSON Lines text format or newline-delimited JSON <http://jsonlines.org/>`_) at the | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| specified path. | ||
|
|
||
| :param path: the path in any Hadoop supported file system | ||
| :param mode: specifies the behavior of the save operation when data already exists. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -405,8 +405,8 @@ def json(self, path, schema=None, primitivesAsString=None, prefersDecimal=None, | |
| """ | ||
| Loads a JSON file stream and returns the results as a :class:`DataFrame`. | ||
|
|
||
| `JSON Lines <http://jsonlines.org/>`_(newline-delimited JSON) is supported by default. | ||
| For JSON (one record per file), set the `wholeFile` parameter to ``true``. | ||
| `JSON Lines <http://jsonlines.org/>`_ (newline-delimited JSON) is supported by default. | ||
| For JSON (one record per file), set the ``wholeFile`` parameter to ``true``. | ||
|
||
|
|
||
| If the ``schema`` parameter is not specified, this function goes | ||
| through the input once to determine the input schema. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -268,8 +268,8 @@ class DataFrameReader private[sql](sparkSession: SparkSession) extends Logging { | |
| } | ||
|
|
||
| /** | ||
| * Loads a JSON file (<a href="http://jsonlines.org/">JSON Lines text format or | ||
| * newline-delimited JSON</a>) and returns the result as a `DataFrame`. | ||
| * Loads a JSON file and returns the results as a `DataFrame`. | ||
| * | ||
|
||
| * See the documentation on the overloaded `json()` method with varargs for more details. | ||
| * | ||
| * @since 1.4.0 | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.







There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before
After