itholic commented on a change in pull request #32204:
URL: https://github.com/apache/spark/pull/32204#discussion_r630662846
##########
File path: python/pyspark/sql/readwriter.py
##########
@@ -233,114 +233,13 @@ def json(self, path, schema=None,
primitivesAsString=None, prefersDecimal=None,
path : str, list or :class:`RDD`
string represents path to the JSON dataset, or a list of paths,
or RDD of Strings storing JSON objects.
- schema : :class:`pyspark.sql.types.StructType` or str, optional
- an optional :class:`pyspark.sql.types.StructType` for the input
schema or
- a DDL-formatted string (For example ``col0 INT, col1 DOUBLE``).
- primitivesAsString : str or bool, optional
- infers all primitive values as a string type. If None is set,
- it uses the default value, ``false``.
- prefersDecimal : str or bool, optional
- infers all floating-point values as a decimal type. If the values
- do not fit in decimal, then it infers them as doubles. If None is
- set, it uses the default value, ``false``.
- allowComments : str or bool, optional
- ignores Java/C++ style comment in JSON records. If None is set,
- it uses the default value, ``false``.
- allowUnquotedFieldNames : str or bool, optional
- allows unquoted JSON field names. If None is set,
- it uses the default value, ``false``.
- allowSingleQuotes : str or bool, optional
- allows single quotes in addition to double quotes. If None is
- set, it uses the default value, ``true``.
- allowNumericLeadingZero : str or bool, optional
- allows leading zeros in numbers (e.g. 00012). If None is
- set, it uses the default value, ``false``.
- allowBackslashEscapingAnyCharacter : str or bool, optional
- allows accepting quoting of all character
- using backslash quoting mechanism. If None is
- set, it uses the default value, ``false``.
- mode : str, optional
- allows a mode for dealing with corrupt records during parsing. If
None is
- set, it uses the default value, ``PERMISSIVE``.
-
- * ``PERMISSIVE``: when it meets a corrupted record, puts the
malformed string \
- into a field configured by ``columnNameOfCorruptRecord``, and
sets malformed \
- fields to ``null``. To keep corrupt records, an user can set a
string type \
- field named ``columnNameOfCorruptRecord`` in an user-defined
schema. If a \
- schema does not have the field, it drops corrupt records during
parsing. \
- When inferring a schema, it implicitly adds a
``columnNameOfCorruptRecord`` \
- field in an output schema.
- * ``DROPMALFORMED``: ignores the whole corrupted records.
- * ``FAILFAST``: throws an exception when it meets corrupted
records.
- columnNameOfCorruptRecord: str, optional
- allows renaming the new field having malformed string
- created by ``PERMISSIVE`` mode. This overrides
- ``spark.sql.columnNameOfCorruptRecord``. If None is set,
- it uses the value specified in
- ``spark.sql.columnNameOfCorruptRecord``.
- dateFormat : str, optional
- sets the string that indicates a date format. Custom date formats
- follow the formats at
- `datetime pattern
<https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html>`_. # noqa
- This applies to date type. If None is set, it uses the
- default value, ``yyyy-MM-dd``.
- timestampFormat : str, optional
- sets the string that indicates a timestamp format.
- Custom date formats follow the formats at
- `datetime pattern
<https://spark.apache.org/docs/latest/sql-ref-datetime-pattern.html>`_. # noqa
- This applies to timestamp type. If None is set, it uses the
- default value, ``yyyy-MM-dd'T'HH:mm:ss[.SSS][XXX]``.
- multiLine : str or bool, optional
- parse one record, which may span multiple lines, per file. If None
is
- set, it uses the default value, ``false``.
- allowUnquotedControlChars : str or bool, optional
- allows JSON Strings to contain unquoted control
- characters (ASCII characters with value less than 32,
- including tab and line feed characters) or not.
- encoding : str or bool, optional
- allows to forcibly set one of standard basic or extended encoding
for
- the JSON files. For example UTF-16BE, UTF-32LE. If None is set,
- the encoding of input JSON will be detected automatically
- when the multiLine option is set to ``true``.
- lineSep : str, optional
- defines the line separator that should be used for parsing. If
None is
- set, it covers all ``\\r``, ``\\r\\n`` and ``\\n``.
- samplingRatio : str or float, optional
- defines fraction of input JSON objects used for schema inferring.
- If None is set, it uses the default value, ``1.0``.
- dropFieldIfAllNull : str or bool, optional
- whether to ignore column of all null values or empty
- array/struct during schema inference. If None is set, it
- uses the default value, ``false``.
- locale : str, optional
- sets a locale as language tag in IETF BCP 47 format. If None is
set,
- it uses the default value, ``en-US``. For instance, ``locale`` is
used while
- parsing dates and timestamps.
- pathGlobFilter : str or bool, optional
Review comment:
Thanks for the comment, @HyukjinKwon
It's documented in [Generic File Source
Options](https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-global-filter),
so removed it from the docstring.
Then, should we add the link to Generic File Source Options, too? or just
keep it here??
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
