Ctrl+K

dask_awkward.to_json

Contents

dask_awkward.to_json#

dask_awkward.to_json(array, path, line_delimited=True, num_indent_spaces=None, num_readability_spaces=0, nan_string=None, posinf_string=None, neginf_string=None, complex_record_fields=None, convert_bytes=None, convert_other=None, storage_options=None, compression=None, compute=True)[source]#

Store Array collection in JSON text.

Parameters:

  • array (Array) – Collection to store in JSON format

  • path (str) – Root directory to save data; interpreted by filesystem-spec (can be a remote filesystem path, for example an s3 bucket: "s3://bucket/data").

  • line_delimited (bool) – See docstring for ak.to_json().

  • num_indent_spaces (int, optional) – See docstring for ak.to_json().

  • num_readability_spaces (int) – See docstring for ak.to_json().

  • nan_string (str, optional) – See docstring for ak.to_json().

  • posinf_string (str, optional) – See docstring for ak.to_json().

  • neginf_string (str, optional) – See docstring for ak.to_json().

  • complex_record_fields (tuple[str, str], optional) – See docstring for ak.to_json().

  • convert_bytes (Callable, optional) – See docstring for ak.to_json().

  • convert_other (Callable, optional) – See docstring for ak.to_json().

  • storage_options (dict[str, Any], optional) – Options passed to fsspec.

  • compression (str, optional) – Compress JSON data via fsspec

  • compute (bool) – Immediately compute the collection.

Returns:

Computable Scalar object if compute is False, otherwise returns None.

Return type:

Scalar or None

Examples

>>> import dask_awkward as dak
>>> print("Hello, world!")
Contents