dask_awkward.to_json

dask_awkward.to_json

dask_awkward.to_json(array: Array, path: str, line_delimited: bool | str = True, num_indent_spaces: int | None = None, num_readability_spaces: int = 0, nan_string: str | None = None, posinf_string: str | None = None, neginf_string: str | None = None, complex_record_fields: tuple[str, str] | None = None, convert_bytes: collections.abc.Callable | None = None, convert_other: collections.abc.Callable | None = None, storage_options: dict[str, Any] | None = None, compression: str | None = None, compute: Literal[False] = False) Scalar[source]
dask_awkward.to_json(array: Array, path: str, line_delimited: bool | str, num_indent_spaces: int | None, num_readability_spaces: int, nan_string: str | None, posinf_string: str | None, neginf_string: str | None, complex_record_fields: tuple[str, str] | None, convert_bytes: collections.abc.Callable | None, convert_other: collections.abc.Callable | None, storage_options: dict[str, Any] | None, compression: str | None, compute: Literal[True]) None

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 | str) – 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!")