Skip to content

JSON

Bases: ReadOnlyFileFormat

JSON file format. |support_hooks|

Based on Spark JSON <https://spark.apache.org/docs/latest/sql-data-sources-json.html>_ file format.

Supports reading (but NOT writing) files with .json extension with content like:

.. code-block:: json :caption: example.json

[
    {"key": "value1"},
    {"key": "value2"}
]

.. versionadded:: 0.9.0

Examples

.. note ::

You can pass any option mentioned in
`official documentation <https://spark.apache.org/docs/latest/sql-data-sources-json.html>`_.
**Option names should be in** ``camelCase``!

The set of supported options depends on Spark version.

Reading files:

.. code:: python

from onetl.file.format import JSON

json = JSON(encoding="UTF-8")

Writing files:

.. warning::

Not supported. Use :obj:`JSONLine <onetl.file.format.jsonline.JSONLine>`.
Source code in onetl/file/format/json.py 
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
@support_hooks
class JSON(ReadOnlyFileFormat):
    """
    JSON file format. |support_hooks|

    Based on `Spark JSON <https://spark.apache.org/docs/latest/sql-data-sources-json.html>`_ file format.

    Supports reading (but **NOT** writing) files with ``.json`` extension with content like:

    .. code-block:: json
        :caption: example.json

        [
            {"key": "value1"},
            {"key": "value2"}
        ]

    .. versionadded:: 0.9.0

    Examples
    --------

    .. note ::

        You can pass any option mentioned in
        `official documentation <https://spark.apache.org/docs/latest/sql-data-sources-json.html>`_.
        **Option names should be in** ``camelCase``!

        The set of supported options depends on Spark version.

    Reading files:

    .. code:: python

        from onetl.file.format import JSON

        json = JSON(encoding="UTF-8")

    Writing files:

    .. warning::

        Not supported. Use :obj:`JSONLine <onetl.file.format.jsonline.JSONLine>`.

    """

    name: ClassVar[str] = "json"

    multiLine: Literal[True] = True

    encoding: Optional[str] = None
    """
    Encoding of the JSON file.
    Default ``UTF-8``.

    .. note::

        Used only for reading and writing files.

        Ignored by :obj:`~parse_column` and :obj:`~serialize_column` methods.
    """

    lineSep: Optional[str] = None
    """
    Character used to separate lines in the JSON file.

    Defaults:
      * Try to detect for reading (``\\r\\n``, ``\\r``, ``\\n``)
      * ``\\n`` for writing

    .. note::

        Used only for reading and writing files.

        Ignored by :obj:`~parse_column` and :obj:`~serialize_column` methods,
        as they handle each DataFrame row separately.
    """

    allowComments: Optional[bool] = None
    """
    If ``True``, add support for C/C++/Java style comments (``//``, ``/* */``).
    Default ``False``, meaning that JSON files should not contain comments.

    .. note::

        Used only for reading files and :obj:`~parse_column` method.
    """

    allowUnquotedFieldNames: Optional[bool] = None
    """
    If ``True``, allow JSON object field names without quotes (JavaScript-style).
    Default ``False``.

    .. note::

        Used only for reading files and :obj:`~parse_column` method.
    """

    allowSingleQuotes: Optional[bool] = None
    """
    If ``True``, allow JSON object field names to be wrapped with single quotes (``'``).
    Default ``True``.

    .. note::

        Used only for reading files and :obj:`~parse_column` method.
    """

    allowNumericLeadingZeros: Optional[bool] = None
    """
    If ``True``, allow leading zeros in numbers (e.g. ``00012``).
    Default ``False``.

    .. note::

        Used only for reading files and :obj:`~parse_column` method.
    """

    allowNonNumericNumbers: Optional[bool] = None
    """
    If ``True``, allow numbers to contain non-numeric characters, like:
      * scientific notation (e.g. ``12e10``).
      * positive infinity floating point value (``Infinity``, ``+Infinity``, ``+INF``).
      * negative infinity floating point value (``-Infinity``, ``-INF``).
      * Not-a-Number floating point value (``NaN``).

    Default ``True``.

    .. note::

        Used only for reading files and :obj:`~parse_column` method.
    """

    allowBackslashEscapingAnyCharacter: Optional[bool] = None
    """
    If ``True``, prefix ``\\`` can escape any character.
    Default ``False``.

    .. note::

        Used only for reading files and :obj:`~parse_column` method.
    """

    allowUnquotedControlChars: Optional[bool] = None
    """
    If ``True``, allow unquoted control characters (ASCII values 0-31) in strings without escaping them with ``\\``.
    Default ``False``.

    .. note::

        Used only for reading files and :obj:`~parse_column` method.
    """

    mode: Optional[Literal["PERMISSIVE", "DROPMALFORMED", "FAILFAST"]] = None
    """
    How to handle parsing errors:
      * ``PERMISSIVE`` - set field value as ``null``, move raw data to :obj:`~columnNameOfCorruptRecord` column.
      * ``DROPMALFORMED`` - skip the malformed row.
      * ``FAILFAST`` - throw an error immediately.

    Default is ``PERMISSIVE``.

    .. note::

        Used only for reading files and :obj:`~parse_column` method.
    """

    columnNameOfCorruptRecord: Optional[str] = Field(default=None, min_length=1)
    """
    Name of column to put corrupt records in.
    Default is ``_corrupt_record``.

    .. warning::

        If DataFrame schema is provided, this column should be added to schema explicitly:

        .. code:: python

            from onetl.connection import SparkLocalFS
            from onetl.file import FileDFReader
            from onetl.file.format import JSON

            from pyspark.sql.types import StructType, StructField, TimestampType, StringType

            spark = ...

            schema = StructType(
                [
                    StructField("my_field", TimestampType()),
                    StructField("_corrupt_record", StringType()),  # <-- important
                ]
            )

            json = JSON(mode="PERMISSIVE", columnNameOfCorruptRecord="_corrupt_record")

            reader = FileDFReader(
                connection=connection,
                format=json,
                df_schema=schema,  # < ---
            )
            df = reader.run(["/some/file.json"])

    .. note::

        Used only for reading files and :obj:`~parse_column` method.
    """

    samplingRatio: Optional[float] = Field(default=None, ge=0, le=1)
    """
    While inferring schema, read the specified fraction of file rows.
    Default ``1``.

    .. note::

        Used only for reading files. Ignored by :obj:`~parse_column` function.
    """

    primitivesAsString: Optional[bool] = None
    """
    If ``True``, infer all primitive types (string, integer, float, boolean) as strings.
    Default ``False``.

    .. note::

        Used only for reading files. Ignored by :obj:`~parse_column` method.
    """

    prefersDecimal: Optional[bool] = None
    """
    If ``True``, infer all floating-point values as ``Decimal``.
    Default ``False``.

    .. note::

        Used only for reading files. Ignored by :obj:`~parse_column` method.
    """

    dropFieldIfAllNull: Optional[bool] = None
    """
    If ``True`` and inferred column is always null or empty array, exclude if from DataFrame schema.
    Default ``False``.

    .. note::

        Used only for reading files. Ignored by :obj:`~parse_column` method.
    """

    dateFormat: Optional[str] = Field(default=None, min_length=1)
    """
    String format for ``DateType()`` representation.
    Default is ``yyyy-MM-dd``.
    """

    timestampFormat: Optional[str] = Field(default=None, min_length=1)
    """
    String format for `TimestampType()`` representation.
    Default is ``yyyy-MM-dd'T'HH:mm:ss[.SSS][XXX]``.
    """

    timestampNTZFormat: Optional[str] = Field(default=None, min_length=1)
    """
    String format for `TimestampNTZType()`` representation.
    Default is ``yyyy-MM-dd'T'HH:mm:ss[.SSS]``.

    .. note::

        Added in Spark 3.2.0
    """

    timezone: Optional[str] = Field(default=None, min_length=1, alias="timeZone")
    """
    Allows to override timezone used for parsing or serializing date and timestamp values.
    By default, ``spark.sql.session.timeZone`` is used.
    """

    locale: Optional[str] = Field(default=None, min_length=1)
    """
    Locale name used to parse dates and timestamps.
    Default is ``en-US``.

    ..  note::

        Used only for reading files and :obj:`~parse_column` method.
    """

    class Config:
        known_options = frozenset()
        extra = "allow"

    @slot
    def check_if_supported(self, spark: SparkSession) -> None:
        # always available
        pass

    def parse_column(self, column: str | Column, schema: StructType | ArrayType | MapType) -> Column:
        """
        Parses a JSON string column to a structured Spark SQL column using Spark's `from_json <https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.from_json.html>`_ function, based on the provided schema.

        .. versionadded:: 0.11.0

        Parameters
        ----------
        column : str | Column
            The name of the column or the column object containing JSON strings/bytes to parse.

        schema : StructType | ArrayType | MapType
            The schema to apply when parsing the JSON data. This defines the structure of the output DataFrame column.

        Returns
        -------
        Column with deserialized data, with the same structure as the provided schema. Column name is the same as input column.

        Examples
        --------

        >>> from pyspark.sql.types import StructType, StructField, IntegerType, StringType
        >>> from pyspark.sql.functions import decode
        >>> from onetl.file.format import JSON
        >>> df.show()
        +----+--------------------+----------+---------+------+-----------------------+-------------+
        |key |value               |topic     |partition|offset|timestamp              |timestampType|
        +----+--------------------+----------+---------+------+-----------------------+-------------+
        |[31]|[7B 22 6E 61 6D 6...|topicJSON |0        |0     |2024-04-24 16:51:11.739|0            |
        |[32]|[7B 22 6E 61 6D 6...|topicJSON |0        |1     |2024-04-24 16:51:11.749|0            |
        +----+--------------------+----------+---------+------+-----------------------+-------------+
        >>> df.printSchema()
        root
        |-- key: binary (nullable = true)
        |-- value: binary (nullable = true)
        |-- topic: string (nullable = true)
        |-- partition: integer (nullable = true)
        |-- offset: integer (nullable = true)
        |-- timestamp: timestamp (nullable = true)
        |-- timestampType: integer (nullable = true)
        >>> json = JSON()
        >>> json_schema = StructType(
        ...     [
        ...         StructField("name", StringType(), nullable=True),
        ...         StructField("age", IntegerType(), nullable=True),
        ...     ],
        ... )
        >>> parsed_df = df.select(decode("key", "UTF-8").alias("key"), json.parse_column("value", json_schema))
        >>> parsed_df.show()
        +---+-----------+
        |key|value      |
        +---+-----------+
        |1  |{Alice, 20}|
        |2  |  {Bob, 25}|
        +---+-----------+
        >>> parsed_df.printSchema()
        root
        |-- key: string (nullable = true)
        |-- value: struct (nullable = true)
        |    |-- name: string (nullable = true)
        |    |-- age: integer (nullable = true)
        """
        from pyspark.sql import Column, SparkSession  # noqa:  WPS442
        from pyspark.sql.functions import col, from_json

        self.check_if_supported(SparkSession._instantiatedSession)  # noqa:  WPS437
        self._check_unsupported_serialization_options()

        if isinstance(column, Column):
            column_name, column = column._jc.toString(), column.cast("string")  # noqa:  WPS437
        else:
            column_name, column = column, col(column).cast("string")

        options = stringify(self.dict(by_alias=True, exclude_none=True))
        return from_json(column, schema, options).alias(column_name)

    def serialize_column(self, column: str | Column) -> Column:
        """
        Serializes a structured Spark SQL column into a JSON string column using Spark's
        `to_json <https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.to_json.html>`_ function.

        .. versionadded:: 0.11.0

        Parameters
        ----------
        column : str | Column
            The name of the column or the column object containing the data to serialize to JSON format.

        Returns
        -------
        Column with string JSON data. Column name is the same as input column.

        Examples
        --------

        >>> from pyspark.sql.functions import decode
        >>> from onetl.file.format import JSON
        >>> df.show()
        +---+-----------+
        |key|value      |
        +---+-----------+
        |1  |{Alice, 20}|
        |2  |  {Bob, 25}|
        +---+-----------+
        >>> df.printSchema()
        root
        |-- key: string (nullable = true)
        |-- value: struct (nullable = true)
        |    |-- name: string (nullable = true)
        |    |-- age: integer (nullable = true)
        >>> # serializing data into JSON format
        >>> json = JSON()
        >>> serialized_df = df.select("key", json.serialize_column("value"))
        >>> serialized_df.show(truncate=False)
        +---+-------------------------+
        |key|value                    |
        +---+-------------------------+
        |  1|{"name":"Alice","age":20}|
        |  2|{"name":"Bob","age":25}  |
        +---+-------------------------+
        >>> serialized_df.printSchema()
        root
        |-- key: string (nullable = true)
        |-- value: string (nullable = true)
        """
        from pyspark.sql import Column, SparkSession  # noqa:  WPS442
        from pyspark.sql.functions import col, to_json

        self.check_if_supported(SparkSession._instantiatedSession)  # noqa:  WPS437
        self._check_unsupported_serialization_options()

        if isinstance(column, Column):
            column_name = column._jc.toString()  # noqa:  WPS437
        else:
            column_name, column = column, col(column)

        options = stringify(self.dict(by_alias=True, exclude_none=True))
        return to_json(column, options).alias(column_name)

    def _check_unsupported_serialization_options(self):
        current_options = self.dict(by_alias=True, exclude_none=True)
        unsupported_options = current_options.keys() & PARSE_COLUMN_UNSUPPORTED_OPTIONS
        if unsupported_options:
            warnings.warn(
                f"Options `{sorted(unsupported_options)}` are set but not supported "
                f"in `JSON.parse_column` or `JSON.serialize_column`.",
                UserWarning,
                stacklevel=2,
            )

    def __repr__(self):
        options_dict = self.dict(by_alias=True, exclude_none=True, exclude={"multiLine"})
        options_dict = dict(sorted(options_dict.items()))
        options_kwargs = ", ".join(f"{k}={v!r}" for k, v in options_dict.items())
        return f"{self.__class__.__name__}({options_kwargs})"

