Skip to content

[MINOR][SQL][DOCS] Update schema_of_csv and schema_of_json doc #30396

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.

Sign up for GitHub

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
viirya wants to merge 2 commits into from
Closed

[MINOR][SQL][DOCS] Update schema_of_csv and schema_of_json doc #30396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29a3e0b
Update schema_of_csv and schema_of_json doc.
viirya Nov 17, 2020
1224ba9
Update python api doc.
viirya Nov 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions python/pyspark/sql/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3527,7 +3527,7 @@ def schema_of_json(json, options={}):
Parameters
----------
json : :class:`Column` or str
a JSON string or a string literal containing a JSON string.
a JSON string or a foldable string column containing a JSON string.
options : dict, optional
options to control parsing. accepts the same options as the JSON datasource

Expand Down Expand Up @@ -3564,7 +3564,7 @@ def schema_of_csv(csv, options={}):
Parameters
----------
csv : :class:`Column` or str
a CSV string or a string literal containing a CSV string.
a CSV string or a foldable string column containing a CSV string.
options : dict, optional
options to control parsing. accepts the same options as the CSV datasource

Expand Down
8 changes: 4 additions & 4 deletions sql/core/src/main/scala/org/apache/spark/sql/functions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4151,7 +4151,7 @@ object functions {
/**
* Parses a JSON string and infers its schema in DDL format.
*
* @param json a string literal containing a JSON string.
* @param json a foldable string column containing a JSON string.
*
* @group collection_funcs
* @since 2.4.0
Expand All @@ -4161,7 +4161,7 @@ object functions {
/**
* Parses a JSON string and infers its schema in DDL format using options.
*
* @param json a string column containing JSON data.
* @param json a foldable string column containing JSON data.
* @param options options to control how the json is parsed. accepts the same options and the
* json data source. See [[DataFrameReader#json]].
* @return a column with string literal containing schema in DDL format.
Expand Down Expand Up @@ -4426,7 +4426,7 @@ object functions {
/**
* Parses a CSV string and infers its schema in DDL format.
*
* @param csv a string literal containing a CSV string.
* @param csv a foldable string column containing a CSV string.
*
* @group collection_funcs
* @since 3.0.0
Expand All @@ -4436,7 +4436,7 @@ object functions {
/**
* Parses a CSV string and infers its schema in DDL format using options.
*
* @param csv a string literal containing a CSV string.
* @param csv a foldable string column containing a CSV string.
* @param options options to control how the CSV is parsed. accepts the same options and the
* json data source. See [[DataFrameReader#csv]].
* @return a column with string literal containing schema in DDL format.
Expand Down