allowBackslashEscapingAnyCharacter = None class-attribute instance-attribute

If True, prefix \ can escape any character. Default False.

.. note::

Used only for reading files and :obj:`~parse_column` method.

allowComments = None class-attribute instance-attribute

If True, add support for C/C++/Java style comments (//, /* */). Default False, meaning that JSON files should not contain comments.

.. note::

Used only for reading files and :obj:`~parse_column` method.

allowNonNumericNumbers = None class-attribute instance-attribute

If True, allow numbers to contain non-numeric characters, like: * scientific notation (e.g. 12e10). * positive infinity floating point value (Infinity, +Infinity, +INF). * negative infinity floating point value (-Infinity, -INF). * Not-a-Number floating point value (NaN).

Default True.

.. note::

Used only for reading files and :obj:`~parse_column` method.

allowNumericLeadingZeros = None class-attribute instance-attribute

If True, allow leading zeros in numbers (e.g. 00012). Default False.

.. note::

Used only for reading files and :obj:`~parse_column` method.

allowSingleQuotes = None class-attribute instance-attribute

If True, allow JSON object field names to be wrapped with single quotes ('). Default True.

.. note::

Used only for reading files and :obj:`~parse_column` method.

allowUnquotedControlChars = None class-attribute instance-attribute

If True, allow unquoted control characters (ASCII values 0-31) in strings without escaping them with \. Default False.

.. note::

Used only for reading files and :obj:`~parse_column` method.

allowUnquotedFieldNames = None class-attribute instance-attribute

If True, allow JSON object field names without quotes (JavaScript-style). Default False.

.. note::

Used only for reading files and :obj:`~parse_column` method.

columnNameOfCorruptRecord = Field(default=None, min_length=1) class-attribute instance-attribute

Name of column to put corrupt records in. Default is _corrupt_record.

.. warning::

If DataFrame schema is provided, this column should be added to schema explicitly:

.. code:: python

    from onetl.connection import SparkLocalFS
    from onetl.file import FileDFReader
    from onetl.file.format import JSON

    from pyspark.sql.types import StructType, StructField, TimestampType, StringType

    spark = ...

    schema = StructType(
        [
            StructField("my_field", TimestampType()),
            StructField("_corrupt_record", StringType()),  # <-- important
        ]
    )

    json = JSON(mode="PERMISSIVE", columnNameOfCorruptRecord="_corrupt_record")

    reader = FileDFReader(
        connection=connection,
        format=json,
        df_schema=schema,  # < ---
    )
    df = reader.run(["/some/file.json"])

.. note::

Used only for reading files and :obj:`~parse_column` method.

dateFormat = Field(default=None, min_length=1) class-attribute instance-attribute

String format for DateType() representation. Default is yyyy-MM-dd.

dropFieldIfAllNull = None class-attribute instance-attribute

If True and inferred column is always null or empty array, exclude if from DataFrame schema. Default False.

.. note::

Used only for reading files. Ignored by :obj:`~parse_column` method.

encoding = None class-attribute instance-attribute

Encoding of the JSON file. Default UTF-8.

.. note::

Used only for reading and writing files.

Ignored by :obj:`~parse_column` and :obj:`~serialize_column` methods.

lineSep = None class-attribute instance-attribute

Character used to separate lines in the JSON file.

Defaults
  • Try to detect for reading (\r\n, \r, \n)
  • \n for writing

.. note::

Used only for reading and writing files.

Ignored by :obj:`~parse_column` and :obj:`~serialize_column` methods,
as they handle each DataFrame row separately.

locale = Field(default=None, min_length=1) class-attribute instance-attribute

Locale name used to parse dates and timestamps. Default is en-US.

.. note::

Used only for reading files and :obj:`~parse_column` method.

mode = None class-attribute instance-attribute

How to handle parsing errors
  • PERMISSIVE - set field value as null, move raw data to :obj:~columnNameOfCorruptRecord column.
  • DROPMALFORMED - skip the malformed row.
  • FAILFAST - throw an error immediately.

Default is PERMISSIVE.

.. note::

Used only for reading files and :obj:`~parse_column` method.

prefersDecimal = None class-attribute instance-attribute

If True, infer all floating-point values as Decimal. Default False.

.. note::

Used only for reading files. Ignored by :obj:`~parse_column` method.

primitivesAsString = None class-attribute instance-attribute

If True, infer all primitive types (string, integer, float, boolean) as strings. Default False.

.. note::

Used only for reading files. Ignored by :obj:`~parse_column` method.

samplingRatio = Field(default=None, ge=0, le=1) class-attribute instance-attribute

While inferring schema, read the specified fraction of file rows. Default 1.

.. note::

Used only for reading files. Ignored by :obj:`~parse_column` function.

timestampFormat = Field(default=None, min_length=1) class-attribute instance-attribute

String format for `TimestampType()representation. Default isyyyy-MM-dd'T'HH🇲🇲ss[.SSS][XXX]``.

timestampNTZFormat = Field(default=None, min_length=1) class-attribute instance-attribute

String format for `TimestampNTZType()representation. Default isyyyy-MM-dd'T'HH🇲🇲ss[.SSS]``.

.. note::

Added in Spark 3.2.0

timezone = Field(default=None, min_length=1, alias='timeZone') class-attribute instance-attribute

Allows to override timezone used for parsing or serializing date and timestamp values. By default, spark.sql.session.timeZone is used.

parse_column(column, schema)

Parses a JSON string column to a structured Spark SQL column using Spark's from_json <https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.from_json.html>_ function, based on the provided schema.

.. versionadded:: 0.11.0

Parameters

column : str | Column The name of the column or the column object containing JSON strings/bytes to parse.

StructType | ArrayType | MapType

The schema to apply when parsing the JSON data. This defines the structure of the output DataFrame column.

Returns

Column with deserialized data, with the same structure as the provided schema. Column name is the same as input column.

Examples

from pyspark.sql.types import StructType, StructField, IntegerType, StringType from pyspark.sql.functions import decode from onetl.file.format import JSON df.show() +----+--------------------+----------+---------+------+-----------------------+-------------+ |key |value |topic |partition|offset|timestamp |timestampType| +----+--------------------+----------+---------+------+-----------------------+-------------+ |[31]|[7B 22 6E 61 6D 6...|topicJSON |0 |0 |2024-04-24 16:51:11.739|0 | |[32]|[7B 22 6E 61 6D 6...|topicJSON |0 |1 |2024-04-24 16:51:11.749|0 | +----+--------------------+----------+---------+------+-----------------------+-------------+ df.printSchema() root |-- key: binary (nullable = true) |-- value: binary (nullable = true) |-- topic: string (nullable = true) |-- partition: integer (nullable = true) |-- offset: integer (nullable = true) |-- timestamp: timestamp (nullable = true) |-- timestampType: integer (nullable = true) json = JSON() json_schema = StructType( ... [ ... StructField("name", StringType(), nullable=True), ... StructField("age", IntegerType(), nullable=True), ... ], ... ) parsed_df = df.select(decode("key", "UTF-8").alias("key"), json.parse_column("value", json_schema)) parsed_df.show() +---+-----------+ |key|value | +---+-----------+ |1 |{Alice, 20}| |2 | {Bob, 25}| +---+-----------+ parsed_df.printSchema() root |-- key: string (nullable = true) |-- value: struct (nullable = true) | |-- name: string (nullable = true) | |-- age: integer (nullable = true)

Source code in onetl/file/format/json.py 
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
def parse_column(self, column: str | Column, schema: StructType | ArrayType | MapType) -> Column:
    """
    Parses a JSON string column to a structured Spark SQL column using Spark's `from_json <https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.from_json.html>`_ function, based on the provided schema.

    .. versionadded:: 0.11.0

    Parameters
    ----------
    column : str | Column
        The name of the column or the column object containing JSON strings/bytes to parse.

    schema : StructType | ArrayType | MapType
        The schema to apply when parsing the JSON data. This defines the structure of the output DataFrame column.

    Returns
    -------
    Column with deserialized data, with the same structure as the provided schema. Column name is the same as input column.

    Examples
    --------

    >>> from pyspark.sql.types import StructType, StructField, IntegerType, StringType
    >>> from pyspark.sql.functions import decode
    >>> from onetl.file.format import JSON
    >>> df.show()
    +----+--------------------+----------+---------+------+-----------------------+-------------+
    |key |value               |topic     |partition|offset|timestamp              |timestampType|
    +----+--------------------+----------+---------+------+-----------------------+-------------+
    |[31]|[7B 22 6E 61 6D 6...|topicJSON |0        |0     |2024-04-24 16:51:11.739|0            |
    |[32]|[7B 22 6E 61 6D 6...|topicJSON |0        |1     |2024-04-24 16:51:11.749|0            |
    +----+--------------------+----------+---------+------+-----------------------+-------------+
    >>> df.printSchema()
    root
    |-- key: binary (nullable = true)
    |-- value: binary (nullable = true)
    |-- topic: string (nullable = true)
    |-- partition: integer (nullable = true)
    |-- offset: integer (nullable = true)
    |-- timestamp: timestamp (nullable = true)
    |-- timestampType: integer (nullable = true)
    >>> json = JSON()
    >>> json_schema = StructType(
    ...     [
    ...         StructField("name", StringType(), nullable=True),
    ...         StructField("age", IntegerType(), nullable=True),
    ...     ],
    ... )
    >>> parsed_df = df.select(decode("key", "UTF-8").alias("key"), json.parse_column("value", json_schema))
    >>> parsed_df.show()
    +---+-----------+
    |key|value      |
    +---+-----------+
    |1  |{Alice, 20}|
    |2  |  {Bob, 25}|
    +---+-----------+
    >>> parsed_df.printSchema()
    root
    |-- key: string (nullable = true)
    |-- value: struct (nullable = true)
    |    |-- name: string (nullable = true)
    |    |-- age: integer (nullable = true)
    """
    from pyspark.sql import Column, SparkSession  # noqa:  WPS442
    from pyspark.sql.functions import col, from_json

    self.check_if_supported(SparkSession._instantiatedSession)  # noqa:  WPS437
    self._check_unsupported_serialization_options()

    if isinstance(column, Column):
        column_name, column = column._jc.toString(), column.cast("string")  # noqa:  WPS437
    else:
        column_name, column = column, col(column).cast("string")

    options = stringify(self.dict(by_alias=True, exclude_none=True))
    return from_json(column, schema, options).alias(column_name)

serialize_column(column)

Serializes a structured Spark SQL column into a JSON string column using Spark's to_json <https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.to_json.html>_ function.

.. versionadded:: 0.11.0

Parameters

column : str | Column The name of the column or the column object containing the data to serialize to JSON format.

Returns

Column with string JSON data. Column name is the same as input column.

Examples

from pyspark.sql.functions import decode from onetl.file.format import JSON df.show() +---+-----------+ |key|value | +---+-----------+ |1 |{Alice, 20}| |2 | {Bob, 25}| +---+-----------+ df.printSchema() root |-- key: string (nullable = true) |-- value: struct (nullable = true) | |-- name: string (nullable = true) | |-- age: integer (nullable = true)

serializing data into JSON format

json = JSON() serialized_df = df.select("key", json.serialize_column("value")) serialized_df.show(truncate=False) +---+-------------------------+ |key|value | +---+-------------------------+ | 1|{"name":"Alice","age":20}| | 2|{"name":"Bob","age":25} | +---+-------------------------+ serialized_df.printSchema() root |-- key: string (nullable = true) |-- value: string (nullable = true)

Source code in onetl/file/format/json.py 
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
def serialize_column(self, column: str | Column) -> Column:
    """
    Serializes a structured Spark SQL column into a JSON string column using Spark's
    `to_json <https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.to_json.html>`_ function.

    .. versionadded:: 0.11.0

    Parameters
    ----------
    column : str | Column
        The name of the column or the column object containing the data to serialize to JSON format.

    Returns
    -------
    Column with string JSON data. Column name is the same as input column.

    Examples
    --------

    >>> from pyspark.sql.functions import decode
    >>> from onetl.file.format import JSON
    >>> df.show()
    +---+-----------+
    |key|value      |
    +---+-----------+
    |1  |{Alice, 20}|
    |2  |  {Bob, 25}|
    +---+-----------+
    >>> df.printSchema()
    root
    |-- key: string (nullable = true)
    |-- value: struct (nullable = true)
    |    |-- name: string (nullable = true)
    |    |-- age: integer (nullable = true)
    >>> # serializing data into JSON format
    >>> json = JSON()
    >>> serialized_df = df.select("key", json.serialize_column("value"))
    >>> serialized_df.show(truncate=False)
    +---+-------------------------+
    |key|value                    |
    +---+-------------------------+
    |  1|{"name":"Alice","age":20}|
    |  2|{"name":"Bob","age":25}  |
    +---+-------------------------+
    >>> serialized_df.printSchema()
    root
    |-- key: string (nullable = true)
    |-- value: string (nullable = true)
    """
    from pyspark.sql import Column, SparkSession  # noqa:  WPS442
    from pyspark.sql.functions import col, to_json

    self.check_if_supported(SparkSession._instantiatedSession)  # noqa:  WPS437
    self._check_unsupported_serialization_options()

    if isinstance(column, Column):
        column_name = column._jc.toString()  # noqa:  WPS437
    else:
        column_name, column = column, col(column)

    options = stringify(self.dict(by_alias=True, exclude_none=True))
    return to_json(column, options).alias(column_name)